State Options | shadcn-table

Many of the state options you can pass here are the same as the ones you can pass to the TanStack Table v9 useTable hook. Read them back from table.state.

Here is a list of all the state options you can pass to initialState or state.

const table = useShadcnTable({
  columns,
  data,
  //note: each individual state must be mutually exclusive to `initial state` or `state`
  initialState: {
    // all the state options you can pass here
  },
  state: {
    // or here
  },
});

#	Type	Default Value	More Info Links
1	`{ [key: string]: ST_FilterFn }`

2	`Array<{id: string, value: unknown}>`	`{}`	TanStack Table Filters Docs

3	`Array<string>`	`[]`	TanStack Table Column Ordering Docs

4	`{ start: Array<string>, end: Array<string> }`	`{ left: [], right: [] }`	TanStack Table Column Pinning Docs

5	`ST_ColumnResizingState`	`{}`	TanStack Table Column Sizing Docs

6	`Record<string, number>`	`{}`	TanStack Table Column Sizing Docs

7	`Record<string, boolean>`	`{}`	TanStack Table Column Visibility Docs

8	`ST_Row`

9	`'comfortable' \| 'compact' \| 'spacious'`	`'comfortable'`

10	`ST_Column \| null`

11	`ST_Row \| null`

12	`ST_Cell`

13	`ST_Row`

14	`Record<string, boolean> \| boolean`	`{}`	TanStack Table Expanding Docs

15	`any`		TanStack Table Filtering Docs

16	`ST_FilterFn`

17	`Array<string>`	`[]`	TanStack Table Grouping Docs

18	`ST_Column \| null`

19	`ST_Row \| null`

20	`boolean`	`false`

21	`boolean`	`false`

22	`boolean`	`false`

23	`{ pageIndex: number, pageSize: number }`	`{ pageIndex: 0, pageSize: 10 }`	TanStack Table Pagination Docs

24	`{ top: string[], bottom: string[] }`	`{ top: [], bottom: [] }`	TanStack Table Column Pinning Docs

25	`Record<string, boolean>`	`{}`	TanStack Table Row Selection Docs

26	`boolean`	`false`

27	`boolean`	`false`

28	`boolean`	`false`

29	`boolean`	`false`

30	`boolean`	`false`

31	`boolean`	`false`

32	`boolean`	`false`

33	`Array<{ id: string, desc: boolean }>`	`[]`	TanStack Table Sorting Docs

Wanna see the source code for this table? Check it out down below!