@tanstack/table-core 8.0.12 → 8.0.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/stats-html.html +1 -1
- package/build/stats-react.json +306 -306
- package/build/types/index.d.ts +835 -29
- package/package.json +1 -1
- package/build/types/aggregationFns.d.ts +0 -13
- package/build/types/core/cell.d.ts +0 -9
- package/build/types/core/column.d.ts +0 -40
- package/build/types/core/headers.d.ts +0 -46
- package/build/types/core/instance.d.ts +0 -58
- package/build/types/core/row.d.ts +0 -15
- package/build/types/createTable.d.ts +0 -63
- package/build/types/features/ColumnSizing.d.ts +0 -63
- package/build/types/features/Expanding.d.ts +0 -39
- package/build/types/features/Filters.d.ts +0 -90
- package/build/types/features/Grouping.d.ts +0 -68
- package/build/types/features/Ordering.d.ts +0 -18
- package/build/types/features/Pagination.d.ts +0 -42
- package/build/types/features/Pinning.d.ts +0 -40
- package/build/types/features/RowSelection.d.ts +0 -40
- package/build/types/features/Sorting.d.ts +0 -63
- package/build/types/features/Visibility.d.ts +0 -40
- package/build/types/filterFns.d.ts +0 -13
- package/build/types/sortingFns.d.ts +0 -11
- package/build/types/types.d.ts +0 -53
- package/build/types/utils/filterRowsUtils.d.ts +0 -4
- package/build/types/utils/getCoreRowModel.d.ts +0 -2
- package/build/types/utils/getExpandedRowModel.d.ts +0 -7
- package/build/types/utils/getFacetedMinMaxValues.d.ts +0 -2
- package/build/types/utils/getFacetedRowModel.d.ts +0 -2
- package/build/types/utils/getFacetedUniqueValues.d.ts +0 -2
- package/build/types/utils/getFilteredRowModel.d.ts +0 -2
- package/build/types/utils/getGroupedRowModel.d.ts +0 -2
- package/build/types/utils/getPaginationRowModel.d.ts +0 -4
- package/build/types/utils/getSortedRowModel.d.ts +0 -2
- package/build/types/utils.d.ts +0 -19
package/build/types/index.d.ts
CHANGED
|
@@ -1,29 +1,835 @@
|
|
|
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
|
-
|
|
1
|
+
/**
|
|
2
|
+
* table-core
|
|
3
|
+
*
|
|
4
|
+
* Copyright (c) TanStack
|
|
5
|
+
*
|
|
6
|
+
* This source code is licensed under the MIT license found in the
|
|
7
|
+
* LICENSE.md file in the root directory of this source tree.
|
|
8
|
+
*
|
|
9
|
+
* @license MIT
|
|
10
|
+
*/
|
|
11
|
+
declare type CoreColumnDefType = 'data' | 'display' | 'group';
|
|
12
|
+
declare type CoreColumnDef<TGenerics extends TableGenerics> = {
|
|
13
|
+
id: string;
|
|
14
|
+
accessorKey?: string & keyof TGenerics['Row'];
|
|
15
|
+
accessorFn?: AccessorFn<TGenerics['Row']>;
|
|
16
|
+
columns?: ColumnDef<TGenerics>[];
|
|
17
|
+
header?: Renderable<TGenerics, {
|
|
18
|
+
instance: TableInstance<TGenerics>;
|
|
19
|
+
header: Header<TGenerics>;
|
|
20
|
+
column: Column<TGenerics>;
|
|
21
|
+
}>;
|
|
22
|
+
footer?: Renderable<TGenerics, {
|
|
23
|
+
instance: TableInstance<TGenerics>;
|
|
24
|
+
header: Header<TGenerics>;
|
|
25
|
+
column: Column<TGenerics>;
|
|
26
|
+
}>;
|
|
27
|
+
cell?: Renderable<TGenerics, {
|
|
28
|
+
instance: TableInstance<TGenerics>;
|
|
29
|
+
row: Row<TGenerics>;
|
|
30
|
+
column: Column<TGenerics>;
|
|
31
|
+
cell: Cell<TGenerics>;
|
|
32
|
+
getValue: () => TGenerics['Value'];
|
|
33
|
+
}>;
|
|
34
|
+
meta?: TGenerics['ColumnMeta'];
|
|
35
|
+
};
|
|
36
|
+
declare type CoreColumn<TGenerics extends TableGenerics> = {
|
|
37
|
+
id: string;
|
|
38
|
+
depth: number;
|
|
39
|
+
accessorFn?: AccessorFn<TGenerics['Row']>;
|
|
40
|
+
columnDef: ColumnDef<TGenerics>;
|
|
41
|
+
columnDefType: CoreColumnDefType;
|
|
42
|
+
columns: Column<TGenerics>[];
|
|
43
|
+
parent?: Column<TGenerics>;
|
|
44
|
+
getFlatColumns: () => Column<TGenerics>[];
|
|
45
|
+
getLeafColumns: () => Column<TGenerics>[];
|
|
46
|
+
};
|
|
47
|
+
declare function createColumn<TGenerics extends TableGenerics>(instance: TableInstance<TGenerics>, columnDef: ColumnDef<TGenerics> & {
|
|
48
|
+
columnDefType?: CoreColumnDefType;
|
|
49
|
+
}, depth: number, parent?: Column<TGenerics>): Column<TGenerics>;
|
|
50
|
+
|
|
51
|
+
declare type VisibilityState = Record<string, boolean>;
|
|
52
|
+
declare type VisibilityTableState = {
|
|
53
|
+
columnVisibility: VisibilityState;
|
|
54
|
+
};
|
|
55
|
+
declare type VisibilityOptions = {
|
|
56
|
+
onColumnVisibilityChange?: OnChangeFn<VisibilityState>;
|
|
57
|
+
enableHiding?: boolean;
|
|
58
|
+
};
|
|
59
|
+
declare type VisibilityDefaultOptions = {
|
|
60
|
+
onColumnVisibilityChange: OnChangeFn<VisibilityState>;
|
|
61
|
+
};
|
|
62
|
+
declare type VisibilityInstance<TGenerics extends TableGenerics> = {
|
|
63
|
+
getVisibleFlatColumns: () => Column<TGenerics>[];
|
|
64
|
+
getVisibleLeafColumns: () => Column<TGenerics>[];
|
|
65
|
+
getLeftVisibleLeafColumns: () => Column<TGenerics>[];
|
|
66
|
+
getRightVisibleLeafColumns: () => Column<TGenerics>[];
|
|
67
|
+
getCenterVisibleLeafColumns: () => Column<TGenerics>[];
|
|
68
|
+
setColumnVisibility: (updater: Updater<VisibilityState>) => void;
|
|
69
|
+
resetColumnVisibility: (defaultState?: boolean) => void;
|
|
70
|
+
toggleAllColumnsVisible: (value?: boolean) => void;
|
|
71
|
+
getIsAllColumnsVisible: () => boolean;
|
|
72
|
+
getIsSomeColumnsVisible: () => boolean;
|
|
73
|
+
getToggleAllColumnsVisibilityHandler: () => (event: unknown) => void;
|
|
74
|
+
};
|
|
75
|
+
declare type VisibilityColumnDef = {
|
|
76
|
+
enableHiding?: boolean;
|
|
77
|
+
};
|
|
78
|
+
declare type VisibilityRow<TGenerics extends TableGenerics> = {
|
|
79
|
+
_getAllVisibleCells: () => Cell<TGenerics>[];
|
|
80
|
+
getVisibleCells: () => Cell<TGenerics>[];
|
|
81
|
+
};
|
|
82
|
+
declare type VisibilityColumn = {
|
|
83
|
+
getCanHide: () => boolean;
|
|
84
|
+
getIsVisible: () => boolean;
|
|
85
|
+
toggleVisibility: (value?: boolean) => void;
|
|
86
|
+
getToggleVisibilityHandler: () => (event: unknown) => void;
|
|
87
|
+
};
|
|
88
|
+
declare const Visibility: TableFeature;
|
|
89
|
+
|
|
90
|
+
declare type ColumnOrderTableState = {
|
|
91
|
+
columnOrder: ColumnOrderState;
|
|
92
|
+
};
|
|
93
|
+
declare type ColumnOrderState = string[];
|
|
94
|
+
declare type ColumnOrderOptions = {
|
|
95
|
+
onColumnOrderChange?: OnChangeFn<ColumnOrderState>;
|
|
96
|
+
};
|
|
97
|
+
declare type ColumnOrderDefaultOptions = {
|
|
98
|
+
onColumnOrderChange: OnChangeFn<ColumnOrderState>;
|
|
99
|
+
};
|
|
100
|
+
declare type ColumnOrderInstance<TGenerics extends TableGenerics> = {
|
|
101
|
+
setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
|
|
102
|
+
resetColumnOrder: (defaultState?: boolean) => void;
|
|
103
|
+
_getOrderColumnsFn: () => (columns: Column<TGenerics>[]) => Column<TGenerics>[];
|
|
104
|
+
};
|
|
105
|
+
declare const Ordering: TableFeature;
|
|
106
|
+
|
|
107
|
+
declare type ColumnPinningPosition = false | 'left' | 'right';
|
|
108
|
+
declare type ColumnPinningState = {
|
|
109
|
+
left?: string[];
|
|
110
|
+
right?: string[];
|
|
111
|
+
};
|
|
112
|
+
declare type ColumnPinningTableState = {
|
|
113
|
+
columnPinning: ColumnPinningState;
|
|
114
|
+
};
|
|
115
|
+
declare type ColumnPinningOptions = {
|
|
116
|
+
onColumnPinningChange?: OnChangeFn<ColumnPinningState>;
|
|
117
|
+
enablePinning?: boolean;
|
|
118
|
+
};
|
|
119
|
+
declare type ColumnPinningDefaultOptions = {
|
|
120
|
+
onColumnPinningChange: OnChangeFn<ColumnPinningState>;
|
|
121
|
+
};
|
|
122
|
+
declare type ColumnPinningColumnDef = {
|
|
123
|
+
enablePinning?: boolean;
|
|
124
|
+
};
|
|
125
|
+
declare type ColumnPinningColumn = {
|
|
126
|
+
getCanPin: () => boolean;
|
|
127
|
+
getPinnedIndex: () => number;
|
|
128
|
+
getIsPinned: () => ColumnPinningPosition;
|
|
129
|
+
pin: (position: ColumnPinningPosition) => void;
|
|
130
|
+
};
|
|
131
|
+
declare type ColumnPinningRow<TGenerics extends TableGenerics> = {
|
|
132
|
+
getLeftVisibleCells: () => Cell<TGenerics>[];
|
|
133
|
+
getCenterVisibleCells: () => Cell<TGenerics>[];
|
|
134
|
+
getRightVisibleCells: () => Cell<TGenerics>[];
|
|
135
|
+
};
|
|
136
|
+
declare type ColumnPinningInstance<TGenerics extends TableGenerics> = {
|
|
137
|
+
setColumnPinning: (updater: Updater<ColumnPinningState>) => void;
|
|
138
|
+
resetColumnPinning: (defaultState?: boolean) => void;
|
|
139
|
+
getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean;
|
|
140
|
+
getLeftLeafColumns: () => Column<TGenerics>[];
|
|
141
|
+
getRightLeafColumns: () => Column<TGenerics>[];
|
|
142
|
+
getCenterLeafColumns: () => Column<TGenerics>[];
|
|
143
|
+
};
|
|
144
|
+
declare const Pinning: TableFeature;
|
|
145
|
+
|
|
146
|
+
declare type CoreHeaderGroup<TGenerics extends TableGenerics> = {
|
|
147
|
+
id: string;
|
|
148
|
+
depth: number;
|
|
149
|
+
headers: Header<TGenerics>[];
|
|
150
|
+
};
|
|
151
|
+
declare type CoreHeader<TGenerics extends TableGenerics> = {
|
|
152
|
+
id: string;
|
|
153
|
+
index: number;
|
|
154
|
+
depth: number;
|
|
155
|
+
column: Column<TGenerics>;
|
|
156
|
+
headerGroup: HeaderGroup<TGenerics>;
|
|
157
|
+
subHeaders: Header<TGenerics>[];
|
|
158
|
+
colSpan: number;
|
|
159
|
+
rowSpan: number;
|
|
160
|
+
getLeafHeaders: () => Header<TGenerics>[];
|
|
161
|
+
isPlaceholder: boolean;
|
|
162
|
+
placeholderId?: string;
|
|
163
|
+
renderHeader: (options?: {
|
|
164
|
+
renderPlaceholder?: boolean;
|
|
165
|
+
}) => string | null | TGenerics['Rendered'];
|
|
166
|
+
renderFooter: (options?: {
|
|
167
|
+
renderPlaceholder?: boolean;
|
|
168
|
+
}) => string | null | TGenerics['Rendered'];
|
|
169
|
+
};
|
|
170
|
+
declare type HeadersInstance<TGenerics extends TableGenerics> = {
|
|
171
|
+
getHeaderGroups: () => HeaderGroup<TGenerics>[];
|
|
172
|
+
getLeftHeaderGroups: () => HeaderGroup<TGenerics>[];
|
|
173
|
+
getCenterHeaderGroups: () => HeaderGroup<TGenerics>[];
|
|
174
|
+
getRightHeaderGroups: () => HeaderGroup<TGenerics>[];
|
|
175
|
+
getFooterGroups: () => HeaderGroup<TGenerics>[];
|
|
176
|
+
getLeftFooterGroups: () => HeaderGroup<TGenerics>[];
|
|
177
|
+
getCenterFooterGroups: () => HeaderGroup<TGenerics>[];
|
|
178
|
+
getRightFooterGroups: () => HeaderGroup<TGenerics>[];
|
|
179
|
+
getFlatHeaders: () => Header<TGenerics>[];
|
|
180
|
+
getLeftFlatHeaders: () => Header<TGenerics>[];
|
|
181
|
+
getCenterFlatHeaders: () => Header<TGenerics>[];
|
|
182
|
+
getRightFlatHeaders: () => Header<TGenerics>[];
|
|
183
|
+
getLeafHeaders: () => Header<TGenerics>[];
|
|
184
|
+
getLeftLeafHeaders: () => Header<TGenerics>[];
|
|
185
|
+
getCenterLeafHeaders: () => Header<TGenerics>[];
|
|
186
|
+
getRightLeafHeaders: () => Header<TGenerics>[];
|
|
187
|
+
};
|
|
188
|
+
declare const Headers: TableFeature;
|
|
189
|
+
declare function buildHeaderGroups<TGenerics extends TableGenerics>(allColumns: Column<TGenerics>[], columnsToGroup: Column<TGenerics>[], instance: TableInstance<TGenerics>, headerFamily?: 'center' | 'left' | 'right'): HeaderGroup<TGenerics>[];
|
|
190
|
+
|
|
191
|
+
declare const filterFns: {
|
|
192
|
+
includesString: FilterFn<any>;
|
|
193
|
+
includesStringSensitive: FilterFn<any>;
|
|
194
|
+
equalsString: FilterFn<any>;
|
|
195
|
+
arrIncludes: FilterFn<any>;
|
|
196
|
+
arrIncludesAll: FilterFn<any>;
|
|
197
|
+
arrIncludesSome: FilterFn<any>;
|
|
198
|
+
equals: FilterFn<any>;
|
|
199
|
+
weakEquals: FilterFn<any>;
|
|
200
|
+
inNumberRange: FilterFn<any>;
|
|
201
|
+
};
|
|
202
|
+
declare type BuiltInFilterFn = keyof typeof filterFns;
|
|
203
|
+
|
|
204
|
+
declare type FiltersTableState = {
|
|
205
|
+
columnFilters: ColumnFiltersState;
|
|
206
|
+
globalFilter: any;
|
|
207
|
+
};
|
|
208
|
+
declare type ColumnFiltersState = ColumnFilter[];
|
|
209
|
+
declare type ColumnFilter = {
|
|
210
|
+
id: string;
|
|
211
|
+
value: unknown;
|
|
212
|
+
};
|
|
213
|
+
declare type ResolvedColumnFilter<TGenerics extends TableGenerics> = {
|
|
214
|
+
id: string;
|
|
215
|
+
resolvedValue: unknown;
|
|
216
|
+
filterFn: FilterFn<TGenerics>;
|
|
217
|
+
};
|
|
218
|
+
declare type FilterFn<TGenerics extends TableGenerics> = {
|
|
219
|
+
(row: Row<TGenerics>, columnId: string, filterValue: any, addMeta: (meta: TGenerics['FilterMeta']) => void): boolean;
|
|
220
|
+
resolveFilterValue?: TransformFilterValueFn<TGenerics>;
|
|
221
|
+
autoRemove?: ColumnFilterAutoRemoveTestFn<TGenerics>;
|
|
222
|
+
};
|
|
223
|
+
declare type TransformFilterValueFn<TGenerics extends TableGenerics> = (value: any, column?: Column<TGenerics>) => unknown;
|
|
224
|
+
declare type ColumnFilterAutoRemoveTestFn<TGenerics extends TableGenerics> = (value: any, column?: Column<TGenerics>) => boolean;
|
|
225
|
+
declare type CustomFilterFns<TGenerics extends TableGenerics> = Record<string, FilterFn<TGenerics>>;
|
|
226
|
+
declare type FilterFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInFilterFn | keyof TGenerics['FilterFns'] | FilterFn<TGenerics>;
|
|
227
|
+
declare type FiltersColumnDef<TGenerics extends TableGenerics> = {
|
|
228
|
+
filterFn?: FilterFnOption<Overwrite<TGenerics, {
|
|
229
|
+
Value: any;
|
|
230
|
+
}>>;
|
|
231
|
+
enableColumnFilter?: boolean;
|
|
232
|
+
enableGlobalFilter?: boolean;
|
|
233
|
+
};
|
|
234
|
+
declare type FiltersColumn<TGenerics extends TableGenerics> = {
|
|
235
|
+
getAutoFilterFn: () => FilterFn<TGenerics> | undefined;
|
|
236
|
+
getFilterFn: () => FilterFn<TGenerics> | undefined;
|
|
237
|
+
setFilterValue: (updater: Updater<any>) => void;
|
|
238
|
+
getCanFilter: () => boolean;
|
|
239
|
+
getCanGlobalFilter: () => boolean;
|
|
240
|
+
getFacetedRowModel: () => RowModel<TGenerics>;
|
|
241
|
+
_getFacetedRowModel?: () => RowModel<TGenerics>;
|
|
242
|
+
getIsFiltered: () => boolean;
|
|
243
|
+
getFilterValue: () => unknown;
|
|
244
|
+
getFilterIndex: () => number;
|
|
245
|
+
getFacetedUniqueValues: () => Map<any, number>;
|
|
246
|
+
_getFacetedUniqueValues?: () => Map<any, number>;
|
|
247
|
+
getFacetedMinMaxValues: () => undefined | [number, number];
|
|
248
|
+
_getFacetedMinMaxValues?: () => undefined | [number, number];
|
|
249
|
+
};
|
|
250
|
+
declare type FiltersRow<TGenerics extends TableGenerics> = {
|
|
251
|
+
columnFilters: Record<string, boolean>;
|
|
252
|
+
columnFiltersMeta: Record<string, TGenerics['FilterMeta']>;
|
|
253
|
+
};
|
|
254
|
+
declare type FiltersOptions<TGenerics extends TableGenerics> = {
|
|
255
|
+
enableFilters?: boolean;
|
|
256
|
+
manualFiltering?: boolean;
|
|
257
|
+
filterFromLeafRows?: boolean;
|
|
258
|
+
filterFns?: TGenerics['FilterFns'];
|
|
259
|
+
getFilteredRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
|
|
260
|
+
onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>;
|
|
261
|
+
enableColumnFilters?: boolean;
|
|
262
|
+
globalFilterFn?: FilterFnOption<TGenerics>;
|
|
263
|
+
onGlobalFilterChange?: OnChangeFn<any>;
|
|
264
|
+
enableGlobalFilter?: boolean;
|
|
265
|
+
getColumnCanGlobalFilter?: (column: Column<TGenerics>) => boolean;
|
|
266
|
+
getFacetedRowModel?: (instance: TableInstance<TGenerics>, columnId: string) => () => RowModel<TGenerics>;
|
|
267
|
+
getFacetedUniqueValues?: (instance: TableInstance<TGenerics>, columnId: string) => () => Map<any, number>;
|
|
268
|
+
getFacetedMinMaxValues?: (instance: TableInstance<TGenerics>, columnId: string) => () => undefined | [number, number];
|
|
269
|
+
};
|
|
270
|
+
declare type FiltersInstance<TGenerics extends TableGenerics> = {
|
|
271
|
+
setColumnFilters: (updater: Updater<ColumnFiltersState>) => void;
|
|
272
|
+
resetColumnFilters: (defaultState?: boolean) => void;
|
|
273
|
+
getPreFilteredRowModel: () => RowModel<TGenerics>;
|
|
274
|
+
getFilteredRowModel: () => RowModel<TGenerics>;
|
|
275
|
+
_getFilteredRowModel?: () => RowModel<TGenerics>;
|
|
276
|
+
setGlobalFilter: (updater: Updater<any>) => void;
|
|
277
|
+
resetGlobalFilter: (defaultState?: boolean) => void;
|
|
278
|
+
getGlobalAutoFilterFn: () => FilterFn<TGenerics> | undefined;
|
|
279
|
+
getGlobalFilterFn: () => FilterFn<TGenerics> | undefined;
|
|
280
|
+
getGlobalFacetedRowModel: () => RowModel<TGenerics>;
|
|
281
|
+
_getGlobalFacetedRowModel?: () => RowModel<TGenerics>;
|
|
282
|
+
getGlobalFacetedUniqueValues: () => Map<any, number>;
|
|
283
|
+
_getGlobalFacetedUniqueValues?: () => Map<any, number>;
|
|
284
|
+
getGlobalFacetedMinMaxValues: () => undefined | [number, number];
|
|
285
|
+
_getGlobalFacetedMinMaxValues?: () => undefined | [number, number];
|
|
286
|
+
};
|
|
287
|
+
declare const Filters: TableFeature;
|
|
288
|
+
declare function shouldAutoRemoveFilter<TGenerics extends TableGenerics>(filterFn?: FilterFn<TGenerics>, value?: any, column?: Column<TGenerics>): boolean;
|
|
289
|
+
|
|
290
|
+
declare const reSplitAlphaNumeric: RegExp;
|
|
291
|
+
declare const sortingFns: {
|
|
292
|
+
alphanumeric: SortingFn<any>;
|
|
293
|
+
alphanumericCaseSensitive: SortingFn<any>;
|
|
294
|
+
text: SortingFn<any>;
|
|
295
|
+
textCaseSensitive: SortingFn<any>;
|
|
296
|
+
datetime: SortingFn<any>;
|
|
297
|
+
basic: SortingFn<any>;
|
|
298
|
+
};
|
|
299
|
+
declare type BuiltInSortingFn = keyof typeof sortingFns;
|
|
300
|
+
|
|
301
|
+
declare type SortDirection = 'asc' | 'desc';
|
|
302
|
+
declare type ColumnSort = {
|
|
303
|
+
id: string;
|
|
304
|
+
desc: boolean;
|
|
305
|
+
};
|
|
306
|
+
declare type SortingState = ColumnSort[];
|
|
307
|
+
declare type SortingTableState = {
|
|
308
|
+
sorting: SortingState;
|
|
309
|
+
};
|
|
310
|
+
declare type SortingFn<TGenerics extends TableGenerics> = {
|
|
311
|
+
(rowA: Row<TGenerics>, rowB: Row<TGenerics>, columnId: string): number;
|
|
312
|
+
};
|
|
313
|
+
declare type CustomSortingFns<TGenerics extends TableGenerics> = Record<string, SortingFn<TGenerics>>;
|
|
314
|
+
declare type SortingFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInSortingFn | keyof TGenerics['SortingFns'] | SortingFn<TGenerics>;
|
|
315
|
+
declare type SortingColumnDef<TGenerics extends TableGenerics> = {
|
|
316
|
+
sortingFn?: SortingFnOption<Overwrite<TGenerics, {
|
|
317
|
+
Value: any;
|
|
318
|
+
}>>;
|
|
319
|
+
sortDescFirst?: boolean;
|
|
320
|
+
enableSorting?: boolean;
|
|
321
|
+
enableMultiSort?: boolean;
|
|
322
|
+
invertSorting?: boolean;
|
|
323
|
+
sortUndefined?: false | -1 | 1;
|
|
324
|
+
};
|
|
325
|
+
declare type SortingColumn<TGenerics extends TableGenerics> = {
|
|
326
|
+
getAutoSortingFn: () => SortingFn<TGenerics>;
|
|
327
|
+
getAutoSortDir: () => SortDirection;
|
|
328
|
+
getSortingFn: () => SortingFn<TGenerics>;
|
|
329
|
+
getNextSortingOrder: () => SortDirection | false;
|
|
330
|
+
getCanSort: () => boolean;
|
|
331
|
+
getCanMultiSort: () => boolean;
|
|
332
|
+
getSortIndex: () => number;
|
|
333
|
+
getIsSorted: () => false | SortDirection;
|
|
334
|
+
clearSorting: () => void;
|
|
335
|
+
toggleSorting: (desc?: boolean, isMulti?: boolean) => void;
|
|
336
|
+
getToggleSortingHandler: () => undefined | ((event: unknown) => void);
|
|
337
|
+
};
|
|
338
|
+
declare type SortingOptions<TGenerics extends TableGenerics> = {
|
|
339
|
+
manualSorting?: boolean;
|
|
340
|
+
sortingFns?: TGenerics['SortingFns'];
|
|
341
|
+
onSortingChange?: OnChangeFn<SortingState>;
|
|
342
|
+
enableSorting?: boolean;
|
|
343
|
+
enableSortingRemoval?: boolean;
|
|
344
|
+
enableMultiRemove?: boolean;
|
|
345
|
+
enableMultiSort?: boolean;
|
|
346
|
+
sortDescFirst?: boolean;
|
|
347
|
+
getSortedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
|
|
348
|
+
maxMultiSortColCount?: number;
|
|
349
|
+
isMultiSortEvent?: (e: unknown) => boolean;
|
|
350
|
+
};
|
|
351
|
+
declare type SortingInstance<TGenerics extends TableGenerics> = {
|
|
352
|
+
setSorting: (updater: Updater<SortingState>) => void;
|
|
353
|
+
resetSorting: (defaultState?: boolean) => void;
|
|
354
|
+
getPreSortedRowModel: () => RowModel<TGenerics>;
|
|
355
|
+
getSortedRowModel: () => RowModel<TGenerics>;
|
|
356
|
+
_getSortedRowModel?: () => RowModel<TGenerics>;
|
|
357
|
+
};
|
|
358
|
+
declare const Sorting: TableFeature;
|
|
359
|
+
|
|
360
|
+
declare const aggregationFns: {
|
|
361
|
+
sum: AggregationFn<any>;
|
|
362
|
+
min: AggregationFn<any>;
|
|
363
|
+
max: AggregationFn<any>;
|
|
364
|
+
extent: AggregationFn<any>;
|
|
365
|
+
mean: AggregationFn<any>;
|
|
366
|
+
median: AggregationFn<any>;
|
|
367
|
+
unique: AggregationFn<any>;
|
|
368
|
+
uniqueCount: AggregationFn<any>;
|
|
369
|
+
count: AggregationFn<any>;
|
|
370
|
+
};
|
|
371
|
+
declare type BuiltInAggregationFn = keyof typeof aggregationFns;
|
|
372
|
+
|
|
373
|
+
declare type GroupingState = string[];
|
|
374
|
+
declare type GroupingTableState = {
|
|
375
|
+
grouping: GroupingState;
|
|
376
|
+
};
|
|
377
|
+
declare type AggregationFn<TGenerics extends TableGenerics> = (columnId: string, leafRows: Row<TGenerics>[], childRows: Row<TGenerics>[]) => any;
|
|
378
|
+
declare type CustomAggregationFns<TGenerics extends TableGenerics> = Record<string, AggregationFn<TGenerics>>;
|
|
379
|
+
declare type AggregationFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInAggregationFn | keyof TGenerics['AggregationFns'] | AggregationFn<TGenerics>;
|
|
380
|
+
declare type GroupingColumnDef<TGenerics extends TableGenerics> = {
|
|
381
|
+
aggregationFn?: AggregationFnOption<Overwrite<TGenerics, {
|
|
382
|
+
Value: any;
|
|
383
|
+
}>>;
|
|
384
|
+
aggregatedCell?: Renderable<TGenerics, {
|
|
385
|
+
instance: TableInstance<TGenerics>;
|
|
386
|
+
row: Row<TGenerics>;
|
|
387
|
+
column: Column<TGenerics>;
|
|
388
|
+
cell: Cell<TGenerics>;
|
|
389
|
+
getValue: () => TGenerics['Value'];
|
|
390
|
+
}>;
|
|
391
|
+
enableGrouping?: boolean;
|
|
392
|
+
};
|
|
393
|
+
declare type GroupingColumn<TGenerics extends TableGenerics> = {
|
|
394
|
+
getCanGroup: () => boolean;
|
|
395
|
+
getIsGrouped: () => boolean;
|
|
396
|
+
getGroupedIndex: () => number;
|
|
397
|
+
toggleGrouping: () => void;
|
|
398
|
+
getToggleGroupingHandler: () => () => void;
|
|
399
|
+
getAutoAggregationFn: () => AggregationFn<TGenerics> | undefined;
|
|
400
|
+
getAggregationFn: () => AggregationFn<TGenerics> | undefined;
|
|
401
|
+
};
|
|
402
|
+
declare type GroupingRow = {
|
|
403
|
+
groupingColumnId?: string;
|
|
404
|
+
groupingValue?: any;
|
|
405
|
+
getIsGrouped: () => boolean;
|
|
406
|
+
_groupingValuesCache: Record<string, any>;
|
|
407
|
+
};
|
|
408
|
+
declare type GroupingCell<TGenerics extends TableGenerics> = {
|
|
409
|
+
getIsGrouped: () => boolean;
|
|
410
|
+
getIsPlaceholder: () => boolean;
|
|
411
|
+
getIsAggregated: () => boolean;
|
|
412
|
+
renderAggregatedCell: () => string | null | TGenerics['Rendered'];
|
|
413
|
+
};
|
|
414
|
+
declare type ColumnDefaultOptions = {
|
|
415
|
+
onGroupingChange: OnChangeFn<GroupingState>;
|
|
416
|
+
enableGrouping: boolean;
|
|
417
|
+
};
|
|
418
|
+
declare type GroupingOptions<TGenerics extends TableGenerics> = {
|
|
419
|
+
manualGrouping?: boolean;
|
|
420
|
+
aggregationFns?: TGenerics['AggregationFns'];
|
|
421
|
+
onGroupingChange?: OnChangeFn<GroupingState>;
|
|
422
|
+
enableGrouping?: boolean;
|
|
423
|
+
getGroupedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
|
|
424
|
+
groupedColumnMode?: false | 'reorder' | 'remove';
|
|
425
|
+
};
|
|
426
|
+
declare type GroupingColumnMode = false | 'reorder' | 'remove';
|
|
427
|
+
declare type GroupingInstance<TGenerics extends TableGenerics> = {
|
|
428
|
+
setGrouping: (updater: Updater<GroupingState>) => void;
|
|
429
|
+
resetGrouping: (defaultState?: boolean) => void;
|
|
430
|
+
getPreGroupedRowModel: () => RowModel<TGenerics>;
|
|
431
|
+
getGroupedRowModel: () => RowModel<TGenerics>;
|
|
432
|
+
_getGroupedRowModel?: () => RowModel<TGenerics>;
|
|
433
|
+
};
|
|
434
|
+
declare const Grouping: TableFeature;
|
|
435
|
+
declare function orderColumns<TGenerics extends TableGenerics>(leafColumns: Column<TGenerics>[], grouping: string[], groupedColumnMode?: GroupingColumnMode): Column<TGenerics>[];
|
|
436
|
+
|
|
437
|
+
declare type ExpandedStateList = Record<string, boolean>;
|
|
438
|
+
declare type ExpandedState = true | Record<string, boolean>;
|
|
439
|
+
declare type ExpandedTableState = {
|
|
440
|
+
expanded: ExpandedState;
|
|
441
|
+
};
|
|
442
|
+
declare type ExpandedRow = {
|
|
443
|
+
toggleExpanded: (expanded?: boolean) => void;
|
|
444
|
+
getIsExpanded: () => boolean;
|
|
445
|
+
getCanExpand: () => boolean;
|
|
446
|
+
getToggleExpandedHandler: () => () => void;
|
|
447
|
+
};
|
|
448
|
+
declare type ExpandedOptions<TGenerics extends TableGenerics> = {
|
|
449
|
+
manualExpanding?: boolean;
|
|
450
|
+
onExpandedChange?: OnChangeFn<ExpandedState>;
|
|
451
|
+
autoResetExpanded?: boolean;
|
|
452
|
+
enableExpanding?: boolean;
|
|
453
|
+
getExpandedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
|
|
454
|
+
getIsRowExpanded?: (row: Row<TGenerics>) => boolean;
|
|
455
|
+
getRowCanExpand?: (row: Row<TGenerics>) => boolean;
|
|
456
|
+
paginateExpandedRows?: boolean;
|
|
457
|
+
};
|
|
458
|
+
declare type ExpandedInstance<TGenerics extends TableGenerics> = {
|
|
459
|
+
_autoResetExpanded: () => void;
|
|
460
|
+
setExpanded: (updater: Updater<ExpandedState>) => void;
|
|
461
|
+
toggleAllRowsExpanded: (expanded?: boolean) => void;
|
|
462
|
+
resetExpanded: (defaultState?: boolean) => void;
|
|
463
|
+
getCanSomeRowsExpand: () => boolean;
|
|
464
|
+
getToggleAllRowsExpandedHandler: () => (event: unknown) => void;
|
|
465
|
+
getIsSomeRowsExpanded: () => boolean;
|
|
466
|
+
getIsAllRowsExpanded: () => boolean;
|
|
467
|
+
getExpandedDepth: () => number;
|
|
468
|
+
getExpandedRowModel: () => RowModel<TGenerics>;
|
|
469
|
+
_getExpandedRowModel?: () => RowModel<TGenerics>;
|
|
470
|
+
getPreExpandedRowModel: () => RowModel<TGenerics>;
|
|
471
|
+
};
|
|
472
|
+
declare const Expanding: TableFeature;
|
|
473
|
+
|
|
474
|
+
declare type ColumnSizingTableState = {
|
|
475
|
+
columnSizing: ColumnSizingState;
|
|
476
|
+
columnSizingInfo: ColumnSizingInfoState;
|
|
477
|
+
};
|
|
478
|
+
declare type ColumnSizingState = Record<string, number>;
|
|
479
|
+
declare type ColumnSizingInfoState = {
|
|
480
|
+
startOffset: null | number;
|
|
481
|
+
startSize: null | number;
|
|
482
|
+
deltaOffset: null | number;
|
|
483
|
+
deltaPercentage: null | number;
|
|
484
|
+
isResizingColumn: false | string;
|
|
485
|
+
columnSizingStart: [string, number][];
|
|
486
|
+
};
|
|
487
|
+
declare type ColumnResizeMode = 'onChange' | 'onEnd';
|
|
488
|
+
declare type ColumnSizingOptions = {
|
|
489
|
+
enableColumnResizing?: boolean;
|
|
490
|
+
columnResizeMode?: ColumnResizeMode;
|
|
491
|
+
onColumnSizingChange?: OnChangeFn<ColumnSizingState>;
|
|
492
|
+
onColumnSizingInfoChange?: OnChangeFn<ColumnSizingInfoState>;
|
|
493
|
+
};
|
|
494
|
+
declare type ColumnSizingDefaultOptions = {
|
|
495
|
+
columnResizeMode: ColumnResizeMode;
|
|
496
|
+
onColumnSizingChange: OnChangeFn<ColumnSizingState>;
|
|
497
|
+
onColumnSizingInfoChange: OnChangeFn<ColumnSizingInfoState>;
|
|
498
|
+
};
|
|
499
|
+
declare type ColumnSizingInstance<TGenerics extends TableGenerics> = {
|
|
500
|
+
setColumnSizing: (updater: Updater<ColumnSizingState>) => void;
|
|
501
|
+
setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void;
|
|
502
|
+
resetColumnSizing: (defaultState?: boolean) => void;
|
|
503
|
+
resetHeaderSizeInfo: (defaultState?: boolean) => void;
|
|
504
|
+
getTotalSize: () => number;
|
|
505
|
+
getLeftTotalSize: () => number;
|
|
506
|
+
getCenterTotalSize: () => number;
|
|
507
|
+
getRightTotalSize: () => number;
|
|
508
|
+
};
|
|
509
|
+
declare type ColumnSizingColumnDef = {
|
|
510
|
+
enableResizing?: boolean;
|
|
511
|
+
size?: number;
|
|
512
|
+
minSize?: number;
|
|
513
|
+
maxSize?: number;
|
|
514
|
+
};
|
|
515
|
+
declare type ColumnSizingColumn<TGenerics extends TableGenerics> = {
|
|
516
|
+
getSize: () => number;
|
|
517
|
+
getStart: (position?: ColumnPinningPosition) => number;
|
|
518
|
+
getCanResize: () => boolean;
|
|
519
|
+
getIsResizing: () => boolean;
|
|
520
|
+
resetSize: () => void;
|
|
521
|
+
};
|
|
522
|
+
declare type ColumnSizingHeader<TGenerics extends TableGenerics> = {
|
|
523
|
+
getSize: () => number;
|
|
524
|
+
getStart: (position?: ColumnPinningPosition) => number;
|
|
525
|
+
getResizeHandler: () => (event: unknown) => void;
|
|
526
|
+
};
|
|
527
|
+
declare const defaultColumnSizing: {
|
|
528
|
+
size: number;
|
|
529
|
+
minSize: number;
|
|
530
|
+
maxSize: number;
|
|
531
|
+
};
|
|
532
|
+
declare const ColumnSizing: TableFeature;
|
|
533
|
+
declare function passiveEventSupported(): boolean;
|
|
534
|
+
|
|
535
|
+
declare type PaginationState = {
|
|
536
|
+
pageIndex: number;
|
|
537
|
+
pageSize: number;
|
|
538
|
+
};
|
|
539
|
+
declare type PaginationTableState = {
|
|
540
|
+
pagination: PaginationState;
|
|
541
|
+
};
|
|
542
|
+
declare type PaginationInitialTableState = {
|
|
543
|
+
pagination?: Partial<PaginationState>;
|
|
544
|
+
};
|
|
545
|
+
declare type PaginationOptions<TGenerics extends TableGenerics> = {
|
|
546
|
+
pageCount?: number;
|
|
547
|
+
manualPagination?: boolean;
|
|
548
|
+
onPaginationChange?: OnChangeFn<PaginationState>;
|
|
549
|
+
autoResetPageIndex?: boolean;
|
|
550
|
+
getPaginationRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
|
|
551
|
+
};
|
|
552
|
+
declare type PaginationDefaultOptions = {
|
|
553
|
+
onPaginationChange: OnChangeFn<PaginationState>;
|
|
554
|
+
};
|
|
555
|
+
declare type PaginationInstance<TGenerics extends TableGenerics> = {
|
|
556
|
+
_autoResetPageIndex: () => void;
|
|
557
|
+
setPagination: (updater: Updater<PaginationState>) => void;
|
|
558
|
+
resetPagination: (defaultState?: boolean) => void;
|
|
559
|
+
setPageIndex: (updater: Updater<number>) => void;
|
|
560
|
+
resetPageIndex: (defaultState?: boolean) => void;
|
|
561
|
+
setPageSize: (updater: Updater<number>) => void;
|
|
562
|
+
resetPageSize: (defaultState?: boolean) => void;
|
|
563
|
+
setPageCount: (updater: Updater<number>) => void;
|
|
564
|
+
getPageOptions: () => number[];
|
|
565
|
+
getCanPreviousPage: () => boolean;
|
|
566
|
+
getCanNextPage: () => boolean;
|
|
567
|
+
previousPage: () => void;
|
|
568
|
+
nextPage: () => void;
|
|
569
|
+
getPrePaginationRowModel: () => RowModel<TGenerics>;
|
|
570
|
+
getPaginationRowModel: () => RowModel<TGenerics>;
|
|
571
|
+
_getPaginationRowModel?: () => RowModel<TGenerics>;
|
|
572
|
+
getPageCount: () => number;
|
|
573
|
+
};
|
|
574
|
+
declare const Pagination: TableFeature;
|
|
575
|
+
|
|
576
|
+
declare type RowSelectionState = Record<string, boolean>;
|
|
577
|
+
declare type RowSelectionTableState = {
|
|
578
|
+
rowSelection: RowSelectionState;
|
|
579
|
+
};
|
|
580
|
+
declare type RowSelectionOptions<TGenerics extends TableGenerics> = {
|
|
581
|
+
enableRowSelection?: boolean | ((row: Row<TGenerics>) => boolean);
|
|
582
|
+
enableMultiRowSelection?: boolean | ((row: Row<TGenerics>) => boolean);
|
|
583
|
+
enableSubRowSelection?: boolean | ((row: Row<TGenerics>) => boolean);
|
|
584
|
+
onRowSelectionChange?: OnChangeFn<RowSelectionState>;
|
|
585
|
+
};
|
|
586
|
+
declare type RowSelectionRow = {
|
|
587
|
+
getIsSelected: () => boolean;
|
|
588
|
+
getIsSomeSelected: () => boolean;
|
|
589
|
+
getCanSelect: () => boolean;
|
|
590
|
+
getCanMultiSelect: () => boolean;
|
|
591
|
+
getCanSelectSubRows: () => boolean;
|
|
592
|
+
toggleSelected: (value?: boolean) => void;
|
|
593
|
+
getToggleSelectedHandler: () => (event: unknown) => void;
|
|
594
|
+
};
|
|
595
|
+
declare type RowSelectionInstance<TGenerics extends TableGenerics> = {
|
|
596
|
+
getToggleAllRowsSelectedHandler: () => (event: unknown) => void;
|
|
597
|
+
getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void;
|
|
598
|
+
setRowSelection: (updater: Updater<RowSelectionState>) => void;
|
|
599
|
+
resetRowSelection: (defaultState?: boolean) => void;
|
|
600
|
+
getIsAllRowsSelected: () => boolean;
|
|
601
|
+
getIsAllPageRowsSelected: () => boolean;
|
|
602
|
+
getIsSomeRowsSelected: () => boolean;
|
|
603
|
+
getIsSomePageRowsSelected: () => boolean;
|
|
604
|
+
toggleAllRowsSelected: (value?: boolean) => void;
|
|
605
|
+
toggleAllPageRowsSelected: (value?: boolean) => void;
|
|
606
|
+
getPreSelectedRowModel: () => RowModel<TGenerics>;
|
|
607
|
+
getSelectedRowModel: () => RowModel<TGenerics>;
|
|
608
|
+
getFilteredSelectedRowModel: () => RowModel<TGenerics>;
|
|
609
|
+
getGroupedSelectedRowModel: () => RowModel<TGenerics>;
|
|
610
|
+
};
|
|
611
|
+
declare const RowSelection: TableFeature;
|
|
612
|
+
declare function selectRowsFn<TGenerics extends TableGenerics>(instance: TableInstance<TGenerics>, rowModel: RowModel<TGenerics>): RowModel<TGenerics>;
|
|
613
|
+
declare function isRowSelected<TGenerics extends TableGenerics>(row: Row<TGenerics>, selection: Record<string, boolean>, instance: TableInstance<TGenerics>): boolean | 'some';
|
|
614
|
+
|
|
615
|
+
declare type CoreRow<TGenerics extends TableGenerics> = {
|
|
616
|
+
id: string;
|
|
617
|
+
index: number;
|
|
618
|
+
original?: TGenerics['Row'];
|
|
619
|
+
depth: number;
|
|
620
|
+
_valuesCache: Record<string, any>;
|
|
621
|
+
getValue: (columnId: string) => any;
|
|
622
|
+
subRows: Row<TGenerics>[];
|
|
623
|
+
getLeafRows: () => Row<TGenerics>[];
|
|
624
|
+
originalSubRows?: TGenerics['Row'][];
|
|
625
|
+
getAllCells: () => Cell<TGenerics>[];
|
|
626
|
+
_getAllCellsByColumnId: () => Record<string, Cell<TGenerics>>;
|
|
627
|
+
};
|
|
628
|
+
declare const createRow: <TGenerics extends TableGenerics>(instance: TableInstance<TGenerics>, id: string, original: TGenerics["Row"] | undefined, rowIndex: number, depth: number, subRows?: Row<TGenerics>[] | undefined) => Row<TGenerics>;
|
|
629
|
+
|
|
630
|
+
declare type CoreCell<TGenerics extends TableGenerics> = {
|
|
631
|
+
id: string;
|
|
632
|
+
getValue: () => TGenerics['Value'];
|
|
633
|
+
row: Row<TGenerics>;
|
|
634
|
+
column: Column<TGenerics>;
|
|
635
|
+
renderCell: () => string | null | TGenerics['Rendered'];
|
|
636
|
+
};
|
|
637
|
+
|
|
638
|
+
declare type Updater<T> = T | ((old: T) => T);
|
|
639
|
+
declare type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void;
|
|
640
|
+
declare type TableGenerics = {
|
|
641
|
+
Row?: any;
|
|
642
|
+
Value?: any;
|
|
643
|
+
FilterFns?: any;
|
|
644
|
+
SortingFns?: any;
|
|
645
|
+
AggregationFns?: any;
|
|
646
|
+
Renderer?: any;
|
|
647
|
+
Rendered?: any;
|
|
648
|
+
ColumnMeta?: any;
|
|
649
|
+
TableMeta?: any;
|
|
650
|
+
FilterMeta?: any;
|
|
651
|
+
};
|
|
652
|
+
declare type AnyRender = (Comp: any, props: any) => any;
|
|
653
|
+
declare type TableInstance<TGenerics extends TableGenerics> = CoreInstance<TGenerics> & HeadersInstance<TGenerics> & VisibilityInstance<TGenerics> & ColumnOrderInstance<TGenerics> & ColumnPinningInstance<TGenerics> & FiltersInstance<TGenerics> & SortingInstance<TGenerics> & GroupingInstance<TGenerics> & ColumnSizingInstance<TGenerics> & ExpandedInstance<TGenerics> & PaginationInstance<TGenerics> & RowSelectionInstance<TGenerics>;
|
|
654
|
+
declare type TableOptionsResolved<TGenerics extends TableGenerics> = CoreOptions<TGenerics> & VisibilityOptions & ColumnOrderOptions & ColumnPinningOptions & FiltersOptions<TGenerics> & SortingOptions<TGenerics> & GroupingOptions<TGenerics> & ExpandedOptions<TGenerics> & ColumnSizingOptions & PaginationOptions<TGenerics> & RowSelectionOptions<TGenerics>;
|
|
655
|
+
declare type TableOptions<TGenerics extends TableGenerics> = Omit<PartialKeys<TableOptionsResolved<TGenerics>, 'state' | 'onStateChange'>, 'render' | 'renderFallbackValue'>;
|
|
656
|
+
declare type TableState = CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationTableState & RowSelectionTableState;
|
|
657
|
+
declare type InitialTableState = Partial<CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationInitialTableState & RowSelectionTableState>;
|
|
658
|
+
declare type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> & VisibilityRow<TGenerics> & ColumnPinningRow<TGenerics> & FiltersRow<TGenerics> & GroupingRow & RowSelectionRow & ExpandedRow;
|
|
659
|
+
declare type RowValues = {
|
|
660
|
+
[key: string]: any;
|
|
661
|
+
};
|
|
662
|
+
declare type RowModel<TGenerics extends TableGenerics> = {
|
|
663
|
+
rows: Row<TGenerics>[];
|
|
664
|
+
flatRows: Row<TGenerics>[];
|
|
665
|
+
rowsById: Record<string, Row<TGenerics>>;
|
|
666
|
+
};
|
|
667
|
+
declare type AccessorFn<TData> = (originalRow: TData, index: number) => any;
|
|
668
|
+
declare type Renderable<TGenerics extends TableGenerics, TProps> = string | ((props: TProps) => TGenerics['Rendered']);
|
|
669
|
+
declare type ColumnDef<TGenerics extends TableGenerics> = CoreColumnDef<TGenerics> & VisibilityColumnDef & ColumnPinningColumnDef & FiltersColumnDef<TGenerics> & SortingColumnDef<TGenerics> & GroupingColumnDef<TGenerics> & ColumnSizingColumnDef;
|
|
670
|
+
declare type Column<TGenerics extends TableGenerics> = CoreColumn<TGenerics> & VisibilityColumn & ColumnPinningColumn & FiltersColumn<TGenerics> & SortingColumn<TGenerics> & GroupingColumn<TGenerics> & ColumnSizingColumn<TGenerics>;
|
|
671
|
+
declare type Cell<TGenerics extends TableGenerics> = CoreCell<TGenerics> & GroupingCell<TGenerics>;
|
|
672
|
+
declare type Header<TGenerics extends TableGenerics> = CoreHeader<TGenerics> & ColumnSizingHeader<TGenerics>;
|
|
673
|
+
declare type HeaderGroup<TGenerics extends TableGenerics> = CoreHeaderGroup<TGenerics>;
|
|
674
|
+
declare type NoInfer<A extends any> = [A][A extends any ? 0 : never];
|
|
675
|
+
|
|
676
|
+
declare type PartialKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
677
|
+
declare type RequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
|
|
678
|
+
declare type Overwrite<T, U extends {
|
|
679
|
+
[TKey in keyof T]?: any;
|
|
680
|
+
}> = Omit<T, keyof U> & U;
|
|
681
|
+
declare type IfDefined<T, N> = 0 extends 1 & T ? N : T extends {} ? T : N;
|
|
682
|
+
declare function functionalUpdate<T>(updater: Updater<T>, input: T): T;
|
|
683
|
+
declare function noop(): void;
|
|
684
|
+
declare function makeStateUpdater(key: keyof TableState, instance: unknown): (updater: Updater<any>) => void;
|
|
685
|
+
declare type AnyFunction = (...args: any) => any;
|
|
686
|
+
declare function isFunction<T extends AnyFunction>(d: any): d is T;
|
|
687
|
+
declare function flattenBy<TNode>(arr: TNode[], getChildren: (item: TNode) => TNode[]): TNode[];
|
|
688
|
+
declare function memo<TDeps extends readonly any[], TResult>(getDeps: () => [...TDeps], fn: (...args: NoInfer<[...TDeps]>) => TResult, opts: {
|
|
689
|
+
key: any;
|
|
690
|
+
debug?: () => any;
|
|
691
|
+
onChange?: (result: TResult) => void;
|
|
692
|
+
}): () => TResult;
|
|
693
|
+
|
|
694
|
+
declare type TableFeature = {
|
|
695
|
+
getDefaultOptions?: (instance: any) => any;
|
|
696
|
+
getInitialState?: (initialState?: InitialTableState) => any;
|
|
697
|
+
createInstance?: (instance: any) => any;
|
|
698
|
+
getDefaultColumnDef?: () => any;
|
|
699
|
+
createColumn?: (column: any, instance: any) => any;
|
|
700
|
+
createHeader?: (column: any, instance: any) => any;
|
|
701
|
+
createCell?: (cell: any, column: any, row: any, instance: any) => any;
|
|
702
|
+
createRow?: (row: any, instance: any) => any;
|
|
703
|
+
};
|
|
704
|
+
declare type CoreTableState = {};
|
|
705
|
+
declare type CoreOptions<TGenerics extends TableGenerics> = {
|
|
706
|
+
data: TGenerics['Row'][];
|
|
707
|
+
state: Partial<TableState>;
|
|
708
|
+
onStateChange: (updater: Updater<TableState>) => void;
|
|
709
|
+
render: TGenerics['Renderer'];
|
|
710
|
+
debugAll?: boolean;
|
|
711
|
+
debugTable?: boolean;
|
|
712
|
+
debugHeaders?: boolean;
|
|
713
|
+
debugColumns?: boolean;
|
|
714
|
+
debugRows?: boolean;
|
|
715
|
+
initialState?: InitialTableState;
|
|
716
|
+
autoResetAll?: boolean;
|
|
717
|
+
mergeOptions?: (defaultOptions: TableOptions<TGenerics>, options: Partial<TableOptions<TGenerics>>) => TableOptions<TGenerics>;
|
|
718
|
+
meta?: TGenerics['TableMeta'];
|
|
719
|
+
getCoreRowModel: (instance: TableInstance<any>) => () => RowModel<any>;
|
|
720
|
+
getSubRows?: (originalRow: TGenerics['Row'], index: number) => undefined | TGenerics['Row'][];
|
|
721
|
+
getRowId?: (originalRow: TGenerics['Row'], index: number, parent?: Row<TGenerics>) => string;
|
|
722
|
+
columns: ColumnDef<TGenerics>[];
|
|
723
|
+
defaultColumn?: Partial<ColumnDef<TGenerics>>;
|
|
724
|
+
renderFallbackValue: any;
|
|
725
|
+
};
|
|
726
|
+
declare type CoreInstance<TGenerics extends TableGenerics> = {
|
|
727
|
+
initialState: TableState;
|
|
728
|
+
reset: () => void;
|
|
729
|
+
options: RequiredKeys<TableOptionsResolved<TGenerics>, 'state'>;
|
|
730
|
+
setOptions: (newOptions: Updater<TableOptionsResolved<TGenerics>>) => void;
|
|
731
|
+
getState: () => TableState;
|
|
732
|
+
setState: (updater: Updater<TableState>) => void;
|
|
733
|
+
_features: readonly TableFeature[];
|
|
734
|
+
_queue: (cb: () => void) => void;
|
|
735
|
+
_render: <TProps>(template: Renderable<TGenerics, TProps>, props: TProps) => string | null | TGenerics['Rendered'];
|
|
736
|
+
_getRowId: (_: TGenerics['Row'], index: number, parent?: Row<TGenerics>) => string;
|
|
737
|
+
getCoreRowModel: () => RowModel<TGenerics>;
|
|
738
|
+
_getCoreRowModel?: () => RowModel<TGenerics>;
|
|
739
|
+
getRowModel: () => RowModel<TGenerics>;
|
|
740
|
+
getRow: (id: string) => Row<TGenerics>;
|
|
741
|
+
_getDefaultColumnDef: () => Partial<ColumnDef<TGenerics>>;
|
|
742
|
+
_getColumnDefs: () => ColumnDef<TGenerics>[];
|
|
743
|
+
_getAllFlatColumnsById: () => Record<string, Column<TGenerics>>;
|
|
744
|
+
getAllColumns: () => Column<TGenerics>[];
|
|
745
|
+
getAllFlatColumns: () => Column<TGenerics>[];
|
|
746
|
+
getAllLeafColumns: () => Column<TGenerics>[];
|
|
747
|
+
getColumn: (columnId: string) => Column<TGenerics>;
|
|
748
|
+
};
|
|
749
|
+
declare function createTableInstance<TGenerics extends TableGenerics>(options: TableOptionsResolved<TGenerics>): TableInstance<TGenerics>;
|
|
750
|
+
|
|
751
|
+
declare type TableFactory<TGenerics extends TableGenerics> = () => Table<TGenerics>;
|
|
752
|
+
declare type CreateTableOptions<TRender extends AnyRender, TFilterFns extends CustomFilterFns<any>, TSortingFns extends CustomSortingFns<any>, TAggregationFns extends CustomAggregationFns<any>, TGenerics extends TableGenerics> = Partial<{
|
|
753
|
+
render?: TRender;
|
|
754
|
+
filterFns?: TFilterFns;
|
|
755
|
+
sortingFns?: TSortingFns;
|
|
756
|
+
aggregationFns?: TAggregationFns;
|
|
757
|
+
} & Omit<TableOptionsResolved<TGenerics>, 'filterFns' | 'sortingFns' | 'aggregationFns'>>;
|
|
758
|
+
declare type Table<TGenerics extends TableGenerics> = {
|
|
759
|
+
generics: TGenerics;
|
|
760
|
+
options: Partial<TableOptionsResolved<TGenerics>>;
|
|
761
|
+
setRowType: <TRow>() => Table<Overwrite<TGenerics, {
|
|
762
|
+
Row: TRow;
|
|
763
|
+
}>>;
|
|
764
|
+
setTableMetaType: <TTableMeta>() => Table<Overwrite<TGenerics, {
|
|
765
|
+
TableMeta: TTableMeta;
|
|
766
|
+
}>>;
|
|
767
|
+
setColumnMetaType: <TColumnMeta>() => Table<Overwrite<TGenerics, {
|
|
768
|
+
ColumnMeta: TColumnMeta;
|
|
769
|
+
}>>;
|
|
770
|
+
setFilterMetaType: <TFilterMeta>() => Table<Overwrite<TGenerics, {
|
|
771
|
+
FilterMeta: TFilterMeta;
|
|
772
|
+
}>>;
|
|
773
|
+
setOptions: <TFilterFns extends Record<string, FilterFn<any>>, TSortingFns extends Record<string, SortingFn<any>>, TAggregationFns extends Record<string, AggregationFn<any>>>(options: CreateTableOptions<any, TFilterFns, TSortingFns, TAggregationFns, TGenerics>) => Table<Overwrite<TGenerics, {
|
|
774
|
+
FilterFns: IfDefined<TFilterFns, TGenerics['FilterFns']>;
|
|
775
|
+
SortingFns: IfDefined<TSortingFns, TGenerics['SortingFns']>;
|
|
776
|
+
AggregationFns: IfDefined<TAggregationFns, TGenerics['AggregationFns']>;
|
|
777
|
+
}>>;
|
|
778
|
+
createGroup: (column: Overwrite<Overwrite<ColumnDef<any>, {
|
|
779
|
+
header: string;
|
|
780
|
+
id?: string;
|
|
781
|
+
}> | Overwrite<ColumnDef<any>, {
|
|
782
|
+
id: string;
|
|
783
|
+
header?: string | ((...any: any) => any);
|
|
784
|
+
}>, {
|
|
785
|
+
accessorFn?: never;
|
|
786
|
+
accessorKey?: never;
|
|
787
|
+
columns?: ColumnDef<any>[];
|
|
788
|
+
}>) => ColumnDef<TGenerics>;
|
|
789
|
+
createDisplayColumn: (column: Omit<ColumnDef<TGenerics>, 'columns'>) => ColumnDef<TGenerics>;
|
|
790
|
+
createDataColumn: <TAccessor extends AccessorFn<TGenerics['Row']> | keyof TGenerics['Row']>(accessor: TAccessor, column: Overwrite<TAccessor extends (...args: any[]) => any ? ColumnDef<Overwrite<TGenerics, {
|
|
791
|
+
Value: ReturnType<TAccessor>;
|
|
792
|
+
}>> : TAccessor extends keyof TGenerics['Row'] ? Overwrite<ColumnDef<Overwrite<TGenerics, {
|
|
793
|
+
Value: TGenerics['Row'][TAccessor];
|
|
794
|
+
}>>, {
|
|
795
|
+
id?: string;
|
|
796
|
+
}> : never, {
|
|
797
|
+
accessorFn?: never;
|
|
798
|
+
accessorKey?: never;
|
|
799
|
+
columns?: ColumnDef<any>[];
|
|
800
|
+
}>) => ColumnDef<TGenerics>;
|
|
801
|
+
createOptions: (options: TableOptions<TGenerics>) => TableOptions<TGenerics>;
|
|
802
|
+
};
|
|
803
|
+
declare function createTableFactory<TRenderer extends AnyRender>(opts: {
|
|
804
|
+
render: TRenderer;
|
|
805
|
+
}): () => Table<{
|
|
806
|
+
Renderer: TRenderer;
|
|
807
|
+
Rendered: ReturnType<TRenderer>;
|
|
808
|
+
}>;
|
|
809
|
+
|
|
810
|
+
declare function getCoreRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
|
|
811
|
+
|
|
812
|
+
declare function getFilteredRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
|
|
813
|
+
|
|
814
|
+
declare function getFacetedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>, columnId: string) => () => RowModel<TGenerics>;
|
|
815
|
+
|
|
816
|
+
declare function getFacetedUniqueValues<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>, columnId: string) => () => Map<any, number>;
|
|
817
|
+
|
|
818
|
+
declare function getFacetedMinMaxValues<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>, columnId: string) => () => undefined | [number, number];
|
|
819
|
+
|
|
820
|
+
declare function getSortedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
|
|
821
|
+
|
|
822
|
+
declare function getGroupedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
|
|
823
|
+
|
|
824
|
+
declare function getExpandedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
|
|
825
|
+
declare function expandRows<TGenerics extends TableGenerics>(rowModel: RowModel<TGenerics>, instance: TableInstance<TGenerics>): {
|
|
826
|
+
rows: Row<TGenerics>[];
|
|
827
|
+
flatRows: Row<TGenerics>[];
|
|
828
|
+
rowsById: Record<string, Row<TGenerics>>;
|
|
829
|
+
};
|
|
830
|
+
|
|
831
|
+
declare function getPaginationRowModel<TGenerics extends TableGenerics>(opts?: {
|
|
832
|
+
initialSync: boolean;
|
|
833
|
+
}): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
|
|
834
|
+
|
|
835
|
+
export { AccessorFn, AggregationFn, AggregationFnOption, AnyRender, BuiltInAggregationFn, BuiltInFilterFn, BuiltInSortingFn, Cell, Column, ColumnDef, ColumnDefaultOptions, ColumnFilter, ColumnFilterAutoRemoveTestFn, ColumnFiltersState, ColumnOrderDefaultOptions, ColumnOrderInstance, ColumnOrderOptions, ColumnOrderState, ColumnOrderTableState, ColumnPinningColumn, ColumnPinningColumnDef, ColumnPinningDefaultOptions, ColumnPinningInstance, ColumnPinningOptions, ColumnPinningPosition, ColumnPinningRow, ColumnPinningState, ColumnPinningTableState, ColumnResizeMode, ColumnSizing, ColumnSizingColumn, ColumnSizingColumnDef, ColumnSizingDefaultOptions, ColumnSizingHeader, ColumnSizingInfoState, ColumnSizingInstance, ColumnSizingOptions, ColumnSizingState, ColumnSizingTableState, ColumnSort, CoreColumn, CoreColumnDef, CoreColumnDefType, CoreHeader, CoreHeaderGroup, CoreInstance, CoreOptions, CoreRow, CoreTableState, CreateTableOptions, CustomAggregationFns, CustomFilterFns, CustomSortingFns, ExpandedInstance, ExpandedOptions, ExpandedRow, ExpandedState, ExpandedStateList, ExpandedTableState, Expanding, FilterFn, FilterFnOption, Filters, FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersRow, FiltersTableState, Grouping, GroupingCell, GroupingColumn, GroupingColumnDef, GroupingColumnMode, GroupingInstance, GroupingOptions, GroupingRow, GroupingState, GroupingTableState, Header, HeaderGroup, Headers, HeadersInstance, IfDefined, InitialTableState, NoInfer, OnChangeFn, Ordering, Overwrite, Pagination, PaginationDefaultOptions, PaginationInitialTableState, PaginationInstance, PaginationOptions, PaginationState, PaginationTableState, PartialKeys, Pinning, Renderable, RequiredKeys, ResolvedColumnFilter, Row, RowModel, RowSelection, RowSelectionInstance, RowSelectionOptions, RowSelectionRow, RowSelectionState, RowSelectionTableState, RowValues, SortDirection, Sorting, SortingColumn, SortingColumnDef, SortingFn, SortingFnOption, SortingInstance, SortingOptions, SortingState, SortingTableState, Table, TableFactory, TableFeature, TableGenerics, TableInstance, TableOptions, TableOptionsResolved, TableState, TransformFilterValueFn, Updater, Visibility, VisibilityColumn, VisibilityColumnDef, VisibilityDefaultOptions, VisibilityInstance, VisibilityOptions, VisibilityRow, VisibilityState, VisibilityTableState, aggregationFns, buildHeaderGroups, createColumn, createRow, createTableFactory, createTableInstance, defaultColumnSizing, expandRows, filterFns, flattenBy, functionalUpdate, getCoreRowModel, getExpandedRowModel, getFacetedMinMaxValues, getFacetedRowModel, getFacetedUniqueValues, getFilteredRowModel, getGroupedRowModel, getPaginationRowModel, getSortedRowModel, isFunction, isRowSelected, makeStateUpdater, memo, noop, orderColumns, passiveEventSupported, reSplitAlphaNumeric, selectRowsFn, shouldAutoRemoveFilter, sortingFns };
|