Bindings

Actions

Each action supports a binding like this:

{
    "key": "{key}",                      (required)
    "title": "{title}",                  (required)
    "action": "{action}",
    "module": "{module}",
    "iconClass": "{iconClass}",    
    "order": {order},
    "allowPermission": [],
    "rejectPermission": [],
    "allowAuthority": [],
    "rejectAuthority": []
}

The properties are defined as shown below:

Property Type Required Description
key string yes a unique key for the menu item
title string yes display title for the menu item
action string the ID of the action to invoke
module string the identifier of the action module to invoke
iconClass string CSS classes to append to the icon holder when rendered
order number the order to display where lower numbers render first
allowPermission array an array of permissions, any of which must assert true in order to render
rejectPermission array an array of permissions, any of which must assert true in order to not render
allowAuthority array an array of authorities, any of which must assert true in order to render
rejectAuthority array an array of authorities, any of which must assert true in order to not render

Invoking by Action ID

Here is an example that fires the new_folder action.

{
    "key": "custom/new-folder",
    "title": "New Folder",
    "action": "new_folder"
}

Invoking by Module Path

Custom actions are defined in modules that are registered through the UI extension framework.
The implementation classes can be referenced like this:

{
    "key": "myaction",
    "title": "My Action",
    "module": "custom/actions/my-action"
}

Each nav item supports a binding like this:

{
    "key": "{key}",                 (required)
    "title": "{title}",             (required)
    "uri": "{uri}",                 (required)
    "cssClass": "{cssClass}",
    "iconClass": "{iconClass}",
    "order": {order},
    "header": {header},
    "allowPermission: [],
    "rejectPermission": {],
    "allowAuthority: [],
    "rejectAuthority": {]    
}

The properties are defined as shown below:

Property Type Required Description
key string yes a unique key for the menu item
title string yes display title for the menu item
uri string yes the URI that gets dispatched upon click
cssClass string CSS classes to append to the menu item when rendered
iconClass string CSS classes to append to the icon holder when rendered
order number the order to display where lower numbers render first
header boolean whether to render as a header
allowPermission array an array of permissions, any of which must assert true in order to render
rejectPermission array an array of permissions, any of which must assert true in order to not render
allowAuthority array an array of authorities, any of which must assert true in order to render
rejectAuthority array an array of authorities, any of which must assert true in order to not render