API Reference > appui-react > Item

Item

Classes for working with an Item in a Tool Widget, Navigation Widget or Backstage

Classes

Name Description  
ActionButtonItemDef Abstract base class that is used by classes to execute an action when pressed.  
ActionItemButton A Toolbar button React Component that executes an action defined by a CommandItemDef or a ToolItemDef. Deprecated
CommandItemDef An Item that executes a Command.  
CustomItemDef An Item that renders a React component.  
GroupItemDef An Item that opens a group of items.  
ItemDefBase The base class for Items.  
ItemList Contains a list of Items.  
ItemMap Contains a map of Items.  
KeyinBrowser Component used to allow users to select, provide arguments, and execute a key-in. Beta
PopupButton Used to provide custom popup button in toolbar. Deprecated
ToolButton Tool Button React Component. Deprecated
ToolInformation Provides information about a tool with a given id, including the ToolUiProvider.  
ToolItemDef An Item that starts the execution of a Tool.  

Constants

Name Description  
StageUsage Standard stage uses. Beta
ToolbarDragInteractionContext Context used to enable toolbar drag interaction. Beta

Global Functions

Name Description  
GroupButton Group Button React component Deprecated

Interfaces

Name Description  
ActionItemButtonProps Properties that must be specified for an ActionItemButton component Deprecated
BaseItemState Base state for any 'stateful' React component  
CommandItemProps Properties for a Command item.  
CustomItemProps Definition for a Custom item that renders a React component.  
GroupButtonProps Properties for the GroupButton React component Deprecated
GroupItemProps Definition for a Group item that opens a group of items.  
ItemProps Definition that specifies properties shared between many ConfigurableUi components.  
KeyinBrowserExecuteArgs Arguments for KeyinBrowserProps onExecute callback. Beta
KeyinBrowserProps Properties of the KeyinBrowser component. Beta
PopupButtonChildrenRenderPropArgs Arguments of PopupButtonChildrenRenderProp. Deprecated
PopupButtonProps Properties for the PopupButton React component Deprecated
ToolButtonProps Properties for the ToolButton React Component. Deprecated
ToolItemProps Properties for a Tool item with a tool id.  

Type Aliases

Name Description  
AnyItemDef Union of all Item definitions that can be specified in a GroupItem  
AnyToolbarItemDef Union of all Item definitions that can be specified in a Toolbar  
MenuItemProps Menu Item Properties  
PopupButtonChildrenRenderProp  
StageUsage Standard stage uses. Beta

Last Updated: 30 November, 2023