Interface Action<T>Beta

Represents an action that is displayed in the UI

Type Parameters

Hierarchy

  • Action

Properties

command condition? description? disabled? hideLabel? icon? label?

Properties

command

command: T

The command to execute when the action is activated

Optional condition

condition?: Condition<unknown>

Condition to determine if the action is available

Optional description

description?: string

Additional description about the action

Optional disabled

disabled?: boolean

True if the action is disabled

Optional hideLabel

hideLabel?: boolean

True if the icon should be displayed without a label. A label should still be provided for accessibility and for scenarios where the action is displayed differently, such as in a tooltip or menu.

Optional icon

icon?: string | Icon

Icon of the action

Optional label

label?: string

Label to display on or next to the action. The label will be translated by the Translator

Settings

Member Visibility

Theme