API Reference > appui-react > Toolbar

Toolbar

Classes used to construct a Toolbar

Classes

Name Description  
ToolbarHelper Helper functions for defining an ToolbarComposer.  

Constants

Name Description  
ToolbarOrientation Used to specify the orientation of the toolbar. Beta
ToolbarUsage Used to specify the usage of the toolbar which determine the toolbar position. Beta

Global Functions

Name Description  
isToolbarActionItem ToolbarActionItem type guard. Beta
isToolbarCustomItem ToolbarCustomItem type guard. Beta
isToolbarGroupItem ToolbarGroupItem type guard. Beta
ToolbarComposer Toolbar that is populated and maintained by item managers.  
useDefaultToolbarItems Hook that returns items from ToolbarItemsManager.  
useUiItemsProviderToolbarItems Hook that returns items from ToolbarItemsManager.  

Interfaces

Name Description  
ExtensibleToolbarProps Properties for the ToolbarComposer React components  

Namespaces

Name Description  
ToolbarItemUtilities Helper class to create StatusBar Item definitions. Beta

Type Aliases

Name Description  
CommonToolbarItem Describes the data needed to insert a UI items into an existing set of UI items. Beta
ToolbarActionItem Describes the data needed to insert an action button into a toolbar. Beta
ToolbarCustomItem Describes the data needed to insert a custom button into a toolbar. Beta
ToolbarGroupItem Describes the data needed to insert a group button into a toolbar. Beta
ToolbarItem Any Button Type that can be inserted into a toolbar. Beta
ToolbarOrientation Used to specify the orientation of the toolbar. Beta
ToolbarUsage Used to specify the usage of the toolbar which determine the toolbar position. Beta

Last Updated: 30 November, 2023