ActionButtonItemDef Class
Deprecated in 4.15.0. Use type specific utilities for creating items instead, i.e. ToolbarItemUtilities.createActionItem
.
Abstract base class that is used by classes to execute an action when pressed.
Extends
Extended by
Methods
Name | Description | |
---|---|---|
constructor(itemProps: ItemProps, onItemExecuted?: OnItemExecutedFunc): ActionButtonItemDef | ||
execute(): void | Called when the action button is invoked by a click or touch | |
getDimension(orientation: Orientation): number | Determines the dimension in a given orientation | |
handleSizeKnown(size: SizeProps): void | Called when the size of the action button is initialized and the size is known |
Inherited methods
Name | Inherited from | Description |
---|---|---|
setDescription(v: string | StringGetter | ConditionalStringValue): void | ItemDefBase | Set the description. |
setLabel(v: string | StringGetter | ConditionalStringValue): void | ItemDefBase | Set the label. |
setTooltip(v: string | StringGetter | ConditionalStringValue): void | ItemDefBase | Set the tooltip. |
initializeDef(me: ItemDefBase, itemProps: ItemProps): void Static | ItemDefBase |
Properties
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
applicationData | any | undefined | ItemDefBase | |
badgeKind | BadgeKind | undefined | ItemDefBase | |
badgeType | BadgeType | undefined | ItemDefBase | |
description Accessor ReadOnly | string | ItemDefBase | Get the description string |
iconElement | React.ReactNode | undefined | ItemDefBase | |
iconSpec | IconSpec | undefined | ItemDefBase | |
id Accessor Abstract ReadOnly | string | ItemDefBase | |
isActive Accessor | boolean | ItemDefBase | |
isDisabled | boolean | ConditionalBooleanValue | ItemDefBase | |
isHidden | boolean | ConditionalBooleanValue | ItemDefBase | |
isPressed | boolean | ItemDefBase | |
label Accessor ReadOnly | string | ItemDefBase | Get the label string |
rawLabel Accessor ReadOnly | string | StringGetter | ConditionalStringValue | ItemDefBase | Get the label string |
tooltip Accessor ReadOnly | string | ItemDefBase | Get the tooltip string |
trayId Accessor ReadOnly | undefined | ItemDefBase |
Defined in
Last Updated: 17 December, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.