Extension: omni.kit.example.toolbar_button-0.1.3

Documentation Generated: Nov 13, 2025

Overview#

The Toolbar Button Example extension demonstrates how to integrate custom tool buttons into the Omniverse Kit Toolbar. It is designed to give developers a quick and practical reference on creating and managing simple and grouped toolbar buttons. With this extension enabled, users will see custom buttons added to the toolbar, providing clear guidance on adding and removing UI elements.

Concepts#

  • The extension showcases two main UI components: a simple tool button and a grouped tool button solution.

  • The ExampleSimpleToolButton illustrates the basic custom button creation, while the ExampleToolButtonGroup shows how to combine and style two buttons within one widget group.

Functionality#

  • When the extension starts, it registers custom toolbar buttons that use an icon provided during initialization.

  • The custom buttons are embedded within the Omniverse Kit Toolbar and demonstrate how to encapsulate button logic within a WidgetGroup.

  • The extension also includes lifecycle management through startup and shutdown methods to add and then cleanly remove the buttons from the toolbar.

Integration#

  • This extension depends on the Omniverse UI framework, the toolbar widget, and window toolbar modules to integrate seamlessly with the overall Omniverse Kit Toolbar system.

  • The provided implementation serves as a practical example for those looking to extend the toolbar UI without needing to expose additional public APIs.

Considerations#

  • The extension is self-contained and focuses on toolbar integration, making it ready for immediate use once enabled.

  • It is intended for demonstration purposes and to serve as a starting point for developers exploring custom toolbar button implementations.

  • Any customization mainly revolves around button appearance and grouping logic, as illustrated by the ExampleToolButtonGroup’s styling and cleanup functions.