Skip to main content

Interface: ActionDescription

Broker.ActionDescription

Hierarchy​

Properties​

checkable​

• Optional checkable: boolean

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

checked​

• Optional checked: boolean

Value of the checkbox.

checkedStateSource​

• Optional checkedStateSource: () => boolean

Getter to retrieve the current checkbox value.

Type declaration​

▸ (): boolean

Returns​

boolean

enabled​

• Optional enabled: boolean

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

• Optional externalLink: boolean

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

icon​

• Optional icon: string

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

separator​

• Optional separator: boolean

Is a menu separator

shortcut​

• Optional shortcut: string

Keyboard shortcut for the action. Displayed as hint text.

text​

• Optional text: string

Displayed text for action

tooltip​

• Optional tooltip: string

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