Skip to main content

Bulk Actions

Signature

label

propertyReact.ReactNode

icon

propertyLucideIcon

confirmationText

propertyReact.ReactNode

onClick

property() => void

className

propertystring

requiresPermission

propertystring[]

disabled

propertyboolean

closeOnClick

propertyboolean

A component that should be used to implement any bulk actions for list pages & data tables.

Example

Tsx
Signature

Parameters

props

parameterReadonly<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 rows
  • table: A reference to the Tanstack table instance powering the list

The table object has

Example

Tsx

For the common action of deletion, we provide a ready-made helper component:

Example

Tsx
Signature

order

propertynumber

Optional order number to control the position of this bulk action in the dropdown. A larger number will appear lower in the list.

component

propertyBulkActionComponent<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.

Signature

label

propertyReact.ReactNode

Optional label rendered as a DropdownMenuLabel at the top of the group.

actions

propertyBulkAction[]

The bulk actions in this group.

Bulk actions input supports three formats:

  1. Flat array (backwards compatible): BulkAction[] — all actions in one group.
  2. Array of arrays: BulkAction[][] — each inner array is a visually separated group.
  3. Array of groups: BulkActionGroup[] — groups with optional labels.

Formats 2 and 3 can be mixed in the same array.

Example

Tsx
Signature
Was this chapter helpful?
Report Issue
Edited Mar 23, 2026·Edit this page