DocsAPI Reference

API Reference

Table Instance APIs

All the table instance methods and objects that can be accessed from the table instance in Shadcn Table

NOTE: These are NOT the table options for Shadcn Table. These are just static methods on a table instance that you can use.

These are the methods available on the table instance that is returned from the useShadcnTable hook. You can use these methods to interact with the table instance.

const columns = useMemo(() => [
  {
    accessor: 'name',
    header: 'Name',
    Cell: ({ cell, table }) => <span onClick={() => table.{/* or maybe here */}}></span>,
  },
], []);

const table = useShadcnTable({
  columns,
  data,
  renderTopToolbarCustomActions: ({ table }) => <Button onClick={() => table{/* or maybe here */}}>Click Me</Button>,
});

const someEventHandler = () => {
  table. //call any of the table instance methods here
};

return <ShadcnTable table={table} />;
#
State Option
Type
More Info Links
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133ST_TableState<TData>TanStack Table State Docs
134ReadonlyStore<ST_TableState<TData>>TanStack Table State Docs
135
136
137
138

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