@tanstack/table-core 8.0.12 → 8.1.0

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.
Files changed (127) hide show
  1. package/build/cjs/core/cell.js +13 -13
  2. package/build/cjs/core/cell.js.map +1 -1
  3. package/build/cjs/core/column.js +20 -21
  4. package/build/cjs/core/column.js.map +1 -1
  5. package/build/cjs/core/headers.js +63 -68
  6. package/build/cjs/core/headers.js.map +1 -1
  7. package/build/cjs/core/row.js +16 -11
  8. package/build/cjs/core/row.js.map +1 -1
  9. package/build/cjs/core/{instance.js → table.js} +46 -57
  10. package/build/cjs/core/table.js.map +1 -0
  11. package/build/cjs/features/ColumnSizing.js +36 -36
  12. package/build/cjs/features/ColumnSizing.js.map +1 -1
  13. package/build/cjs/features/Expanding.js +34 -34
  14. package/build/cjs/features/Expanding.js.map +1 -1
  15. package/build/cjs/features/Filters.js +46 -52
  16. package/build/cjs/features/Filters.js.map +1 -1
  17. package/build/cjs/features/Grouping.js +24 -49
  18. package/build/cjs/features/Grouping.js.map +1 -1
  19. package/build/cjs/features/Ordering.js +8 -8
  20. package/build/cjs/features/Ordering.js.map +1 -1
  21. package/build/cjs/features/Pagination.js +37 -37
  22. package/build/cjs/features/Pagination.js.map +1 -1
  23. package/build/cjs/features/Pinning.js +33 -33
  24. package/build/cjs/features/Pinning.js.map +1 -1
  25. package/build/cjs/features/RowSelection.js +86 -74
  26. package/build/cjs/features/RowSelection.js.map +1 -1
  27. package/build/cjs/features/Sorting.js +36 -40
  28. package/build/cjs/features/Sorting.js.map +1 -1
  29. package/build/cjs/features/Visibility.js +30 -30
  30. package/build/cjs/features/Visibility.js.map +1 -1
  31. package/build/cjs/index.js +3 -4
  32. package/build/cjs/index.js.map +1 -1
  33. package/build/cjs/utils/filterRowsUtils.js +8 -8
  34. package/build/cjs/utils/filterRowsUtils.js.map +1 -1
  35. package/build/cjs/utils/getCoreRowModel.js +8 -8
  36. package/build/cjs/utils/getCoreRowModel.js.map +1 -1
  37. package/build/cjs/utils/getExpandedRowModel.js +4 -4
  38. package/build/cjs/utils/getExpandedRowModel.js.map +1 -1
  39. package/build/cjs/utils/getFacetedMinMaxValues.js +3 -3
  40. package/build/cjs/utils/getFacetedMinMaxValues.js.map +1 -1
  41. package/build/cjs/utils/getFacetedRowModel.js +4 -4
  42. package/build/cjs/utils/getFacetedRowModel.js.map +1 -1
  43. package/build/cjs/utils/getFacetedUniqueValues.js +3 -3
  44. package/build/cjs/utils/getFacetedUniqueValues.js.map +1 -1
  45. package/build/cjs/utils/getFilteredRowModel.js +8 -8
  46. package/build/cjs/utils/getFilteredRowModel.js.map +1 -1
  47. package/build/cjs/utils/getGroupedRowModel.js +9 -9
  48. package/build/cjs/utils/getGroupedRowModel.js.map +1 -1
  49. package/build/cjs/utils/getPaginationRowModel.js +4 -4
  50. package/build/cjs/utils/getPaginationRowModel.js.map +1 -1
  51. package/build/cjs/utils/getSortedRowModel.js +7 -7
  52. package/build/cjs/utils/getSortedRowModel.js.map +1 -1
  53. package/build/cjs/utils.js +2 -2
  54. package/build/cjs/utils.js.map +1 -1
  55. package/build/esm/index.js +585 -677
  56. package/build/esm/index.js.map +1 -1
  57. package/build/stats-html.html +1 -1
  58. package/build/stats-react.json +352 -377
  59. package/build/types/index.d.ts +761 -29
  60. package/build/umd/index.development.js +586 -678
  61. package/build/umd/index.development.js.map +1 -1
  62. package/build/umd/index.production.js +1 -1
  63. package/build/umd/index.production.js.map +1 -1
  64. package/package.json +1 -1
  65. package/src/core/cell.ts +34 -28
  66. package/src/core/column.ts +83 -72
  67. package/src/core/headers.ts +118 -149
  68. package/src/core/row.ts +31 -25
  69. package/src/core/{instance.ts → table.ts} +85 -116
  70. package/src/features/ColumnSizing.ts +45 -47
  71. package/src/features/Expanding.ts +53 -59
  72. package/src/features/Filters.ts +112 -132
  73. package/src/features/Grouping.ts +63 -112
  74. package/src/features/Ordering.ts +19 -21
  75. package/src/features/Pagination.ts +54 -55
  76. package/src/features/Pinning.ts +49 -61
  77. package/src/features/RowSelection.ts +115 -114
  78. package/src/features/Sorting.ts +57 -72
  79. package/src/features/Visibility.ts +48 -48
  80. package/src/index.ts +1 -2
  81. package/src/types.ts +64 -69
  82. package/src/utils/filterRowsUtils.ts +33 -28
  83. package/src/utils/getCoreRowModel.ts +22 -22
  84. package/src/utils/getExpandedRowModel.ts +15 -15
  85. package/src/utils/getFacetedMinMaxValues.ts +6 -6
  86. package/src/utils/getFacetedRowModel.ts +12 -12
  87. package/src/utils/getFacetedUniqueValues.ts +6 -6
  88. package/src/utils/getFilteredRowModel.ts +17 -17
  89. package/src/utils/getGroupedRowModel.ts +18 -21
  90. package/src/utils/getPaginationRowModel.ts +10 -13
  91. package/src/utils/getSortedRowModel.ts +14 -14
  92. package/src/utils.ts +8 -2
  93. package/build/cjs/core/instance.js.map +0 -1
  94. package/build/cjs/createTable.js +0 -72
  95. package/build/cjs/createTable.js.map +0 -1
  96. package/build/types/aggregationFns.d.ts +0 -13
  97. package/build/types/core/cell.d.ts +0 -9
  98. package/build/types/core/column.d.ts +0 -40
  99. package/build/types/core/headers.d.ts +0 -46
  100. package/build/types/core/instance.d.ts +0 -58
  101. package/build/types/core/row.d.ts +0 -15
  102. package/build/types/createTable.d.ts +0 -63
  103. package/build/types/features/ColumnSizing.d.ts +0 -63
  104. package/build/types/features/Expanding.d.ts +0 -39
  105. package/build/types/features/Filters.d.ts +0 -90
  106. package/build/types/features/Grouping.d.ts +0 -68
  107. package/build/types/features/Ordering.d.ts +0 -18
  108. package/build/types/features/Pagination.d.ts +0 -42
  109. package/build/types/features/Pinning.d.ts +0 -40
  110. package/build/types/features/RowSelection.d.ts +0 -40
  111. package/build/types/features/Sorting.d.ts +0 -63
  112. package/build/types/features/Visibility.d.ts +0 -40
  113. package/build/types/filterFns.d.ts +0 -13
  114. package/build/types/sortingFns.d.ts +0 -11
  115. package/build/types/types.d.ts +0 -53
  116. package/build/types/utils/filterRowsUtils.d.ts +0 -4
  117. package/build/types/utils/getCoreRowModel.d.ts +0 -2
  118. package/build/types/utils/getExpandedRowModel.d.ts +0 -7
  119. package/build/types/utils/getFacetedMinMaxValues.d.ts +0 -2
  120. package/build/types/utils/getFacetedRowModel.d.ts +0 -2
  121. package/build/types/utils/getFacetedUniqueValues.d.ts +0 -2
  122. package/build/types/utils/getFilteredRowModel.d.ts +0 -2
  123. package/build/types/utils/getGroupedRowModel.d.ts +0 -2
  124. package/build/types/utils/getPaginationRowModel.d.ts +0 -4
  125. package/build/types/utils/getSortedRowModel.d.ts +0 -2
  126. package/build/types/utils.d.ts +0 -19
  127. package/src/createTable.ts +0 -188
