API Reference › appui-react› Toolbar › ToolbarProps

ToolbarProps Interface

Properties of Toolbar component.

Extends

Properties

Name Type Description
enableOverflow boolean | OverflowToolbarOptions Describes if items that do not fit available space should move to an expandable panel.  
expandsTo Direction | undefined Describes to which direction the popup panels are expanded, also defines the orientation of the toolbar (Top/Bottom will create an horizontal toolbar, Left/Right will create a vertical toolbar).  
items ToolbarItem[] Definitions for items of the toolbar.  
onItemExecuted OnItemExecutedFunc | undefined Optional function to call on any item execution  
onKeyDown (e: React.KeyboardEvent<Element>) => void | undefined Optional function to call on any KeyDown events processed by toolbar  
panelAlignment ToolbarPanelAlignment | undefined Describes how expanded panels are aligned.  
toolbarOpacitySetting ToolbarOpacitySetting | undefined Determines whether to use mouse proximity to alter the opacity of the toolbar  
useDragInteraction boolean | undefined Use drag interaction to open popups with nested toolbar buttons.  

Inherited properties

Name Type Inherited from Description
children undefined | undefined NoChildrenProps  
className string | undefined CommonProps Custom CSS class name
itemId string | undefined CommonProps Optional unique identifier for item.
style React.CSSProperties | undefined CommonProps Custom CSS style properties

Defined in

Last Updated: 20 November, 2024