Skip to main content

ActionState

Interface

Properties

actionId

Human-readable, non-unique ID of an action item. Similar to label, but language-agnostic.

Type

ActionId


active

Is active

Type

boolean


checkable

Whether an action should have a checkbox next to it.

Type

boolean


checked

If checkable is true then whether current state is checked or not.

Type

boolean


disabled

Whether an action is disabled or not (disabled actions are usually cannot be executed and displayed grayed out)

Type

boolean


doNotCloseOnClick

A flag indicating whether the menu should remain open after clicking on the item. When true the menu will remain open.

Type

boolean


hint

Optional

A hint of an action.

Type

string


icon

Optional

A string of SVG icon for an action. A string should be a string representation of SVG (not a path/URL).

Type

string


iconChecked

Optional

If checkable is true then an icon to be used when checked is true.

Type

string


label

Text title of an action

Type

string


loading

Whether an action is still in loading state (it means that it's data is not ready yet). Usually in this case a spinner/loader will be displayed instead of this action.

Type

boolean


noInteractive

Optional

This flag indicates that this action is static content only and is not interactive.

Type

boolean


shortcutHint

Optional

A string that represents a shortcut hint for this action.

Type

string


styledLabel

Optional

Text title of an action consisting of several styled sections. If not defined then label is used instead.

Type

StyledText[]


subItems

Sub-items of an action

Type

IActionVariant[]