AbstractActionItemProps Interface

Definition for an item that executes and action.

Extends

Inherited properties

Name Type Inherited from Description
applicationData undefined | any CommonItemProps can be used by application to store miscellaneous data.
badgeType undefined | BadgeType CommonItemProps Badge to be overlaid on the item.
description string | ConditionalStringValue CommonItemProps if set, it is used to explicitly set the description shown by components that support a description.
execute undefined | (args?: any) => any CommandHandler Function to execute
getCommandArgs undefined | () => any[] CommandHandler Function to get the parameters passed to the function
icon string | ConditionalStringValue CommonItemProps Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.
internalData undefined | Map<string, any> CommonItemProps optional data to be used by item implementor.
isActive undefined | false | true CommonItemProps if set, component will be considered "active" an will display an "active stripe" - defaults to false
isDisabled boolean | ConditionalBooleanValue CommonItemProps if true component will be disabled - defaults to false
isHidden boolean | ConditionalBooleanValue CommonItemProps if true component will be hidden - defaults to false
isPressed undefined | false | true CommonItemProps if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.
label string | ConditionalStringValue CommonItemProps if set, it is used to explicitly set the label shown by a component.
parameters undefined | any CommandHandler Parameters passed to the function
tooltip string | ConditionalStringValue CommonItemProps used to explicitly set the tooltip shown by a component.

Defined in

Last Updated: 15 June, 2021