Skip to main content
Version: v24

ActionDescription

Interface

Properties

checkable

Optional

Whether menu action represents a checkbox state. Set it to true if you need a checkbox.

Type

boolean


checked

Optional

Value of the checkbox.

Type

boolean


checkedStateSource

Optional

Type

() => boolean

Type declaration

Getter to retrieve the current checkbox value.

Returns

boolean


enabled

Optional

Whether the action is enabled. Set to false to disabled the action.

Type

boolean


Optional

External link (url) which will be opened upon clicking the menu item.

Type

boolean


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


separator

Optional

Is a menu separator

Type

boolean


shortcut

Optional

Keyboard shortcut for the action. Displayed as hint text.

Type

string


text

Optional

Displayed text for action

Type

string


tooltip

Optional

Tooltip text to be displayed when hovering over the action item.

Type

string