API Reference › appui-abstract› Toolbar › ActionButton

ActionButton Interface

Describes the data needed to insert an action button into a toolbar.

Extends

Properties

Name Type Description
execute Readonly () => void function to run when the button is pressed.  
icon Readonly string | ConditionalStringValue Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id.  
label Readonly string | ConditionalStringValue label, shown as tool tip on a button or an item label in a group.  

Inherited properties

Name Type Inherited from Description
applicationData Readonly any | undefined ToolbarItem can be used by application to store miscellaneous data.
badgeType Readonly BadgeType | undefined ToolbarItem Describes badge.
description Readonly string | ConditionalStringValue ToolbarItem Optional description
groupPriority Readonly number | undefined ToolbarItem Specifies the item's grouping value.
id Readonly string ToolbarItem Require uniqueId for the item.
internalData Readonly Map<string, any> | undefined ToolbarItem optional data to used by item implementor.
isActive Readonly boolean | undefined ToolbarItem Defines if the item is active (shown with an active stripe/bar).
isDisabled Readonly boolean | ConditionalBooleanValue ToolbarItem Describes if the item is enabled or disabled.
isHidden Readonly boolean | ConditionalBooleanValue ToolbarItem Describes if the item is visible or hidden.
isPressed Readonly boolean | undefined ToolbarItem Describes if the item should appear pressed (used for displaying toggle state).
itemPriority Readonly number ToolbarItem Priority within a toolbar or group.
parentToolGroupId Readonly string | undefined ToolbarItem Optional parent tool group to add tool.
providerId Readonly string | undefined ToolbarItem id of UiItemsProvider

Defined in

Last Updated: 13 May, 2024