Data Table Params
GitHubReads and writes data-table query state using readable URL parameters.
Installation
bash
pnpm dlx shadcn@latest add @cs/data-table-paramsUsage
tsx
import { dataTableParamKeys } from "@/lib/cs/data-table-params";tsx
const keys = dataTableParamKeys("orders_");API Reference
dataTableParamKeys
Builds readable URL parameter keys for an optional per-table prefix.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| prefix * | unknown | - | - |
Returns: unknown
writeDataTableQuery
Serializes table query state into readable params using the shared convention.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| search * | URLSearchParams | - | - |
| query * | DataTableQuery | - | - |
| prefix * | unknown | - | - |
Returns: unknown
readTableQuery
Parses readable params into table query state, falling back to defaults (e.g. a saved view).
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
| get * | TableParamGetter | - | - |
| prefix * | unknown | - | - |
| defaults | Partial<DataTableQuery> | - | - |
Returns: DataTableQuery