Skip to main content

Action Field

type: "action"

A select of the actions provided by the installed plugins. Users also configure the settings of the selected action.

tip

Every widget can already trigger a single action when clicked, without an action field. Only use action fields to trigger actions from code. See In-depth: Actions.

Additional Properties

PropertyTypeDescription
filtersFilterActionConfigRestricts which actions users can select.
defaultValueValueActionConfigThe action selected by default.

Filters

FilterTypeDescription
groupsstring[]Only actions in these groups, by the id of the group.

Example

mobro-widget-config.json
{
"config": [
{
"name": "play_action",
"label": "Play action",
"type": "action"
}
]
}

Usage

To execute the selected action from a widget, use useActionField.