Interface: DataTableConfig<TRow, TFilterKeys *extends* `string`, TSortKeys *extends* `string`, TDialogKeys *extends* `string`, TSearchParams *extends* [`AnyStaticSearchParams`](../type-aliases/AnyStaticSearchParams.md) = [`StaticSearchParams`](../type-aliases/StaticSearchParams.md), TPaginationMode *extends* [`PaginationMode`](../type-aliases/PaginationMode.md) = `"offset"`>
Defined in: shared/datatable/types.ts:409
Type Parameters
| Type Parameter | Default type |
|---|---|
TRow | - |
TFilterKeys extends string | - |
TSortKeys extends string | - |
TDialogKeys extends string | - |
TSearchParams extends AnyStaticSearchParams | StaticSearchParams |
TPaginationMode extends PaginationMode | "offset" |
Properties
_types
_types: {
dialogKeys: TDialogKeys;
filterKeys: TFilterKeys;
paginationMode: TPaginationMode;
row: TRow;
sortKeys: TSortKeys;
};Defined in: shared/datatable/types.ts:445
dialogKeys
dialogKeys: TDialogKeys;filterKeys
filterKeys: TFilterKeys;paginationMode
paginationMode: TPaginationMode;row
row: TRow;sortKeys
sortKeys: TSortKeys;actions
actions: ActionConfig<TRow, TDialogKeys>[];Defined in: shared/datatable/types.ts:419
columns
columns: (
| ActionsColumnConfig
| ColumnConfig<TRow, keyof TRow>)[];Defined in: shared/datatable/types.ts:417
containScroll?
optional containScroll?: boolean;Defined in: shared/datatable/types.ts:441
defaultSort?
optional defaultSort?: SortConfig<TSortKeys>;Defined in: shared/datatable/types.ts:422
filters
filters: FilterConfig[];Defined in: shared/datatable/types.ts:418
groupBy?
optional groupBy?: GroupConfig<TRow, keyof TRow>;Defined in: shared/datatable/types.ts:439
hidePagination?
optional hidePagination?: boolean;Defined in: shared/datatable/types.ts:433
mobileCards?
optional mobileCards?: boolean;Defined in: shared/datatable/types.ts:440
pageSize?
optional pageSize?: number;Defined in: shared/datatable/types.ts:423
pageSizeOptions?
optional pageSizeOptions?: readonly number[];Defined in: shared/datatable/types.ts:425
Ordered page-size choices. Omit to keep the fixed pageSize behavior.
pageSizeStorageKey?
optional pageSizeStorageKey?: string;Defined in: shared/datatable/types.ts:430
Optional exact localStorage key for the user's page-size preference.
Requires pageSizeOptions; explicit URL state always takes precedence.
pagination?
optional pagination?: DataTablePaginationConfig<TPaginationMode>;Defined in: shared/datatable/types.ts:432
Offset pagination is the default when this option is omitted.
search?
optional search?: SearchConfig;Defined in: shared/datatable/types.ts:420
searchParams
searchParams: TSearchParams;Defined in: shared/datatable/types.ts:442
sortMode?
optional sortMode?: "server" | "client";Defined in: shared/datatable/types.ts:438
stickyPagination?
optional stickyPagination?: boolean;Defined in: shared/datatable/types.ts:437
Keep pagination visible below the scrolling table body. Defaults to false.
urlKeys?
optional urlKeys?: Partial<Record<keyof TSearchParams, string>>;Defined in: shared/datatable/types.ts:444
Maps logical parser keys to their optional per-instance URL names.
views?
optional views?: ViewsConfig;Defined in: shared/datatable/types.ts:421