@@ -1,63 +0,0 @@
1
- import { TableFeature } from '../core/instance';
2
- import { OnChangeFn, TableGenerics, Updater } from '../types';
3
- import { ColumnPinningPosition } from './Pinning';
4
- export declare type ColumnSizingTableState = {
5
- columnSizing: ColumnSizingState;
6
- columnSizingInfo: ColumnSizingInfoState;
7
- };
8
- export declare type ColumnSizingState = Record<string, number>;
9
- export declare type ColumnSizingInfoState = {
10
- startOffset: null | number;
11
- startSize: null | number;
12
- deltaOffset: null | number;
13
- deltaPercentage: null | number;
14
- isResizingColumn: false | string;
15
- columnSizingStart: [string, number][];
16
- };
17
- export declare type ColumnResizeMode = 'onChange' | 'onEnd';
18
- export declare type ColumnSizingOptions = {
19
- enableColumnResizing?: boolean;
20
- columnResizeMode?: ColumnResizeMode;
21
- onColumnSizingChange?: OnChangeFn<ColumnSizingState>;
22
- onColumnSizingInfoChange?: OnChangeFn<ColumnSizingInfoState>;
23
- };
24
- export declare type ColumnSizingDefaultOptions = {
25
- columnResizeMode: ColumnResizeMode;
26
- onColumnSizingChange: OnChangeFn<ColumnSizingState>;
27
- onColumnSizingInfoChange: OnChangeFn<ColumnSizingInfoState>;
28
- };
29
- export declare type ColumnSizingInstance<TGenerics extends TableGenerics> = {
30
- setColumnSizing: (updater: Updater<ColumnSizingState>) => void;
31
- setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void;
32
- resetColumnSizing: (defaultState?: boolean) => void;
33
- resetHeaderSizeInfo: (defaultState?: boolean) => void;
34
- getTotalSize: () => number;
35
- getLeftTotalSize: () => number;
36
- getCenterTotalSize: () => number;
37
- getRightTotalSize: () => number;
38
- };
39
- export declare type ColumnSizingColumnDef = {
40
- enableResizing?: boolean;
41
- size?: number;
42
- minSize?: number;
43
- maxSize?: number;
44
- };
45
- export declare type ColumnSizingColumn<TGenerics extends TableGenerics> = {
46
- getSize: () => number;
47
- getStart: (position?: ColumnPinningPosition) => number;
48
- getCanResize: () => boolean;
49
- getIsResizing: () => boolean;
50
- resetSize: () => void;
51
- };
52
- export declare type ColumnSizingHeader<TGenerics extends TableGenerics> = {
53
- getSize: () => number;
54
- getStart: (position?: ColumnPinningPosition) => number;
55
- getResizeHandler: () => (event: unknown) => void;
56
- };
57
- export declare const defaultColumnSizing: {
58
- size: number;
59
- minSize: number;
60
- maxSize: number;
61
- };
62
- export declare const ColumnSizing: TableFeature;
63
- export declare function passiveEventSupported(): boolean;
@@ -1,39 +0,0 @@
1
- import { RowModel } from '..';
2
- import { TableFeature } from '../core/instance';
3
- import { OnChangeFn, TableGenerics, TableInstance, Row, Updater } from '../types';
4
- export declare type ExpandedStateList = Record<string, boolean>;
5
- export declare type ExpandedState = true | Record<string, boolean>;
6
- export declare type ExpandedTableState = {
7
- expanded: ExpandedState;
8
- };
9
- export declare type ExpandedRow = {
10
- toggleExpanded: (expanded?: boolean) => void;
11
- getIsExpanded: () => boolean;
12
- getCanExpand: () => boolean;
13
- getToggleExpandedHandler: () => () => void;
14
- };
15
- export declare type ExpandedOptions<TGenerics extends TableGenerics> = {
16
- manualExpanding?: boolean;
17
- onExpandedChange?: OnChangeFn<ExpandedState>;
18
- autoResetExpanded?: boolean;
19
- enableExpanding?: boolean;
20
- getExpandedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
21
- getIsRowExpanded?: (row: Row<TGenerics>) => boolean;
22
- getRowCanExpand?: (row: Row<TGenerics>) => boolean;
23
- paginateExpandedRows?: boolean;
24
- };
25
- export declare type ExpandedInstance<TGenerics extends TableGenerics> = {
26
- _autoResetExpanded: () => void;
27
- setExpanded: (updater: Updater<ExpandedState>) => void;
28
- toggleAllRowsExpanded: (expanded?: boolean) => void;
29
- resetExpanded: (defaultState?: boolean) => void;
30
- getCanSomeRowsExpand: () => boolean;
31
- getToggleAllRowsExpandedHandler: () => (event: unknown) => void;
32
- getIsSomeRowsExpanded: () => boolean;
33
- getIsAllRowsExpanded: () => boolean;
34
- getExpandedDepth: () => number;
35
- getExpandedRowModel: () => RowModel<TGenerics>;
36
- _getExpandedRowModel?: () => RowModel<TGenerics>;
37
- getPreExpandedRowModel: () => RowModel<TGenerics>;
38
- };
39
- export declare const Expanding: TableFeature;
@@ -1,90 +0,0 @@
1
- import { RowModel } from '..';
2
- import { TableFeature } from '../core/instance';
3
- import { BuiltInFilterFn } from '../filterFns';
4
- import { Column, OnChangeFn, TableGenerics, TableInstance, Row, Updater } from '../types';
5
- import { Overwrite } from '../utils';
6
- export declare type FiltersTableState = {
7
- columnFilters: ColumnFiltersState;
8
- globalFilter: any;
9
- };
10
- export declare type ColumnFiltersState = ColumnFilter[];
11
- export declare type ColumnFilter = {
12
- id: string;
13
- value: unknown;
14
- };
15
- export declare type ResolvedColumnFilter<TGenerics extends TableGenerics> = {
16
- id: string;
17
- resolvedValue: unknown;
18
- filterFn: FilterFn<TGenerics>;
19
- };
20
- export declare type FilterFn<TGenerics extends TableGenerics> = {
21
- (row: Row<TGenerics>, columnId: string, filterValue: any, addMeta: (meta: TGenerics['FilterMeta']) => void): boolean;
22
- resolveFilterValue?: TransformFilterValueFn<TGenerics>;
23
- autoRemove?: ColumnFilterAutoRemoveTestFn<TGenerics>;
24
- };
25
- export declare type TransformFilterValueFn<TGenerics extends TableGenerics> = (value: any, column?: Column<TGenerics>) => unknown;
26
- export declare type ColumnFilterAutoRemoveTestFn<TGenerics extends TableGenerics> = (value: any, column?: Column<TGenerics>) => boolean;
27
- export declare type CustomFilterFns<TGenerics extends TableGenerics> = Record<string, FilterFn<TGenerics>>;
28
- export declare type FilterFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInFilterFn | keyof TGenerics['FilterFns'] | FilterFn<TGenerics>;
29
- export declare type FiltersColumnDef<TGenerics extends TableGenerics> = {
30
- filterFn?: FilterFnOption<Overwrite<TGenerics, {
31
- Value: any;
32
- }>>;
33
- enableColumnFilter?: boolean;
34
- enableGlobalFilter?: boolean;
35
- };
36
- export declare type FiltersColumn<TGenerics extends TableGenerics> = {
37
- getAutoFilterFn: () => FilterFn<TGenerics> | undefined;
38
- getFilterFn: () => FilterFn<TGenerics> | undefined;
39
- setFilterValue: (updater: Updater<any>) => void;
40
- getCanFilter: () => boolean;
41
- getCanGlobalFilter: () => boolean;
42
- getFacetedRowModel: () => RowModel<TGenerics>;
43
- _getFacetedRowModel?: () => RowModel<TGenerics>;
44
- getIsFiltered: () => boolean;
45
- getFilterValue: () => unknown;
46
- getFilterIndex: () => number;
47
- getFacetedUniqueValues: () => Map<any, number>;
48
- _getFacetedUniqueValues?: () => Map<any, number>;
49
- getFacetedMinMaxValues: () => undefined | [number, number];
50
- _getFacetedMinMaxValues?: () => undefined | [number, number];
51
- };
52
- export declare type FiltersRow<TGenerics extends TableGenerics> = {
53
- columnFilters: Record<string, boolean>;
54
- columnFiltersMeta: Record<string, TGenerics['FilterMeta']>;
55
- };
56
- export declare type FiltersOptions<TGenerics extends TableGenerics> = {
57
- enableFilters?: boolean;
58
- manualFiltering?: boolean;
59
- filterFromLeafRows?: boolean;
60
- filterFns?: TGenerics['FilterFns'];
61
- getFilteredRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
62
- onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>;
63
- enableColumnFilters?: boolean;
64
- globalFilterFn?: FilterFnOption<TGenerics>;
65
- onGlobalFilterChange?: OnChangeFn<any>;
66
- enableGlobalFilter?: boolean;
67
- getColumnCanGlobalFilter?: (column: Column<TGenerics>) => boolean;
68
- getFacetedRowModel?: (instance: TableInstance<TGenerics>, columnId: string) => () => RowModel<TGenerics>;
69
- getFacetedUniqueValues?: (instance: TableInstance<TGenerics>, columnId: string) => () => Map<any, number>;
70
- getFacetedMinMaxValues?: (instance: TableInstance<TGenerics>, columnId: string) => () => undefined | [number, number];
71
- };
72
- export declare type FiltersInstance<TGenerics extends TableGenerics> = {
73
- setColumnFilters: (updater: Updater<ColumnFiltersState>) => void;
74
- resetColumnFilters: (defaultState?: boolean) => void;
75
- getPreFilteredRowModel: () => RowModel<TGenerics>;
76
- getFilteredRowModel: () => RowModel<TGenerics>;
77
- _getFilteredRowModel?: () => RowModel<TGenerics>;
78
- setGlobalFilter: (updater: Updater<any>) => void;
79
- resetGlobalFilter: (defaultState?: boolean) => void;
80
- getGlobalAutoFilterFn: () => FilterFn<TGenerics> | undefined;
81
- getGlobalFilterFn: () => FilterFn<TGenerics> | undefined;
82
- getGlobalFacetedRowModel: () => RowModel<TGenerics>;
83
- _getGlobalFacetedRowModel?: () => RowModel<TGenerics>;
84
- getGlobalFacetedUniqueValues: () => Map<any, number>;
85
- _getGlobalFacetedUniqueValues?: () => Map<any, number>;
86
- getGlobalFacetedMinMaxValues: () => undefined | [number, number];
87
- _getGlobalFacetedMinMaxValues?: () => undefined | [number, number];
88
- };
89
- export declare const Filters: TableFeature;
90
- export declare function shouldAutoRemoveFilter<TGenerics extends TableGenerics>(filterFn?: FilterFn<TGenerics>, value?: any, column?: Column<TGenerics>): boolean;
@@ -1,68 +0,0 @@
1
- import { RowModel } from '..';
2
- import { BuiltInAggregationFn } from '../aggregationFns';
3
- import { TableFeature } from '../core/instance';
4
- import { Cell, Column, OnChangeFn, TableInstance, Row, Updater, Renderable, TableGenerics } from '../types';
5
- import { Overwrite } from '../utils';
6
- export declare type GroupingState = string[];
7
- export declare type GroupingTableState = {
8
- grouping: GroupingState;
9
- };
10
- export declare type AggregationFn<TGenerics extends TableGenerics> = (columnId: string, leafRows: Row<TGenerics>[], childRows: Row<TGenerics>[]) => any;
11
- export declare type CustomAggregationFns<TGenerics extends TableGenerics> = Record<string, AggregationFn<TGenerics>>;
12
- export declare type AggregationFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInAggregationFn | keyof TGenerics['AggregationFns'] | AggregationFn<TGenerics>;
13
- export declare type GroupingColumnDef<TGenerics extends TableGenerics> = {
14
- aggregationFn?: AggregationFnOption<Overwrite<TGenerics, {
15
- Value: any;
16
- }>>;
17
- aggregatedCell?: Renderable<TGenerics, {
18
- instance: TableInstance<TGenerics>;
19
- row: Row<TGenerics>;
20
- column: Column<TGenerics>;
21
- cell: Cell<TGenerics>;
22
- getValue: () => TGenerics['Value'];
23
- }>;
24
- enableGrouping?: boolean;
25
- };
26
- export declare type GroupingColumn<TGenerics extends TableGenerics> = {
27
- getCanGroup: () => boolean;
28
- getIsGrouped: () => boolean;
29
- getGroupedIndex: () => number;
30
- toggleGrouping: () => void;
31
- getToggleGroupingHandler: () => () => void;
32
- getAutoAggregationFn: () => AggregationFn<TGenerics> | undefined;
33
- getAggregationFn: () => AggregationFn<TGenerics> | undefined;
34
- };
35
- export declare type GroupingRow = {
36
- groupingColumnId?: string;
37
- groupingValue?: any;
38
- getIsGrouped: () => boolean;
39
- _groupingValuesCache: Record<string, any>;
40
- };
41
- export declare type GroupingCell<TGenerics extends TableGenerics> = {
42
- getIsGrouped: () => boolean;
43
- getIsPlaceholder: () => boolean;
44
- getIsAggregated: () => boolean;
45
- renderAggregatedCell: () => string | null | TGenerics['Rendered'];
46
- };
47
- export declare type ColumnDefaultOptions = {
48
- onGroupingChange: OnChangeFn<GroupingState>;
49
- enableGrouping: boolean;
50
- };
51
- export declare type GroupingOptions<TGenerics extends TableGenerics> = {
52
- manualGrouping?: boolean;
53
- aggregationFns?: TGenerics['AggregationFns'];
54
- onGroupingChange?: OnChangeFn<GroupingState>;
55
- enableGrouping?: boolean;
56
- getGroupedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
57
- groupedColumnMode?: false | 'reorder' | 'remove';
58
- };
59
- export declare type GroupingColumnMode = false | 'reorder' | 'remove';
60
- export declare type GroupingInstance<TGenerics extends TableGenerics> = {
61
- setGrouping: (updater: Updater<GroupingState>) => void;
62
- resetGrouping: (defaultState?: boolean) => void;
63
- getPreGroupedRowModel: () => RowModel<TGenerics>;
64
- getGroupedRowModel: () => RowModel<TGenerics>;
65
- _getGroupedRowModel?: () => RowModel<TGenerics>;
66
- };
67
- export declare const Grouping: TableFeature;
68
- export declare function orderColumns<TGenerics extends TableGenerics>(leafColumns: Column<TGenerics>[], grouping: string[], groupedColumnMode?: GroupingColumnMode): Column<TGenerics>[];
@@ -1,18 +0,0 @@
1
- import { OnChangeFn, Updater, Column, TableGenerics } from '../types';
2
- import { TableFeature } from '../core/instance';
3
- export declare type ColumnOrderTableState = {
4
- columnOrder: ColumnOrderState;
5
- };
6
- export declare type ColumnOrderState = string[];
7
- export declare type ColumnOrderOptions = {
8
- onColumnOrderChange?: OnChangeFn<ColumnOrderState>;
9
- };
10
- export declare type ColumnOrderDefaultOptions = {
11
- onColumnOrderChange: OnChangeFn<ColumnOrderState>;
12
- };
13
- export declare type ColumnOrderInstance<TGenerics extends TableGenerics> = {
14
- setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
15
- resetColumnOrder: (defaultState?: boolean) => void;
16
- _getOrderColumnsFn: () => (columns: Column<TGenerics>[]) => Column<TGenerics>[];
17
- };
18
- export declare const Ordering: TableFeature;
@@ -1,42 +0,0 @@
1
- import { TableFeature } from '../core/instance';
2
- import { OnChangeFn, TableGenerics, TableInstance, RowModel, Updater } from '../types';
3
- export declare type PaginationState = {
4
- pageIndex: number;
5
- pageSize: number;
6
- };
7
- export declare type PaginationTableState = {
8
- pagination: PaginationState;
9
- };
10
- export declare type PaginationInitialTableState = {
11
- pagination?: Partial<PaginationState>;
12
- };
13
- export declare type PaginationOptions<TGenerics extends TableGenerics> = {
14
- pageCount?: number;
15
- manualPagination?: boolean;
16
- onPaginationChange?: OnChangeFn<PaginationState>;
17
- autoResetPageIndex?: boolean;
18
- getPaginationRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
19
- };
20
- export declare type PaginationDefaultOptions = {
21
- onPaginationChange: OnChangeFn<PaginationState>;
22
- };
23
- export declare type PaginationInstance<TGenerics extends TableGenerics> = {
24
- _autoResetPageIndex: () => void;
25
- setPagination: (updater: Updater<PaginationState>) => void;
26
- resetPagination: (defaultState?: boolean) => void;
27
- setPageIndex: (updater: Updater<number>) => void;
28
- resetPageIndex: (defaultState?: boolean) => void;
29
- setPageSize: (updater: Updater<number>) => void;
30
- resetPageSize: (defaultState?: boolean) => void;
31
- setPageCount: (updater: Updater<number>) => void;
32
- getPageOptions: () => number[];
33
- getCanPreviousPage: () => boolean;
34
- getCanNextPage: () => boolean;
35
- previousPage: () => void;
36
- nextPage: () => void;
37
- getPrePaginationRowModel: () => RowModel<TGenerics>;
38
- getPaginationRowModel: () => RowModel<TGenerics>;
39
- _getPaginationRowModel?: () => RowModel<TGenerics>;
40
- getPageCount: () => number;
41
- };
42
- export declare const Pagination: TableFeature;
@@ -1,40 +0,0 @@
1
- import { TableFeature } from '../core/instance';
2
- import { OnChangeFn, Updater, Column, TableGenerics, Cell } from '../types';
3
- export declare type ColumnPinningPosition = false | 'left' | 'right';
4
- export declare type ColumnPinningState = {
5
- left?: string[];
6
- right?: string[];
7
- };
8
- export declare type ColumnPinningTableState = {
9
- columnPinning: ColumnPinningState;
10
- };
11
- export declare type ColumnPinningOptions = {
12
- onColumnPinningChange?: OnChangeFn<ColumnPinningState>;
13
- enablePinning?: boolean;
14
- };
15
- export declare type ColumnPinningDefaultOptions = {
16
- onColumnPinningChange: OnChangeFn<ColumnPinningState>;
17
- };
18
- export declare type ColumnPinningColumnDef = {
19
- enablePinning?: boolean;
20
- };
21
- export declare type ColumnPinningColumn = {
22
- getCanPin: () => boolean;
23
- getPinnedIndex: () => number;
24
- getIsPinned: () => ColumnPinningPosition;
25
- pin: (position: ColumnPinningPosition) => void;
26
- };
27
- export declare type ColumnPinningRow<TGenerics extends TableGenerics> = {
28
- getLeftVisibleCells: () => Cell<TGenerics>[];
29
- getCenterVisibleCells: () => Cell<TGenerics>[];
30
- getRightVisibleCells: () => Cell<TGenerics>[];
31
- };
32
- export declare type ColumnPinningInstance<TGenerics extends TableGenerics> = {
33
- setColumnPinning: (updater: Updater<ColumnPinningState>) => void;
34
- resetColumnPinning: (defaultState?: boolean) => void;
35
- getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean;
36
- getLeftLeafColumns: () => Column<TGenerics>[];
37
- getRightLeafColumns: () => Column<TGenerics>[];
38
- getCenterLeafColumns: () => Column<TGenerics>[];
39
- };
40
- export declare const Pinning: TableFeature;
@@ -1,40 +0,0 @@
1
- import { TableFeature } from '../core/instance';
2
- import { OnChangeFn, TableGenerics, TableInstance, Row, RowModel, Updater } from '../types';
3
- export declare type RowSelectionState = Record<string, boolean>;
4
- export declare type RowSelectionTableState = {
5
- rowSelection: RowSelectionState;
6
- };
7
- export declare type RowSelectionOptions<TGenerics extends TableGenerics> = {
8
- enableRowSelection?: boolean | ((row: Row<TGenerics>) => boolean);
9
- enableMultiRowSelection?: boolean | ((row: Row<TGenerics>) => boolean);
10
- enableSubRowSelection?: boolean | ((row: Row<TGenerics>) => boolean);
11
- onRowSelectionChange?: OnChangeFn<RowSelectionState>;
12
- };
13
- export declare type RowSelectionRow = {
14
- getIsSelected: () => boolean;
15
- getIsSomeSelected: () => boolean;
16
- getCanSelect: () => boolean;
17
- getCanMultiSelect: () => boolean;
18
- getCanSelectSubRows: () => boolean;
19
- toggleSelected: (value?: boolean) => void;
20
- getToggleSelectedHandler: () => (event: unknown) => void;
21
- };
22
- export declare type RowSelectionInstance<TGenerics extends TableGenerics> = {
23
- getToggleAllRowsSelectedHandler: () => (event: unknown) => void;
24
- getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void;
25
- setRowSelection: (updater: Updater<RowSelectionState>) => void;
26
- resetRowSelection: (defaultState?: boolean) => void;
27
- getIsAllRowsSelected: () => boolean;
28
- getIsAllPageRowsSelected: () => boolean;
29
- getIsSomeRowsSelected: () => boolean;
30
- getIsSomePageRowsSelected: () => boolean;
31
- toggleAllRowsSelected: (value?: boolean) => void;
32
- toggleAllPageRowsSelected: (value?: boolean) => void;
33
- getPreSelectedRowModel: () => RowModel<TGenerics>;
34
- getSelectedRowModel: () => RowModel<TGenerics>;
35
- getFilteredSelectedRowModel: () => RowModel<TGenerics>;
36
- getGroupedSelectedRowModel: () => RowModel<TGenerics>;
37
- };
38
- export declare const RowSelection: TableFeature;
39
- export declare function selectRowsFn<TGenerics extends TableGenerics>(instance: TableInstance<TGenerics>, rowModel: RowModel<TGenerics>): RowModel<TGenerics>;
40
- export declare function isRowSelected<TGenerics extends TableGenerics>(row: Row<TGenerics>, selection: Record<string, boolean>, instance: TableInstance<TGenerics>): boolean | 'some';
@@ -1,63 +0,0 @@
1
- import { RowModel } from '..';
2
- import { TableFeature } from '../core/instance';
3
- import { BuiltInSortingFn } from '../sortingFns';
4
- import { OnChangeFn, TableGenerics, TableInstance, Row, Updater } from '../types';
5
- import { Overwrite } from '../utils';
6
- export declare type SortDirection = 'asc' | 'desc';
7
- export declare type ColumnSort = {
8
- id: string;
9
- desc: boolean;
10
- };
11
- export declare type SortingState = ColumnSort[];
12
- export declare type SortingTableState = {
13
- sorting: SortingState;
14
- };
15
- export declare type SortingFn<TGenerics extends TableGenerics> = {
16
- (rowA: Row<TGenerics>, rowB: Row<TGenerics>, columnId: string): number;
17
- };
18
- export declare type CustomSortingFns<TGenerics extends TableGenerics> = Record<string, SortingFn<TGenerics>>;
19
- export declare type SortingFnOption<TGenerics extends TableGenerics> = 'auto' | BuiltInSortingFn | keyof TGenerics['SortingFns'] | SortingFn<TGenerics>;
20
- export declare type SortingColumnDef<TGenerics extends TableGenerics> = {
21
- sortingFn?: SortingFnOption<Overwrite<TGenerics, {
22
- Value: any;
23
- }>>;
24
- sortDescFirst?: boolean;
25
- enableSorting?: boolean;
26
- enableMultiSort?: boolean;
27
- invertSorting?: boolean;
28
- sortUndefined?: false | -1 | 1;
29
- };
30
- export declare type SortingColumn<TGenerics extends TableGenerics> = {
31
- getAutoSortingFn: () => SortingFn<TGenerics>;
32
- getAutoSortDir: () => SortDirection;
33
- getSortingFn: () => SortingFn<TGenerics>;
34
- getNextSortingOrder: () => SortDirection | false;
35
- getCanSort: () => boolean;
36
- getCanMultiSort: () => boolean;
37
- getSortIndex: () => number;
38
- getIsSorted: () => false | SortDirection;
39
- clearSorting: () => void;
40
- toggleSorting: (desc?: boolean, isMulti?: boolean) => void;
41
- getToggleSortingHandler: () => undefined | ((event: unknown) => void);
42
- };
43
- export declare type SortingOptions<TGenerics extends TableGenerics> = {
44
- manualSorting?: boolean;
45
- sortingFns?: TGenerics['SortingFns'];
46
- onSortingChange?: OnChangeFn<SortingState>;
47
- enableSorting?: boolean;
48
- enableSortingRemoval?: boolean;
49
- enableMultiRemove?: boolean;
50
- enableMultiSort?: boolean;
51
- sortDescFirst?: boolean;
52
- getSortedRowModel?: (instance: TableInstance<any>) => () => RowModel<any>;
53
- maxMultiSortColCount?: number;
54
- isMultiSortEvent?: (e: unknown) => boolean;
55
- };
56
- export declare type SortingInstance<TGenerics extends TableGenerics> = {
57
- setSorting: (updater: Updater<SortingState>) => void;
58
- resetSorting: (defaultState?: boolean) => void;
59
- getPreSortedRowModel: () => RowModel<TGenerics>;
60
- getSortedRowModel: () => RowModel<TGenerics>;
61
- _getSortedRowModel?: () => RowModel<TGenerics>;
62
- };
63
- export declare const Sorting: TableFeature;
@@ -1,40 +0,0 @@
1
- import { TableFeature } from '../core/instance';
2
- import { Cell, Column, OnChangeFn, TableGenerics, Updater } from '../types';
3
- export declare type VisibilityState = Record<string, boolean>;
4
- export declare type VisibilityTableState = {
5
- columnVisibility: VisibilityState;
6
- };
7
- export declare type VisibilityOptions = {
8
- onColumnVisibilityChange?: OnChangeFn<VisibilityState>;
9
- enableHiding?: boolean;
10
- };
11
- export declare type VisibilityDefaultOptions = {
12
- onColumnVisibilityChange: OnChangeFn<VisibilityState>;
13
- };
14
- export declare type VisibilityInstance<TGenerics extends TableGenerics> = {
15
- getVisibleFlatColumns: () => Column<TGenerics>[];
16
- getVisibleLeafColumns: () => Column<TGenerics>[];
17
- getLeftVisibleLeafColumns: () => Column<TGenerics>[];
18
- getRightVisibleLeafColumns: () => Column<TGenerics>[];
19
- getCenterVisibleLeafColumns: () => Column<TGenerics>[];
20
- setColumnVisibility: (updater: Updater<VisibilityState>) => void;
21
- resetColumnVisibility: (defaultState?: boolean) => void;
22
- toggleAllColumnsVisible: (value?: boolean) => void;
23
- getIsAllColumnsVisible: () => boolean;
24
- getIsSomeColumnsVisible: () => boolean;
25
- getToggleAllColumnsVisibilityHandler: () => (event: unknown) => void;
26
- };
27
- export declare type VisibilityColumnDef = {
28
- enableHiding?: boolean;
29
- };
30
- export declare type VisibilityRow<TGenerics extends TableGenerics> = {
31
- _getAllVisibleCells: () => Cell<TGenerics>[];
32
- getVisibleCells: () => Cell<TGenerics>[];
33
- };
34
- export declare type VisibilityColumn = {
35
- getCanHide: () => boolean;
36
- getIsVisible: () => boolean;
37
- toggleVisibility: (value?: boolean) => void;
38
- getToggleVisibilityHandler: () => (event: unknown) => void;
39
- };
40
- export declare const Visibility: TableFeature;
@@ -1,13 +0,0 @@
1
- import { FilterFn } from './features/Filters';
2
- export declare const filterFns: {
3
- includesString: FilterFn<any>;
4
- includesStringSensitive: FilterFn<any>;
5
- equalsString: FilterFn<any>;
6
- arrIncludes: FilterFn<any>;
7
- arrIncludesAll: FilterFn<any>;
8
- arrIncludesSome: FilterFn<any>;
9
- equals: FilterFn<any>;
10
- weakEquals: FilterFn<any>;
11
- inNumberRange: FilterFn<any>;
12
- };
13
- export declare type BuiltInFilterFn = keyof typeof filterFns;
@@ -1,11 +0,0 @@
1
- import { SortingFn } from './features/Sorting';
2
- export declare const reSplitAlphaNumeric: RegExp;
3
- export declare const sortingFns: {
4
- alphanumeric: SortingFn<any>;
5
- alphanumericCaseSensitive: SortingFn<any>;
6
- text: SortingFn<any>;
7
- textCaseSensitive: SortingFn<any>;
8
- datetime: SortingFn<any>;
9
- basic: SortingFn<any>;
10
- };
11
- export declare type BuiltInSortingFn = keyof typeof sortingFns;
@@ -1,53 +0,0 @@
1
- import { CoreOptions, CoreTableState, CoreInstance } from './core/instance';
2
- import { CoreColumn, CoreColumnDef } from './core/column';
3
- import { VisibilityInstance, VisibilityTableState, VisibilityColumn as ColumnVisibilityColumn, VisibilityOptions, VisibilityColumnDef, VisibilityRow } from './features/Visibility';
4
- import { ColumnOrderInstance, ColumnOrderOptions, ColumnOrderTableState } from './features/Ordering';
5
- import { ColumnPinningColumn, ColumnPinningColumnDef, ColumnPinningInstance, ColumnPinningOptions, ColumnPinningRow, ColumnPinningTableState } from './features/Pinning';
6
- import { CoreHeader, CoreHeaderGroup, HeadersInstance } from './core/headers';
7
- import { FiltersColumn, FiltersColumnDef, FiltersInstance, FiltersOptions, FiltersRow, FiltersTableState } from './features/Filters';
8
- import { SortingColumn, SortingColumnDef, SortingInstance, SortingOptions, SortingTableState } from './features/Sorting';
9
- import { GroupingCell, GroupingColumn, GroupingColumnDef, GroupingInstance, GroupingOptions, GroupingRow, GroupingTableState } from './features/Grouping';
10
- import { ExpandedInstance, ExpandedOptions, ExpandedTableState, ExpandedRow } from './features/Expanding';
11
- import { ColumnSizingColumn, ColumnSizingColumnDef, ColumnSizingHeader, ColumnSizingInstance, ColumnSizingOptions, ColumnSizingTableState } from './features/ColumnSizing';
12
- import { PaginationInitialTableState, PaginationInstance, PaginationOptions, PaginationTableState } from './features/Pagination';
13
- import { RowSelectionInstance, RowSelectionOptions, RowSelectionRow, RowSelectionTableState } from './features/RowSelection';
14
- import { CoreRow } from './core/row';
15
- import { PartialKeys } from './utils';
16
- import { CoreCell } from './core/cell';
17
- export declare type Updater<T> = T | ((old: T) => T);
18
- export declare type OnChangeFn<T> = (updaterOrValue: Updater<T>) => void;
19
- export declare type TableGenerics = {
20
- Row?: any;
21
- Value?: any;
22
- FilterFns?: any;
23
- SortingFns?: any;
24
- AggregationFns?: any;
25
- Renderer?: any;
26
- Rendered?: any;
27
- ColumnMeta?: any;
28
- TableMeta?: any;
29
- FilterMeta?: any;
30
- };
31
- export declare type AnyRender = (Comp: any, props: any) => any;
32
- export 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>;
33
- export declare type TableOptionsResolved<TGenerics extends TableGenerics> = CoreOptions<TGenerics> & VisibilityOptions & ColumnOrderOptions & ColumnPinningOptions & FiltersOptions<TGenerics> & SortingOptions<TGenerics> & GroupingOptions<TGenerics> & ExpandedOptions<TGenerics> & ColumnSizingOptions & PaginationOptions<TGenerics> & RowSelectionOptions<TGenerics>;
34
- export declare type TableOptions<TGenerics extends TableGenerics> = Omit<PartialKeys<TableOptionsResolved<TGenerics>, 'state' | 'onStateChange'>, 'render' | 'renderFallbackValue'>;
35
- export declare type TableState = CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationTableState & RowSelectionTableState;
36
- export declare type InitialTableState = Partial<CoreTableState & VisibilityTableState & ColumnOrderTableState & ColumnPinningTableState & FiltersTableState & SortingTableState & ExpandedTableState & GroupingTableState & ColumnSizingTableState & PaginationInitialTableState & RowSelectionTableState>;
37
- export declare type Row<TGenerics extends TableGenerics> = CoreRow<TGenerics> & VisibilityRow<TGenerics> & ColumnPinningRow<TGenerics> & FiltersRow<TGenerics> & GroupingRow & RowSelectionRow & ExpandedRow;
38
- export declare type RowValues = {
39
- [key: string]: any;
40
- };
41
- export declare type RowModel<TGenerics extends TableGenerics> = {
42
- rows: Row<TGenerics>[];
43
- flatRows: Row<TGenerics>[];
44
- rowsById: Record<string, Row<TGenerics>>;
45
- };
46
- export declare type AccessorFn<TData> = (originalRow: TData, index: number) => any;
47
- export declare type Renderable<TGenerics extends TableGenerics, TProps> = string | ((props: TProps) => TGenerics['Rendered']);
48
- export declare type ColumnDef<TGenerics extends TableGenerics> = CoreColumnDef<TGenerics> & VisibilityColumnDef & ColumnPinningColumnDef & FiltersColumnDef<TGenerics> & SortingColumnDef<TGenerics> & GroupingColumnDef<TGenerics> & ColumnSizingColumnDef;
49
- export declare type Column<TGenerics extends TableGenerics> = CoreColumn<TGenerics> & ColumnVisibilityColumn & ColumnPinningColumn & FiltersColumn<TGenerics> & SortingColumn<TGenerics> & GroupingColumn<TGenerics> & ColumnSizingColumn<TGenerics>;
50
- export declare type Cell<TGenerics extends TableGenerics> = CoreCell<TGenerics> & GroupingCell<TGenerics>;
51
- export declare type Header<TGenerics extends TableGenerics> = CoreHeader<TGenerics> & ColumnSizingHeader<TGenerics>;
52
- export declare type HeaderGroup<TGenerics extends TableGenerics> = CoreHeaderGroup<TGenerics>;
53
- export declare type NoInfer<A extends any> = [A][A extends any ? 0 : never];
@@ -1,4 +0,0 @@
1
- import { TableGenerics, Row, RowModel, TableInstance } from '../types';
2
- export declare function filterRows<TGenerics extends TableGenerics>(rows: Row<TGenerics>[], filterRowImpl: (row: Row<TGenerics>) => any, instance: TableInstance<TGenerics>): RowModel<TGenerics>;
3
- export declare function filterRowModelFromLeafs<TGenerics extends TableGenerics>(rowsToFilter: Row<TGenerics>[], filterRow: (row: Row<TGenerics>) => Row<TGenerics>[], instance: TableInstance<TGenerics>): RowModel<TGenerics>;
4
- export declare function filterRowModelFromRoot<TGenerics extends TableGenerics>(rowsToFilter: Row<TGenerics>[], filterRow: (row: Row<TGenerics>) => any, instance: TableInstance<TGenerics>): RowModel<TGenerics>;
@@ -1,2 +0,0 @@
1
- import { TableInstance, RowModel, TableGenerics } from '../types';
2
- export declare function getCoreRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
@@ -1,7 +0,0 @@
1
- import { TableInstance, Row, RowModel, TableGenerics } from '../types';
2
- export declare function getExpandedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
3
- export declare function expandRows<TGenerics extends TableGenerics>(rowModel: RowModel<TGenerics>, instance: TableInstance<TGenerics>): {
4
- rows: Row<TGenerics>[];
5
- flatRows: Row<TGenerics>[];
6
- rowsById: Record<string, Row<TGenerics>>;
7
- };
@@ -1,2 +0,0 @@
1
- import { TableInstance, TableGenerics } from '../types';
2
- export declare function getFacetedMinMaxValues<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>, columnId: string) => () => undefined | [number, number];
@@ -1,2 +0,0 @@
1
- import { TableInstance, RowModel, TableGenerics } from '../types';
2
- export declare function getFacetedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>, columnId: string) => () => RowModel<TGenerics>;
@@ -1,2 +0,0 @@
1
- import { TableInstance, TableGenerics } from '../types';
2
- export declare function getFacetedUniqueValues<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>, columnId: string) => () => Map<any, number>;
@@ -1,2 +0,0 @@
1
- import { TableInstance, RowModel, TableGenerics } from '../types';
2
- export declare function getFilteredRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
@@ -1,2 +0,0 @@
1
- import { TableInstance, RowModel, TableGenerics } from '../types';
2
- export declare function getGroupedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
@@ -1,4 +0,0 @@
1
- import { TableInstance, RowModel, TableGenerics } from '../types';
2
- export declare function getPaginationRowModel<TGenerics extends TableGenerics>(opts?: {
3
- initialSync: boolean;
4
- }): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;
@@ -1,2 +0,0 @@
1
- import { TableInstance, RowModel, TableGenerics } from '../types';
2
- export declare function getSortedRowModel<TGenerics extends TableGenerics>(): (instance: TableInstance<TGenerics>) => () => RowModel<TGenerics>;