...
<action name> | The name of the action. The name is used in the Action bar definition. |
class
| required Action definition class that reads the configuration properties and can supply additional properties to the action. The class must implement the | Javadoc resource link |
|---|
| rangeHigherVersion | 5.7 |
|---|
| className | info.magnolia.ui.api.action.ActionDefinition |
|---|
| renderType | asynchronous |
|---|
|
interface. |
label
| required Label displayed to users in the action bar or context menu. |
implementationClass
| optional The implementation class executes the action. A default implementation class is typically hard-coded in the definition class. You only need to add this property if you want to override the default implementation, for example to perform some extra validation on a saved value. |
appName
| optional Name of the app to launch when executing this action. This property works together with the subAppId property. They tell where the action takes place. For example, the addContact action takes place in the detail subapp of the contacts app. The detail subapp displays a form that allows the user to fill in the contact's details. Set the property value to the app name given in app configuration. |
subAppId
| optional Name of the subapp to open when executing the action. |
icon
| optional CSS class that identifies an icon font used on the action. See Icons. |
i18nBasename
| optional Message bundle such as com.example.apps.messages . You don't need to set this property if your message bundle is in the i18n directory inside the module (best practice). Magnolia will find the bundle automatically. Only set the property if you put the bundle somewhere else. |
dialogName
| optional Dialog to open when the action is executed. A dialog is an alternative to editing items in an editor. Identify the dialog using syntax <module name>:<dialog name> , for example pages:editPage . This property applies only to actions that open dialogs (OpenCreateDialogActionDefinition and OpenEditDialogActionDefinition ). |
nodeType
| optional Node type the action creates or operates on. This property is needed if the action calls a dialog. The nodeType property tells the dialog what node type it should operate on. When the action is executed in a detail app the property is not needed because the /browser/contentConnector/nodeType/<node type name>/name property already defines the node type. |
<action definition specific properties>
| required/optional Some action definition classes support additional properties. For example ConfirmActionDefinition allows you to set messages and labels and DownloadBinaryActionDefinition supports file name and extension properties. See Javadocs for additional properties.
|
availability
| optional Defines whether the action is permitted on the selected item. See Action availability. |
...
Example: activate action definition in Contacts app.
| Localtab Group |
|---|
| Localtab |
|---|
| | Code Block |
|---|
| language | js |
|---|
| title | contacts/apps/contacts.yaml |
|---|
| browser:
actions:
activate:
command: activate
icon: icon-publish
catalog: versioned
class: info.magnolia.ui.framework.action.ActivationActionDefinition
label: Publish |
|
| Localtab |
|---|
| | Advanced Tables - Table Plus |
|---|
| heading | 0 |
|---|
| enableHeadingAttributes | false |
|---|
| enableSorting | false |
|---|
| class | m5-configuration-tree |
|---|
| enableHighlighting | false |
|---|
| | Node name | Value |
|---|
|
| |
| |
| |
| |
| |
| | versioned | | info.magnolia.ui.framework.action.ActivationActionDefinition | | activate | | icon-publish | | Publish |
|
|
|
...