Skip to main content

Version: 22.10

Bulk Actions

Bulk actions allow a user to perfom a single action on multiple tasks listed on the List Screen table. Searches and filters can be applied to the listing table as required, then bulk actions performed on the results.

To enable bulk actions and configure the label, add it to your current space configuration.

Example

  bulkActions: {
label: 'Bulk Actions',
enabled: false,
permissions: {
type: 'role',
value: ['Processing Staff'],
},
},

Options

OptionDescription
labelstring
The label displayed for the control.
enabledtrue | false
Set to true to make bulk action mode available in a space.
permissionsobject
Configure permissions to show or hide cards based on the current user role or group.

Usage

To perform a bulk action:

  • Use the Bulk Action switch to activate bulk action mode. All tasks in the item list are disabled, and an action bar appears at the bottom of the table with a Select Action dropdown.
  • Select an action from the dropdown. All tasks in the item list that can be a target of the selected action are enabled.
    • If the action you selected requires the selection of a user, a Select User dropdown also appears.
  • Select the tasks you want to act on.
    • If the Select User dropdown is visible, select a user.
  • Click Apply.

Attributes

To review the list of supported attributes, see API Reference.