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. | |
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. | |
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 | |
---|---|---|
ConditionalBooleanValue | ||
ConditionalStringValue | ||
ToolbarDragInteractionContext | Context used to enable toolbar drag interaction. |
Enumerations
Name | Description | |
---|---|---|
StageUsage | Standard stage uses. |
Interfaces
Name | Description | |
---|---|---|
BaseItemState | Base state for any 'stateful' React component | |
CommandHandler | Definition for a command handler. | |
CommandItemProps | Properties for a Command item. | |
CursorMenuItemProps | Properties for context menu items. | |
CustomItemProps | Definition for a Custom item that renders a React component. | |
GroupItemProps | Definition for a Group item that opens a group of items. | |
ItemProps | Definition that specifies properties shared between many ConfigurableUi components. | |
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 | |
ConditionalBooleanValue | Class used to return a boolean value. | |
ConditionalStringValue | Class used to return a string value. | |
MenuItemProps | Menu Item Properties | Deprecated |
Last Updated: 22 March, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.