Interface: ActionDescriptionWithCallback
Broker.ActionDescriptionWithCallback
Menu action which provides a callback function to be executed. Action is executed when user clicks the item.
Hierarchy
-
↳
ActionDescriptionWithCallback
Properties
action
• action: (a?: ActionDescription) => void
Action to be executed when user clicks the menu item.
Type declaration
▸ (a?): void
Parameters
| Name | Type |
|---|---|
a? | ActionDescription |
Returns
void
checkable
• Optional checkable: boolean
Whether menu action represents a checkbox state. Set it to true if you need a checkbox.
Inherited from
checked
• Optional checked: boolean
Value of the checkbox.
Inherited from
checkedStateSource
• Optional checkedStateSource: () => boolean
Getter to retrieve the current checkbox value.
Type declaration
▸ (): boolean
Returns
boolean
Inherited from
ActionDescription.checkedStateSource
enabled
• Optional enabled: boolean
Whether the action is enabled. Set to false to disabled the action.
Inherited from
externalLink
• Optional externalLink: boolean
External link (url) which will be opened upon clicking the menu item.
Inherited from
ActionDescription.externalLink
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).
Inherited from
separator
• Optional separator: boolean
Is a menu separator
Inherited from
shortcut
• Optional shortcut: string
Keyboard shortcut for the action. Displayed as hint text.
Inherited from
text
• Optional text: string
Displayed text for action
Inherited from
tooltip
• Optional tooltip: string
Tooltip text to be displayed when hovering over the action item.