Use Data Table Columns With Bulk

GitHub

Prepends a bulk-selection column to data-table columns when bulk actions are available.

Installation

bash
pnpm dlx shadcn@latest add @cs/use-data-table-columns-with-bulk

Usage

tsx
import { useDataTableColumnsWithBulk } from "@/hooks/cs/use-data-table-columns-with-bulk"
tsx
const columnsWithBulk = useDataTableColumnsWithBulk({
  filteredColumns,
  bulkSelection,
  totalCount,
  stream,
  fetchData,
  bulkActions,
})

API Reference

useDataTableColumnsWithBulk

Prepends a bulk-selection column to data-table columns when bulk actions are available.

Props

NameTypeDefaultDescription
bulkActions *DataTableBulkActionsConfig<TData, TDataTableBulkAction> | undefined--
bulkSelection *UseDataTableBulkSelectionReturn--
fetchData *DataTableOnData--
filteredColumns *ColumnDef<TData, TValue>[]--
onPermission(action: TDataTableBulkAction) => boolean--
stream *Omit<UseDataTableStreamRouteReturn<RowData>, "data">--
totalCount *number--
translationsRootKeystring"table"Namespace used by bulk-selection controls; expects the table message tree.