Bulk Actions
label
React.ReactNodeicon
LucideIconconfirmationText
React.ReactNodeonClick
() => voidclassName
stringrequiresPermission
string[]disabled
booleancloseOnClick
booleanA component that should be used to implement any bulk actions for list pages & data tables.
Example
Parameters
props
Readonly<DataTableBulkActionItemProps>A bulk action is a component that will be rendered in the bulk actions dropdown.
The component receives the following props:
selection: The selected row or rowstable: A reference to the Tanstack table instance powering the list
The table object has
Example
For the common action of deletion, we provide a ready-made helper component:
Example
order
numberOptional order number to control the position of this bulk action in the dropdown. A larger number will appear lower in the list.
component
BulkActionComponent<any>The React component that will be rendered as the bulk action item.
A group of bulk actions that are visually separated in the dropdown menu.
Optionally includes a translatable label rendered as a DropdownMenuLabel.
label
React.ReactNodeOptional label rendered as a DropdownMenuLabel at the top of the group.
actions
BulkAction[]The bulk actions in this group.
Bulk actions input supports three formats:
- Flat array (backwards compatible):
BulkAction[]— all actions in one group. - Array of arrays:
BulkAction[][]— each inner array is a visually separated group. - Array of groups:
BulkActionGroup[]— groups with optional labels.
Formats 2 and 3 can be mixed in the same array.
Example