Skip to main content

IBulkAction

Admin Docs


Interface: IBulkAction<T>

Defined in: src/types/shared-components/DataTable/hooks.ts:157

Configuration for an action available on bulk-selected rows.

Bulk actions operate on multiple selected rows at once and typically involve server mutations or data processing.

Type Parameters

T

T

The type of row data this action operates on

Properties

confirm?

optional confirm: string

Defined in: src/types/shared-components/DataTable/hooks.ts:179

Optional confirmation message to display before executing the action


disabled?

optional disabled: boolean | (rows, keys) => boolean

Defined in: src/types/shared-components/DataTable/hooks.ts:177

Whether this action is disabled for the current selection. Can be a boolean or a function that evaluates the selection.

Param

Array of selected rows

Param

Array of keys for the selected rows


id

id: string

Defined in: src/types/shared-components/DataTable/hooks.ts:159

Unique identifier for this action


label

label: string

Defined in: src/types/shared-components/DataTable/hooks.ts:161

Display label for the bulk action button


onClick()

onClick: (rows, keys) => void | Promise<void>

Defined in: src/types/shared-components/DataTable/hooks.ts:170

Callback fired when the bulk action is triggered. Can be async to support server operations.

Parameters

rows

T[]

Array of selected rows

keys

Key[]

Array of keys for the selected rows

Returns

void | Promise<void>

void or Promise<void> if async