ListViewActions

There are three types of events: download, upload and event.

Example

Route: /<entity>/metadata

{
  "columns": [
    /* ... */
  ],
  "permissions": {
    "action": {
      /* ... */
    }
  },
  /* These are actions for which the user has permission to execute them */
  "actions": [
    {
      "id": "ExportCsv",
      "label": "common.action.csvExport",
      "type": "download",
      "icon": "fa-file-export"
    },
    {
      "id": "ExportTsv",
      "label": "common.action.tsvExport",
      "type": "download",
      "icon": "fa-file-export"
    },
    {
      "id": "ImportCSV",
      "label": "common.action.csvImport",
      "type": "upload",
      "icon": "fa-file-import",
      "options": [
        {
          "name": "overwrite",
          "label": "common.upload.overwriteExisting",
          "type": "BOOLEAN",
          "value": false
        },
        {
          "name": "deleteMissing",
          "label": "common.upload.deleteMissing",
          "type": "BOOLEAN",
          "value": false
        }
      ]
    },
    {
      "id": "ImportTSV",
      "label": "common.action.tsvImport",
      "type": "upload",
      "icon": "fa-file-import",
      "options": [
        {
          "name": "deleteMissing",
          "label": "common.upload.deleteMissing",
          "type": "BOOLEAN",
          "value": false
        }
      ]
    }
  ]
}

Upload/Download

If the user selects an action with the type 'download' or 'upload', the backoffice will call /<entity>/execute/<kebab-id> where <kebab-id> is the kebab-case variant of the <id>.

Example: /translations/execute/export-csv

Upload Options

Upload actions can have options. These have a name, a label, a type and a default value. The only supported type at this moment is BOOLEAN. These options will be displayed in the file upload dialog as check boxes.

Event

When the type is event, a list-view-action-clicked event will be emitted. Its payload is the action object from the actions array above. You need to subscribe to this event (and also unsubscribe) and implement a manual action afterwards, e.g. opening a custom modal.

Example: https://jdi-backoffice-test.jdi.nl/translations