ToolbarHelper Class

Helper functions for defining a Toolbar items used in Toolbar, ToolbarComposer and UiItemsProvider.

Methods

Name Description
constructor(): ToolbarHelper    
constructChildToolbarItems(itemDefs: AnyItemDef[]): ToolbarActionItem | ToolbarGroupItem[] Static Construct ToolbarActionItem and ToolbarGroupItem definitions given an array of ItemDefs.  
createCustomDefinitionToolbarItem(itemPriority: number, itemDef: CustomItemDef, overrides?: Partial<CustomButtonDefinition>): ToolbarCustomItem Static Construct ToolbarCustomItem definitions given a CustomItemDef.  
createToolbarItemFromItemDef(itemPriority: number, itemDef: AnyItemDef, overrides?: Partial<CommonToolbarItem>): ToolbarItem Static Helper method to creates a generic toolbar item entry  
createToolbarItemsFromItemDefs(itemDefs: AnyItemDef[], startingItemPriority: number = 10, overrides?: Partial<CommonToolbarItem>): ToolbarItem[] Static Helper method to creates a generic toolbar item entry list.  
getIconReactNode(item: ActionButton | GroupButton): ReactNode Static    

Defined in

Last Updated: 05 April, 2024