SQLRooms

@sqlrooms/data-table / DataTablePaginatedProps

Type Alias: DataTablePaginatedProps<Data>

DataTablePaginatedProps<Data> = object

Type Parameters

Type Parameter
Data extends object

Properties

className?

optional className: string


fontSize?

optional fontSize: string

Custom font size for the table e.g. text-xs, text-sm, text-md, text-lg, text-base


data?

optional data: ArrayLike<Data>


columns?

optional columns: ColumnDef<Data, any>[]


pageCount?

optional pageCount: number


numRows?

optional numRows: number


isFetching?

optional isFetching: boolean


pagination?

optional pagination: PaginationState


sorting?

optional sorting: SortingState


footerActions?

optional footerActions: React.ReactNode


onPaginationChange()?

optional onPaginationChange: (pagination) => void

Parameters

ParameterType
paginationPaginationState

Returns

void


onSortingChange()?

optional onSortingChange: (sorting) => void

Parameters

ParameterType
sortingSortingState

Returns

void


onRowClick()?

optional onRowClick: (args) => void

Called when a row is clicked.

Parameters

ParameterType
args{ row: Row<Data>; event: React.MouseEvent<HTMLTableRowElement>; }
args.rowRow<Data>
args.eventReact.MouseEvent<HTMLTableRowElement>

Returns

void


onRowDoubleClick()?

optional onRowDoubleClick: (args) => void

Called when a row is double-clicked.

Parameters

ParameterType
args{ row: Row<Data>; event: React.MouseEvent<HTMLTableRowElement>; }
args.rowRow<Data>
args.eventReact.MouseEvent<HTMLTableRowElement>

Returns

void


enableRowSelection?

optional enableRowSelection: boolean

Enables row selection with checkboxes. When true, a checkbox column is added.


rowSelection?

optional rowSelection: RowSelectionState

Controlled row selection state. Keys are row indices, values are selection status.


onRowSelectionChange()?

optional onRowSelectionChange: (rowSelection) => void

Called when row selection changes.

Parameters

ParameterType
rowSelectionRowSelectionState

Returns

void