@tanstack/table-core 8.13.2 → 8.14.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 (101) hide show
  1. package/build/lib/aggregationFns.d.ts +1 -1
  2. package/build/lib/aggregationFns.js.map +1 -1
  3. package/build/lib/core/column.js +1 -1
  4. package/build/lib/core/column.js.map +1 -1
  5. package/build/lib/core/headers.d.ts +1 -2
  6. package/build/lib/core/headers.js.map +1 -1
  7. package/build/lib/core/row.js.map +1 -1
  8. package/build/lib/core/table.d.ts +7 -11
  9. package/build/lib/core/table.js +21 -13
  10. package/build/lib/core/table.js.map +1 -1
  11. package/build/lib/features/ColumnFaceting.d.ts +34 -0
  12. package/build/lib/features/ColumnFaceting.js +42 -0
  13. package/build/lib/features/ColumnFaceting.js.map +1 -0
  14. package/build/lib/features/{Filters.d.ts → ColumnFiltering.d.ts} +29 -132
  15. package/build/lib/features/{Filters.js → ColumnFiltering.js} +8 -83
  16. package/build/lib/features/ColumnFiltering.js.map +1 -0
  17. package/build/lib/features/{Grouping.d.ts → ColumnGrouping.d.ts} +2 -3
  18. package/build/lib/features/{Grouping.js → ColumnGrouping.js} +3 -3
  19. package/build/lib/features/ColumnGrouping.js.map +1 -0
  20. package/build/lib/features/{Ordering.d.ts → ColumnOrdering.d.ts} +2 -3
  21. package/build/lib/features/{Ordering.js → ColumnOrdering.js} +9 -9
  22. package/build/lib/features/ColumnOrdering.js.map +1 -0
  23. package/build/lib/features/ColumnPinning.d.ts +126 -0
  24. package/build/lib/features/{Pinning.js → ColumnPinning.js} +4 -115
  25. package/build/lib/features/ColumnPinning.js.map +1 -0
  26. package/build/lib/features/ColumnSizing.d.ts +2 -3
  27. package/build/lib/features/ColumnSizing.js +3 -3
  28. package/build/lib/features/ColumnSizing.js.map +1 -1
  29. package/build/lib/features/{Visibility.d.ts → ColumnVisibility.d.ts} +2 -3
  30. package/build/lib/features/{Visibility.js → ColumnVisibility.js} +3 -3
  31. package/build/lib/features/ColumnVisibility.js.map +1 -0
  32. package/build/lib/features/GlobalFiltering.d.ts +100 -0
  33. package/build/lib/features/GlobalFiltering.js +85 -0
  34. package/build/lib/features/GlobalFiltering.js.map +1 -0
  35. package/build/lib/features/{Expanding.d.ts → RowExpanding.d.ts} +2 -3
  36. package/build/lib/features/{Expanding.js → RowExpanding.js} +3 -3
  37. package/build/lib/features/RowExpanding.js.map +1 -0
  38. package/build/lib/features/{Pagination.d.ts → RowPagination.d.ts} +2 -3
  39. package/build/lib/features/{Pagination.js → RowPagination.js} +3 -3
  40. package/build/lib/features/RowPagination.js.map +1 -0
  41. package/build/lib/features/RowPinning.d.ts +98 -0
  42. package/build/lib/features/RowPinning.js +145 -0
  43. package/build/lib/features/RowPinning.js.map +1 -0
  44. package/build/lib/features/RowSelection.d.ts +1 -2
  45. package/build/lib/features/RowSelection.js.map +1 -1
  46. package/build/lib/features/{Sorting.d.ts → RowSorting.d.ts} +5 -3
  47. package/build/lib/features/{Sorting.js → RowSorting.js} +3 -3
  48. package/build/lib/features/RowSorting.js.map +1 -0
  49. package/build/lib/filterFns.d.ts +1 -1
  50. package/build/lib/filterFns.js.map +1 -1
  51. package/build/lib/index.d.ts +21 -18
  52. package/build/lib/index.esm.js +1490 -1446
  53. package/build/lib/index.esm.js.map +1 -1
  54. package/build/lib/index.js +47 -41
  55. package/build/lib/index.js.map +1 -1
  56. package/build/lib/index.mjs +1490 -1446
  57. package/build/lib/index.mjs.map +1 -1
  58. package/build/lib/sortingFns.d.ts +1 -1
  59. package/build/lib/sortingFns.js.map +1 -1
  60. package/build/lib/types.d.ts +30 -16
  61. package/build/lib/utils/getFilteredRowModel.js.map +1 -1
  62. package/build/lib/utils/getSortedRowModel.js.map +1 -1
  63. package/build/umd/index.development.js +1500 -1453
  64. package/build/umd/index.development.js.map +1 -1
  65. package/build/umd/index.production.js +1 -1
  66. package/build/umd/index.production.js.map +1 -1
  67. package/package.json +1 -1
  68. package/src/aggregationFns.ts +1 -1
  69. package/src/core/column.ts +2 -2
  70. package/src/core/headers.ts +9 -3
  71. package/src/core/row.ts +1 -1
  72. package/src/core/table.ts +40 -32
  73. package/src/features/ColumnFaceting.ts +84 -0
  74. package/src/features/{Filters.ts → ColumnFiltering.ts} +44 -279
  75. package/src/features/{Grouping.ts → ColumnGrouping.ts} +6 -6
  76. package/src/features/{Ordering.ts → ColumnOrdering.ts} +11 -5
  77. package/src/features/ColumnPinning.ts +336 -0
  78. package/src/features/ColumnSizing.ts +10 -3
  79. package/src/features/{Visibility.ts → ColumnVisibility.ts} +2 -2
  80. package/src/features/GlobalFiltering.ts +218 -0
  81. package/src/features/{Expanding.ts → RowExpanding.ts} +9 -3
  82. package/src/features/{Pagination.ts → RowPagination.ts} +9 -3
  83. package/src/features/RowPinning.ts +273 -0
  84. package/src/features/RowSelection.ts +9 -2
  85. package/src/features/{Sorting.ts → RowSorting.ts} +5 -2
  86. package/src/filterFns.ts +1 -1
  87. package/src/index.ts +30 -18
  88. package/src/sortingFns.ts +1 -1
  89. package/src/types.ts +60 -23
  90. package/src/utils/getFilteredRowModel.ts +1 -1
  91. package/src/utils/getSortedRowModel.ts +1 -1
  92. package/build/lib/features/Expanding.js.map +0 -1
  93. package/build/lib/features/Filters.js.map +0 -1
  94. package/build/lib/features/Grouping.js.map +0 -1
  95. package/build/lib/features/Ordering.js.map +0 -1
  96. package/build/lib/features/Pagination.js.map +0 -1
  97. package/build/lib/features/Pinning.d.ts +0 -222
  98. package/build/lib/features/Pinning.js.map +0 -1
  99. package/build/lib/features/Sorting.js.map +0 -1
  100. package/build/lib/features/Visibility.js.map +0 -1
  101. package/src/features/Pinning.ts +0 -573
@@ -15,7 +15,7 @@ var utils = require('../utils.js');
15
15
 
16
16
  //
17
17
 
18
- const Filters = {
18
+ const ColumnFiltering = {
19
19
  getDefaultColumnDef: () => {
20
20
  return {
21
21
  filterFn: 'auto'
@@ -24,24 +24,14 @@ const Filters = {
24
24
  getInitialState: state => {
25
25
  return {
26
26
  columnFilters: [],
27
- globalFilter: undefined,
28
- // filtersProgress: 1,
29
- // facetProgress: {},
30
27
  ...state
31
28
  };
32
29
  },
33
30
  getDefaultOptions: table => {
34
31
  return {
35
32
  onColumnFiltersChange: utils.makeStateUpdater('columnFilters', table),
36
- onGlobalFilterChange: utils.makeStateUpdater('globalFilter', table),
37
33
  filterFromLeafRows: false,
38
- maxLeafRowFilterDepth: 100,
39
- globalFilterFn: 'auto',
40
- getColumnCanGlobalFilter: column => {
41
- var _table$getCoreRowMode;
42
- const value = (_table$getCoreRowMode = table.getCoreRowModel().flatRows[0]) == null || (_table$getCoreRowMode = _table$getCoreRowMode._getAllCellsByColumnId()[column.id]) == null ? void 0 : _table$getCoreRowMode.getValue();
43
- return typeof value === 'string' || typeof value === 'number';
44
- }
34
+ maxLeafRowFilterDepth: 100
45
35
  };
46
36
  },
47
37
  createColumn: (column, table) => {
@@ -74,10 +64,6 @@ const Filters = {
74
64
  var _column$columnDef$ena, _table$options$enable, _table$options$enable2;
75
65
  return ((_column$columnDef$ena = column.columnDef.enableColumnFilter) != null ? _column$columnDef$ena : true) && ((_table$options$enable = table.options.enableColumnFilters) != null ? _table$options$enable : true) && ((_table$options$enable2 = table.options.enableFilters) != null ? _table$options$enable2 : true) && !!column.accessorFn;
76
66
  };
77
- column.getCanGlobalFilter = () => {
78
- var _column$columnDef$ena2, _table$options$enable3, _table$options$enable4, _table$options$getCol;
79
- return ((_column$columnDef$ena2 = column.columnDef.enableGlobalFilter) != null ? _column$columnDef$ena2 : true) && ((_table$options$enable3 = table.options.enableGlobalFilter) != null ? _table$options$enable3 : true) && ((_table$options$enable4 = table.options.enableFilters) != null ? _table$options$enable4 : true) && ((_table$options$getCol = table.options.getColumnCanGlobalFilter == null ? void 0 : table.options.getColumnCanGlobalFilter(column)) != null ? _table$options$getCol : true) && !!column.accessorFn;
80
- };
81
67
  column.getIsFiltered = () => column.getFilterIndex() > -1;
82
68
  column.getFilterValue = () => {
83
69
  var _table$getState$colum;
@@ -90,8 +76,8 @@ const Filters = {
90
76
  column.setFilterValue = value => {
91
77
  table.setColumnFilters(old => {
92
78
  const filterFn = column.getFilterFn();
93
- const previousfilter = old == null ? void 0 : old.find(d => d.id === column.id);
94
- const newFilter = utils.functionalUpdate(value, previousfilter ? previousfilter.value : undefined);
79
+ const previousFilter = old == null ? void 0 : old.find(d => d.id === column.id);
80
+ const newFilter = utils.functionalUpdate(value, previousFilter ? previousFilter.value : undefined);
95
81
 
96
82
  //
97
83
  if (shouldAutoRemoveFilter(filterFn, newFilter, column)) {
@@ -102,7 +88,7 @@ const Filters = {
102
88
  id: column.id,
103
89
  value: newFilter
104
90
  };
105
- if (previousfilter) {
91
+ if (previousFilter) {
106
92
  var _old$map;
107
93
  return (_old$map = old == null ? void 0 : old.map(d => {
108
94
  if (d.id === column.id) {
@@ -117,46 +103,12 @@ const Filters = {
117
103
  return [newFilterObj];
118
104
  });
119
105
  };
120
- column._getFacetedRowModel = table.options.getFacetedRowModel && table.options.getFacetedRowModel(table, column.id);
121
- column.getFacetedRowModel = () => {
122
- if (!column._getFacetedRowModel) {
123
- return table.getPreFilteredRowModel();
124
- }
125
- return column._getFacetedRowModel();
126
- };
127
- column._getFacetedUniqueValues = table.options.getFacetedUniqueValues && table.options.getFacetedUniqueValues(table, column.id);
128
- column.getFacetedUniqueValues = () => {
129
- if (!column._getFacetedUniqueValues) {
130
- return new Map();
131
- }
132
- return column._getFacetedUniqueValues();
133
- };
134
- column._getFacetedMinMaxValues = table.options.getFacetedMinMaxValues && table.options.getFacetedMinMaxValues(table, column.id);
135
- column.getFacetedMinMaxValues = () => {
136
- if (!column._getFacetedMinMaxValues) {
137
- return undefined;
138
- }
139
- return column._getFacetedMinMaxValues();
140
- };
141
- // () => [column.getFacetedRowModel()],
142
- // facetedRowModel => getRowModelMinMaxValues(facetedRowModel, column.id),
143
106
  },
144
- createRow: (row, table) => {
107
+ createRow: (row, _table) => {
145
108
  row.columnFilters = {};
146
109
  row.columnFiltersMeta = {};
147
110
  },
148
111
  createTable: table => {
149
- table.getGlobalAutoFilterFn = () => {
150
- return filterFns.filterFns.includesString;
151
- };
152
- table.getGlobalFilterFn = () => {
153
- var _table$options$filter3, _table$options$filter4;
154
- const {
155
- globalFilterFn: globalFilterFn
156
- } = table.options;
157
- return utils.isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === 'auto' ? table.getGlobalAutoFilterFn() : // @ts-ignore
158
- (_table$options$filter3 = (_table$options$filter4 = table.options.filterFns) == null ? void 0 : _table$options$filter4[globalFilterFn]) != null ? _table$options$filter3 : filterFns.filterFns[globalFilterFn];
159
- };
160
112
  table.setColumnFilters = updater => {
161
113
  const leafColumns = table.getAllLeafColumns();
162
114
  const updateFn = old => {
@@ -174,12 +126,6 @@ const Filters = {
174
126
  };
175
127
  table.options.onColumnFiltersChange == null || table.options.onColumnFiltersChange(updateFn);
176
128
  };
177
- table.setGlobalFilter = updater => {
178
- table.options.onGlobalFilterChange == null || table.options.onGlobalFilterChange(updater);
179
- };
180
- table.resetGlobalFilter = defaultState => {
181
- table.setGlobalFilter(defaultState ? undefined : table.initialState.globalFilter);
182
- };
183
129
  table.resetColumnFilters = defaultState => {
184
130
  var _table$initialState$c, _table$initialState;
185
131
  table.setColumnFilters(defaultState ? [] : (_table$initialState$c = (_table$initialState = table.initialState) == null ? void 0 : _table$initialState.columnFilters) != null ? _table$initialState$c : []);
@@ -194,33 +140,12 @@ const Filters = {
194
140
  }
195
141
  return table._getFilteredRowModel();
196
142
  };
197
- table._getGlobalFacetedRowModel = table.options.getFacetedRowModel && table.options.getFacetedRowModel(table, '__global__');
198
- table.getGlobalFacetedRowModel = () => {
199
- if (table.options.manualFiltering || !table._getGlobalFacetedRowModel) {
200
- return table.getPreFilteredRowModel();
201
- }
202
- return table._getGlobalFacetedRowModel();
203
- };
204
- table._getGlobalFacetedUniqueValues = table.options.getFacetedUniqueValues && table.options.getFacetedUniqueValues(table, '__global__');
205
- table.getGlobalFacetedUniqueValues = () => {
206
- if (!table._getGlobalFacetedUniqueValues) {
207
- return new Map();
208
- }
209
- return table._getGlobalFacetedUniqueValues();
210
- };
211
- table._getGlobalFacetedMinMaxValues = table.options.getFacetedMinMaxValues && table.options.getFacetedMinMaxValues(table, '__global__');
212
- table.getGlobalFacetedMinMaxValues = () => {
213
- if (!table._getGlobalFacetedMinMaxValues) {
214
- return;
215
- }
216
- return table._getGlobalFacetedMinMaxValues();
217
- };
218
143
  }
219
144
  };
220
145
  function shouldAutoRemoveFilter(filterFn, value, column) {
221
146
  return (filterFn && filterFn.autoRemove ? filterFn.autoRemove(value, column) : false) || typeof value === 'undefined' || typeof value === 'string' && !value;
222
147
  }
223
148
 
224
- exports.Filters = Filters;
149
+ exports.ColumnFiltering = ColumnFiltering;
225
150
  exports.shouldAutoRemoveFilter = shouldAutoRemoveFilter;
226
- //# sourceMappingURL=Filters.js.map
151
+ //# sourceMappingURL=ColumnFiltering.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ColumnFiltering.js","sources":["../../../src/features/ColumnFiltering.ts"],"sourcesContent":["import { RowModel } from '..'\nimport { BuiltInFilterFn, filterFns } from '../filterFns'\nimport {\n Column,\n FilterFns,\n FilterMeta,\n OnChangeFn,\n Row,\n RowData,\n Table,\n TableFeature,\n Updater,\n} from '../types'\nimport { functionalUpdate, isFunction, makeStateUpdater } from '../utils'\n\nexport interface ColumnFiltersTableState {\n columnFilters: ColumnFiltersState\n}\n\nexport type ColumnFiltersState = ColumnFilter[]\n\nexport interface ColumnFilter {\n id: string\n value: unknown\n}\n\nexport interface ResolvedColumnFilter<TData extends RowData> {\n filterFn: FilterFn<TData>\n id: string\n resolvedValue: unknown\n}\n\nexport interface FilterFn<TData extends RowData> {\n (\n row: Row<TData>,\n columnId: string,\n filterValue: any,\n addMeta: (meta: FilterMeta) => void\n ): boolean\n autoRemove?: ColumnFilterAutoRemoveTestFn<TData>\n resolveFilterValue?: TransformFilterValueFn<TData>\n}\n\nexport type TransformFilterValueFn<TData extends RowData> = (\n value: any,\n column?: Column<TData, unknown>\n) => unknown\n\nexport type ColumnFilterAutoRemoveTestFn<TData extends RowData> = (\n value: any,\n column?: Column<TData, unknown>\n) => boolean\n\nexport type CustomFilterFns<TData extends RowData> = Record<\n string,\n FilterFn<TData>\n>\n\nexport type FilterFnOption<TData extends RowData> =\n | 'auto'\n | BuiltInFilterFn\n | keyof FilterFns\n | FilterFn<TData>\n\nexport interface ColumnFiltersColumnDef<TData extends RowData> {\n /**\n * Enables/disables the **column** filter for this column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilter)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n enableColumnFilter?: boolean\n /**\n * The filter function to use with this column. Can be the name of a built-in filter function or a custom filter function.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#filterfn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n filterFn?: FilterFnOption<TData>\n}\n\nexport interface ColumnFiltersColumn<TData extends RowData> {\n /**\n * Returns an automatically calculated filter function for the column based off of the columns first known value.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getautofilterfn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getAutoFilterFn: () => FilterFn<TData> | undefined\n /**\n * Returns whether or not the column can be **column** filtered.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getcanfilter)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getCanFilter: () => boolean\n /**\n * Returns the filter function (either user-defined or automatic, depending on configuration) for the columnId specified.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilterfn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getFilterFn: () => FilterFn<TData> | undefined\n /**\n * Returns the index (including `-1`) of the column filter in the table's `state.columnFilters` array.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilterindex)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getFilterIndex: () => number\n /**\n * Returns the current filter value for the column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfiltervalue)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getFilterValue: () => unknown\n /**\n * Returns whether or not the column is currently filtered.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getisfiltered)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getIsFiltered: () => boolean\n /**\n * A function that sets the current filter value for the column. You can pass it a value or an updater function for immutability-safe operations on existing values.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setfiltervalue)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n setFilterValue: (updater: Updater<any>) => void\n}\n\nexport interface ColumnFiltersRow<TData extends RowData> {\n /**\n * The column filters map for the row. This object tracks whether a row is passing/failing specific filters by their column ID.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#columnfilters)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n columnFilters: Record<string, boolean>\n /**\n * The column filters meta map for the row. This object tracks any filter meta for a row as optionally provided during the filtering process.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#columnfiltersmeta)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n columnFiltersMeta: Record<string, FilterMeta>\n}\n\ninterface ColumnFiltersOptionsBase<TData extends RowData> {\n /**\n * Enables/disables **column** filtering for all columns.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablecolumnfilters)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n enableColumnFilters?: boolean\n /**\n * Enables/disables all filtering for the table.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#enablefilters)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n enableFilters?: boolean\n /**\n * By default, filtering is done from parent rows down (so if a parent row is filtered out, all of its children will be filtered out as well). Setting this option to `true` will cause filtering to be done from leaf rows up (which means parent rows will be included so long as one of their child or grand-child rows is also included).\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#filterfromleafrows)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n filterFromLeafRows?: boolean\n /**\n * If provided, this function is called **once** per table and should return a **new function** which will calculate and return the row model for the table when it's filtered.\n * - For server-side filtering, this function is unnecessary and can be ignored since the server should already return the filtered row model.\n * - For client-side filtering, this function is required. A default implementation is provided via any table adapter's `{ getFilteredRowModel }` export.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilteredrowmodel)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getFilteredRowModel?: (table: Table<any>) => () => RowModel<any>\n /**\n * Disables the `getFilteredRowModel` from being used to filter data. This may be useful if your table needs to dynamically support both client-side and server-side filtering.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#manualfiltering)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n manualFiltering?: boolean\n /**\n * By default, filtering is done for all rows (max depth of 100), no matter if they are root level parent rows or the child leaf rows of a parent row. Setting this option to `0` will cause filtering to only be applied to the root level parent rows, with all sub-rows remaining unfiltered. Similarly, setting this option to `1` will cause filtering to only be applied to child leaf rows 1 level deep, and so on.\n\n * This is useful for situations where you want a row's entire child hierarchy to be visible regardless of the applied filter.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#maxleafrowfilterdepth)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n maxLeafRowFilterDepth?: number\n /**\n * If provided, this function will be called with an `updaterFn` when `state.columnFilters` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#oncolumnfilterschange)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n onColumnFiltersChange?: OnChangeFn<ColumnFiltersState>\n}\n\ntype ResolvedFilterFns = keyof FilterFns extends never\n ? {\n filterFns?: Record<string, FilterFn<any>>\n }\n : {\n filterFns: Record<keyof FilterFns, FilterFn<any>>\n }\n\nexport interface ColumnFiltersOptions<TData extends RowData>\n extends ColumnFiltersOptionsBase<TData>,\n ResolvedFilterFns {}\n\nexport interface ColumnFiltersInstance<TData extends RowData> {\n _getFilteredRowModel?: () => RowModel<TData>\n /**\n * Returns the row model for the table after **column** filtering has been applied.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getfilteredrowmodel)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getFilteredRowModel: () => RowModel<TData>\n /**\n * Returns the row model for the table before any **column** filtering has been applied.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#getprefilteredrowmodel)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n getPreFilteredRowModel: () => RowModel<TData>\n /**\n * Resets the **columnFilters** state to `initialState.columnFilters`, or `true` can be passed to force a default blank state reset to `[]`.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetcolumnfilters)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n resetColumnFilters: (defaultState?: boolean) => void\n /**\n * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#resetglobalfilter)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n resetGlobalFilter: (defaultState?: boolean) => void\n /**\n * Sets or updates the `state.columnFilters` state.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setcolumnfilters)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n setColumnFilters: (updater: Updater<ColumnFiltersState>) => void\n /**\n * Sets or updates the `state.globalFilter` state.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/filters#setglobalfilter)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/filters)\n */\n setGlobalFilter: (updater: Updater<any>) => void\n}\n\n//\n\nexport const ColumnFiltering: TableFeature = {\n getDefaultColumnDef: <\n TData extends RowData,\n >(): ColumnFiltersColumnDef<TData> => {\n return {\n filterFn: 'auto',\n }\n },\n\n getInitialState: (state): ColumnFiltersTableState => {\n return {\n columnFilters: [],\n ...state,\n }\n },\n\n getDefaultOptions: <TData extends RowData>(\n table: Table<TData>\n ): ColumnFiltersOptions<TData> => {\n return {\n onColumnFiltersChange: makeStateUpdater('columnFilters', table),\n filterFromLeafRows: false,\n maxLeafRowFilterDepth: 100,\n } as ColumnFiltersOptions<TData>\n },\n\n createColumn: <TData extends RowData>(\n column: Column<TData, unknown>,\n table: Table<TData>\n ): void => {\n column.getAutoFilterFn = () => {\n const firstRow = table.getCoreRowModel().flatRows[0]\n\n const value = firstRow?.getValue(column.id)\n\n if (typeof value === 'string') {\n return filterFns.includesString\n }\n\n if (typeof value === 'number') {\n return filterFns.inNumberRange\n }\n\n if (typeof value === 'boolean') {\n return filterFns.equals\n }\n\n if (value !== null && typeof value === 'object') {\n return filterFns.equals\n }\n\n if (Array.isArray(value)) {\n return filterFns.arrIncludes\n }\n\n return filterFns.weakEquals\n }\n column.getFilterFn = () => {\n return isFunction(column.columnDef.filterFn)\n ? column.columnDef.filterFn\n : column.columnDef.filterFn === 'auto'\n ? column.getAutoFilterFn()\n : // @ts-ignore\n table.options.filterFns?.[column.columnDef.filterFn as string] ??\n filterFns[column.columnDef.filterFn as BuiltInFilterFn]\n }\n column.getCanFilter = () => {\n return (\n (column.columnDef.enableColumnFilter ?? true) &&\n (table.options.enableColumnFilters ?? true) &&\n (table.options.enableFilters ?? true) &&\n !!column.accessorFn\n )\n }\n\n column.getIsFiltered = () => column.getFilterIndex() > -1\n\n column.getFilterValue = () =>\n table.getState().columnFilters?.find(d => d.id === column.id)?.value\n\n column.getFilterIndex = () =>\n table.getState().columnFilters?.findIndex(d => d.id === column.id) ?? -1\n\n column.setFilterValue = value => {\n table.setColumnFilters(old => {\n const filterFn = column.getFilterFn()\n const previousFilter = old?.find(d => d.id === column.id)\n\n const newFilter = functionalUpdate(\n value,\n previousFilter ? previousFilter.value : undefined\n )\n\n //\n if (\n shouldAutoRemoveFilter(filterFn as FilterFn<TData>, newFilter, column)\n ) {\n return old?.filter(d => d.id !== column.id) ?? []\n }\n\n const newFilterObj = { id: column.id, value: newFilter }\n\n if (previousFilter) {\n return (\n old?.map(d => {\n if (d.id === column.id) {\n return newFilterObj\n }\n return d\n }) ?? []\n )\n }\n\n if (old?.length) {\n return [...old, newFilterObj]\n }\n\n return [newFilterObj]\n })\n }\n },\n\n createRow: <TData extends RowData>(\n row: Row<TData>,\n _table: Table<TData>\n ): void => {\n row.columnFilters = {}\n row.columnFiltersMeta = {}\n },\n\n createTable: <TData extends RowData>(table: Table<TData>): void => {\n table.setColumnFilters = (updater: Updater<ColumnFiltersState>) => {\n const leafColumns = table.getAllLeafColumns()\n\n const updateFn = (old: ColumnFiltersState) => {\n return functionalUpdate(updater, old)?.filter(filter => {\n const column = leafColumns.find(d => d.id === filter.id)\n\n if (column) {\n const filterFn = column.getFilterFn()\n\n if (shouldAutoRemoveFilter(filterFn, filter.value, column)) {\n return false\n }\n }\n\n return true\n })\n }\n\n table.options.onColumnFiltersChange?.(updateFn)\n }\n\n table.resetColumnFilters = defaultState => {\n table.setColumnFilters(\n defaultState ? [] : table.initialState?.columnFilters ?? []\n )\n }\n\n table.getPreFilteredRowModel = () => table.getCoreRowModel()\n table.getFilteredRowModel = () => {\n if (!table._getFilteredRowModel && table.options.getFilteredRowModel) {\n table._getFilteredRowModel = table.options.getFilteredRowModel(table)\n }\n\n if (table.options.manualFiltering || !table._getFilteredRowModel) {\n return table.getPreFilteredRowModel()\n }\n\n return table._getFilteredRowModel()\n }\n },\n}\n\nexport function shouldAutoRemoveFilter<TData extends RowData>(\n filterFn?: FilterFn<TData>,\n value?: any,\n column?: Column<TData, unknown>\n) {\n return (\n (filterFn && filterFn.autoRemove\n ? filterFn.autoRemove(value, column)\n : false) ||\n typeof value === 'undefined' ||\n (typeof value === 'string' && !value)\n )\n}\n"],"names":["ColumnFiltering","getDefaultColumnDef","filterFn","getInitialState","state","columnFilters","getDefaultOptions","table","onColumnFiltersChange","makeStateUpdater","filterFromLeafRows","maxLeafRowFilterDepth","createColumn","column","getAutoFilterFn","firstRow","getCoreRowModel","flatRows","value","getValue","id","filterFns","includesString","inNumberRange","equals","Array","isArray","arrIncludes","weakEquals","getFilterFn","_table$options$filter","_table$options$filter2","isFunction","columnDef","options","getCanFilter","_column$columnDef$ena","_table$options$enable","_table$options$enable2","enableColumnFilter","enableColumnFilters","enableFilters","accessorFn","getIsFiltered","getFilterIndex","getFilterValue","_table$getState$colum","getState","find","d","_table$getState$colum2","_table$getState$colum3","findIndex","setFilterValue","setColumnFilters","old","previousFilter","newFilter","functionalUpdate","undefined","shouldAutoRemoveFilter","_old$filter","filter","newFilterObj","_old$map","map","length","createRow","row","_table","columnFiltersMeta","createTable","updater","leafColumns","getAllLeafColumns","updateFn","_functionalUpdate","resetColumnFilters","defaultState","_table$initialState$c","_table$initialState","initialState","getPreFilteredRowModel","getFilteredRowModel","_getFilteredRowModel","manualFiltering","autoRemove"],"mappings":";;;;;;;;;;;;;;;AAgPA;;AAEO,MAAMA,eAA6B,GAAG;EAC3CC,mBAAmB,EAAEA,MAEiB;IACpC,OAAO;AACLC,MAAAA,QAAQ,EAAE,MAAA;KACX,CAAA;GACF;EAEDC,eAAe,EAAGC,KAAK,IAA8B;IACnD,OAAO;AACLC,MAAAA,aAAa,EAAE,EAAE;MACjB,GAAGD,KAAAA;KACJ,CAAA;GACF;EAEDE,iBAAiB,EACfC,KAAmB,IACa;IAChC,OAAO;AACLC,MAAAA,qBAAqB,EAAEC,sBAAgB,CAAC,eAAe,EAAEF,KAAK,CAAC;AAC/DG,MAAAA,kBAAkB,EAAE,KAAK;AACzBC,MAAAA,qBAAqB,EAAE,GAAA;KACxB,CAAA;GACF;AAEDC,EAAAA,YAAY,EAAEA,CACZC,MAA8B,EAC9BN,KAAmB,KACV;IACTM,MAAM,CAACC,eAAe,GAAG,MAAM;MAC7B,MAAMC,QAAQ,GAAGR,KAAK,CAACS,eAAe,EAAE,CAACC,QAAQ,CAAC,CAAC,CAAC,CAAA;MAEpD,MAAMC,KAAK,GAAGH,QAAQ,IAARA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,QAAQ,CAAEI,QAAQ,CAACN,MAAM,CAACO,EAAE,CAAC,CAAA;AAE3C,MAAA,IAAI,OAAOF,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAOG,mBAAS,CAACC,cAAc,CAAA;AACjC,OAAA;AAEA,MAAA,IAAI,OAAOJ,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAOG,mBAAS,CAACE,aAAa,CAAA;AAChC,OAAA;AAEA,MAAA,IAAI,OAAOL,KAAK,KAAK,SAAS,EAAE;QAC9B,OAAOG,mBAAS,CAACG,MAAM,CAAA;AACzB,OAAA;MAEA,IAAIN,KAAK,KAAK,IAAI,IAAI,OAAOA,KAAK,KAAK,QAAQ,EAAE;QAC/C,OAAOG,mBAAS,CAACG,MAAM,CAAA;AACzB,OAAA;AAEA,MAAA,IAAIC,KAAK,CAACC,OAAO,CAACR,KAAK,CAAC,EAAE;QACxB,OAAOG,mBAAS,CAACM,WAAW,CAAA;AAC9B,OAAA;MAEA,OAAON,mBAAS,CAACO,UAAU,CAAA;KAC5B,CAAA;IACDf,MAAM,CAACgB,WAAW,GAAG,MAAM;MAAA,IAAAC,qBAAA,EAAAC,sBAAA,CAAA;AACzB,MAAA,OAAOC,gBAAU,CAACnB,MAAM,CAACoB,SAAS,CAAC/B,QAAQ,CAAC,GACxCW,MAAM,CAACoB,SAAS,CAAC/B,QAAQ,GACzBW,MAAM,CAACoB,SAAS,CAAC/B,QAAQ,KAAK,MAAM,GAClCW,MAAM,CAACC,eAAe,EAAE;AACxB,MAAA,CAAAgB,qBAAA,GAAA,CAAAC,sBAAA,GACAxB,KAAK,CAAC2B,OAAO,CAACb,SAAS,KAAA,IAAA,GAAA,KAAA,CAAA,GAAvBU,sBAAA,CAA0BlB,MAAM,CAACoB,SAAS,CAAC/B,QAAQ,CAAW,KAAA4B,IAAAA,GAAAA,qBAAA,GAC9DT,mBAAS,CAACR,MAAM,CAACoB,SAAS,CAAC/B,QAAQ,CAAoB,CAAA;KAC9D,CAAA;IACDW,MAAM,CAACsB,YAAY,GAAG,MAAM;AAAA,MAAA,IAAAC,qBAAA,EAAAC,qBAAA,EAAAC,sBAAA,CAAA;AAC1B,MAAA,OACE,EAAAF,qBAAA,GAACvB,MAAM,CAACoB,SAAS,CAACM,kBAAkB,KAAA,IAAA,GAAAH,qBAAA,GAAI,IAAI,OAAAC,qBAAA,GAC3C9B,KAAK,CAAC2B,OAAO,CAACM,mBAAmB,KAAA,IAAA,GAAAH,qBAAA,GAAI,IAAI,CAAC,KAAAC,CAAAA,sBAAA,GAC1C/B,KAAK,CAAC2B,OAAO,CAACO,aAAa,YAAAH,sBAAA,GAAI,IAAI,CAAC,IACrC,CAAC,CAACzB,MAAM,CAAC6B,UAAU,CAAA;KAEtB,CAAA;IAED7B,MAAM,CAAC8B,aAAa,GAAG,MAAM9B,MAAM,CAAC+B,cAAc,EAAE,GAAG,CAAC,CAAC,CAAA;IAEzD/B,MAAM,CAACgC,cAAc,GAAG,MAAA;AAAA,MAAA,IAAAC,qBAAA,CAAA;AAAA,MAAA,OAAA,CAAAA,qBAAA,GACtBvC,KAAK,CAACwC,QAAQ,EAAE,CAAC1C,aAAa,KAAA,IAAA,IAAA,CAAAyC,qBAAA,GAA9BA,qBAAA,CAAgCE,IAAI,CAACC,CAAC,IAAIA,CAAC,CAAC7B,EAAE,KAAKP,MAAM,CAACO,EAAE,CAAC,KAA7D0B,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,qBAAA,CAA+D5B,KAAK,CAAA;AAAA,KAAA,CAAA;IAEtEL,MAAM,CAAC+B,cAAc,GAAG,MAAA;MAAA,IAAAM,sBAAA,EAAAC,sBAAA,CAAA;AAAA,MAAA,OAAA,CAAAD,sBAAA,GAAA,CAAAC,sBAAA,GACtB5C,KAAK,CAACwC,QAAQ,EAAE,CAAC1C,aAAa,KAAA,IAAA,GAAA,KAAA,CAAA,GAA9B8C,sBAAA,CAAgCC,SAAS,CAACH,CAAC,IAAIA,CAAC,CAAC7B,EAAE,KAAKP,MAAM,CAACO,EAAE,CAAC,KAAA,IAAA,GAAA8B,sBAAA,GAAI,CAAC,CAAC,CAAA;AAAA,KAAA,CAAA;AAE1ErC,IAAAA,MAAM,CAACwC,cAAc,GAAGnC,KAAK,IAAI;AAC/BX,MAAAA,KAAK,CAAC+C,gBAAgB,CAACC,GAAG,IAAI;AAC5B,QAAA,MAAMrD,QAAQ,GAAGW,MAAM,CAACgB,WAAW,EAAE,CAAA;AACrC,QAAA,MAAM2B,cAAc,GAAGD,GAAG,IAAHA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,GAAG,CAAEP,IAAI,CAACC,CAAC,IAAIA,CAAC,CAAC7B,EAAE,KAAKP,MAAM,CAACO,EAAE,CAAC,CAAA;AAEzD,QAAA,MAAMqC,SAAS,GAAGC,sBAAgB,CAChCxC,KAAK,EACLsC,cAAc,GAAGA,cAAc,CAACtC,KAAK,GAAGyC,SAC1C,CAAC,CAAA;;AAED;QACA,IACEC,sBAAsB,CAAC1D,QAAQ,EAAqBuD,SAAS,EAAE5C,MAAM,CAAC,EACtE;AAAA,UAAA,IAAAgD,WAAA,CAAA;UACA,OAAAA,CAAAA,WAAA,GAAON,GAAG,IAAA,IAAA,GAAA,KAAA,CAAA,GAAHA,GAAG,CAAEO,MAAM,CAACb,CAAC,IAAIA,CAAC,CAAC7B,EAAE,KAAKP,MAAM,CAACO,EAAE,CAAC,KAAA,IAAA,GAAAyC,WAAA,GAAI,EAAE,CAAA;AACnD,SAAA;AAEA,QAAA,MAAME,YAAY,GAAG;UAAE3C,EAAE,EAAEP,MAAM,CAACO,EAAE;AAAEF,UAAAA,KAAK,EAAEuC,SAAAA;SAAW,CAAA;AAExD,QAAA,IAAID,cAAc,EAAE;AAAA,UAAA,IAAAQ,QAAA,CAAA;UAClB,OAAAA,CAAAA,QAAA,GACET,GAAG,IAAA,IAAA,GAAA,KAAA,CAAA,GAAHA,GAAG,CAAEU,GAAG,CAAChB,CAAC,IAAI;AACZ,YAAA,IAAIA,CAAC,CAAC7B,EAAE,KAAKP,MAAM,CAACO,EAAE,EAAE;AACtB,cAAA,OAAO2C,YAAY,CAAA;AACrB,aAAA;AACA,YAAA,OAAOd,CAAC,CAAA;AACV,WAAC,CAAC,KAAA,IAAA,GAAAe,QAAA,GAAI,EAAE,CAAA;AAEZ,SAAA;AAEA,QAAA,IAAIT,GAAG,IAAA,IAAA,IAAHA,GAAG,CAAEW,MAAM,EAAE;AACf,UAAA,OAAO,CAAC,GAAGX,GAAG,EAAEQ,YAAY,CAAC,CAAA;AAC/B,SAAA;QAEA,OAAO,CAACA,YAAY,CAAC,CAAA;AACvB,OAAC,CAAC,CAAA;KACH,CAAA;GACF;AAEDI,EAAAA,SAAS,EAAEA,CACTC,GAAe,EACfC,MAAoB,KACX;AACTD,IAAAA,GAAG,CAAC/D,aAAa,GAAG,EAAE,CAAA;AACtB+D,IAAAA,GAAG,CAACE,iBAAiB,GAAG,EAAE,CAAA;GAC3B;EAEDC,WAAW,EAA0BhE,KAAmB,IAAW;AACjEA,IAAAA,KAAK,CAAC+C,gBAAgB,GAAIkB,OAAoC,IAAK;AACjE,MAAA,MAAMC,WAAW,GAAGlE,KAAK,CAACmE,iBAAiB,EAAE,CAAA;MAE7C,MAAMC,QAAQ,GAAIpB,GAAuB,IAAK;AAAA,QAAA,IAAAqB,iBAAA,CAAA;AAC5C,QAAA,OAAA,CAAAA,iBAAA,GAAOlB,sBAAgB,CAACc,OAAO,EAAEjB,GAAG,CAAC,KAAA,IAAA,GAAA,KAAA,CAAA,GAA9BqB,iBAAA,CAAgCd,MAAM,CAACA,MAAM,IAAI;AACtD,UAAA,MAAMjD,MAAM,GAAG4D,WAAW,CAACzB,IAAI,CAACC,CAAC,IAAIA,CAAC,CAAC7B,EAAE,KAAK0C,MAAM,CAAC1C,EAAE,CAAC,CAAA;AAExD,UAAA,IAAIP,MAAM,EAAE;AACV,YAAA,MAAMX,QAAQ,GAAGW,MAAM,CAACgB,WAAW,EAAE,CAAA;YAErC,IAAI+B,sBAAsB,CAAC1D,QAAQ,EAAE4D,MAAM,CAAC5C,KAAK,EAAEL,MAAM,CAAC,EAAE;AAC1D,cAAA,OAAO,KAAK,CAAA;AACd,aAAA;AACF,WAAA;AAEA,UAAA,OAAO,IAAI,CAAA;AACb,SAAC,CAAC,CAAA;OACH,CAAA;AAEDN,MAAAA,KAAK,CAAC2B,OAAO,CAAC1B,qBAAqB,IAAnCD,IAAAA,IAAAA,KAAK,CAAC2B,OAAO,CAAC1B,qBAAqB,CAAGmE,QAAQ,CAAC,CAAA;KAChD,CAAA;AAEDpE,IAAAA,KAAK,CAACsE,kBAAkB,GAAGC,YAAY,IAAI;MAAA,IAAAC,qBAAA,EAAAC,mBAAA,CAAA;MACzCzE,KAAK,CAAC+C,gBAAgB,CACpBwB,YAAY,GAAG,EAAE,GAAA,CAAAC,qBAAA,GAAA,CAAAC,mBAAA,GAAGzE,KAAK,CAAC0E,YAAY,qBAAlBD,mBAAA,CAAoB3E,aAAa,KAAA0E,IAAAA,GAAAA,qBAAA,GAAI,EAC3D,CAAC,CAAA;KACF,CAAA;IAEDxE,KAAK,CAAC2E,sBAAsB,GAAG,MAAM3E,KAAK,CAACS,eAAe,EAAE,CAAA;IAC5DT,KAAK,CAAC4E,mBAAmB,GAAG,MAAM;MAChC,IAAI,CAAC5E,KAAK,CAAC6E,oBAAoB,IAAI7E,KAAK,CAAC2B,OAAO,CAACiD,mBAAmB,EAAE;QACpE5E,KAAK,CAAC6E,oBAAoB,GAAG7E,KAAK,CAAC2B,OAAO,CAACiD,mBAAmB,CAAC5E,KAAK,CAAC,CAAA;AACvE,OAAA;MAEA,IAAIA,KAAK,CAAC2B,OAAO,CAACmD,eAAe,IAAI,CAAC9E,KAAK,CAAC6E,oBAAoB,EAAE;AAChE,QAAA,OAAO7E,KAAK,CAAC2E,sBAAsB,EAAE,CAAA;AACvC,OAAA;AAEA,MAAA,OAAO3E,KAAK,CAAC6E,oBAAoB,EAAE,CAAA;KACpC,CAAA;AACH,GAAA;AACF,EAAC;AAEM,SAASxB,sBAAsBA,CACpC1D,QAA0B,EAC1BgB,KAAW,EACXL,MAA+B,EAC/B;AACA,EAAA,OACE,CAACX,QAAQ,IAAIA,QAAQ,CAACoF,UAAU,GAC5BpF,QAAQ,CAACoF,UAAU,CAACpE,KAAK,EAAEL,MAAM,CAAC,GAClC,KAAK,KACT,OAAOK,KAAK,KAAK,WAAW,IAC3B,OAAOA,KAAK,KAAK,QAAQ,IAAI,CAACA,KAAM,CAAA;AAEzC;;;;;"}
@@ -1,7 +1,6 @@
1
1
  import { RowModel } from '..';
2
2
  import { BuiltInAggregationFn } from '../aggregationFns';
3
- import { TableFeature } from '../core/table';
4
- import { Cell, Column, OnChangeFn, Table, Row, Updater, ColumnDefTemplate, RowData, AggregationFns } from '../types';
3
+ import { AggregationFns, Cell, Column, ColumnDefTemplate, OnChangeFn, Row, RowData, Table, TableFeature, Updater } from '../types';
5
4
  export type GroupingState = string[];
6
5
  export interface GroupingTableState {
7
6
  grouping: GroupingState;
@@ -197,6 +196,6 @@ export interface GroupingInstance<TData extends RowData> {
197
196
  */
198
197
  setGrouping: (updater: Updater<GroupingState>) => void;
199
198
  }
200
- export declare const Grouping: TableFeature;
199
+ export declare const ColumnGrouping: TableFeature;
201
200
  export declare function orderColumns<TData extends RowData>(leafColumns: Column<TData, unknown>[], grouping: string[], groupedColumnMode?: GroupingColumnMode): Column<TData, unknown>[];
202
201
  export {};
@@ -15,7 +15,7 @@ var utils = require('../utils.js');
15
15
 
16
16
  //
17
17
 
18
- const Grouping = {
18
+ const ColumnGrouping = {
19
19
  getDefaultColumnDef: () => {
20
20
  return {
21
21
  aggregatedCell: props => {
@@ -137,6 +137,6 @@ function orderColumns(leafColumns, grouping, groupedColumnMode) {
137
137
  return [...groupingColumns, ...nonGroupingColumns];
138
138
  }
139
139
 
140
- exports.Grouping = Grouping;
140
+ exports.ColumnGrouping = ColumnGrouping;
141
141
  exports.orderColumns = orderColumns;
142
- //# sourceMappingURL=Grouping.js.map
142
+ //# sourceMappingURL=ColumnGrouping.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ColumnGrouping.js","sources":["../../../src/features/ColumnGrouping.ts"],"sourcesContent":["import { RowModel } from '..'\nimport { BuiltInAggregationFn, aggregationFns } from '../aggregationFns'\nimport {\n AggregationFns,\n Cell,\n Column,\n ColumnDefTemplate,\n OnChangeFn,\n Row,\n RowData,\n Table,\n TableFeature,\n Updater,\n} from '../types'\nimport { isFunction, makeStateUpdater } from '../utils'\n\nexport type GroupingState = string[]\n\nexport interface GroupingTableState {\n grouping: GroupingState\n}\n\nexport type AggregationFn<TData extends RowData> = (\n columnId: string,\n leafRows: Row<TData>[],\n childRows: Row<TData>[]\n) => any\n\nexport type CustomAggregationFns = Record<string, AggregationFn<any>>\n\nexport type AggregationFnOption<TData extends RowData> =\n | 'auto'\n | keyof AggregationFns\n | BuiltInAggregationFn\n | AggregationFn<TData>\n\nexport interface GroupingColumnDef<TData extends RowData, TValue> {\n /**\n * The cell to display each row for the column if the cell is an aggregate. If a function is passed, it will be passed a props object with the context of the cell and should return the property type for your adapter (the exact type depends on the adapter being used).\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregatedcell)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n aggregatedCell?: ColumnDefTemplate<\n ReturnType<Cell<TData, TValue>['getContext']>\n >\n /**\n * The resolved aggregation function for the column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#aggregationfn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n aggregationFn?: AggregationFnOption<TData>\n /**\n * Enables/disables grouping for this column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#enablegrouping)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n enableGrouping?: boolean\n /**\n * Specify a value to be used for grouping rows on this column. If this option is not specified, the value derived from `accessorKey` / `accessorFn` will be used instead.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getGroupingValue?: (row: TData) => any\n}\n\nexport interface GroupingColumn<TData extends RowData> {\n /**\n * Returns the aggregation function for the column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getaggregationfn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getAggregationFn: () => AggregationFn<TData> | undefined\n /**\n * Returns the automatically inferred aggregation function for the column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getautoaggregationfn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getAutoAggregationFn: () => AggregationFn<TData> | undefined\n /**\n * Returns whether or not the column can be grouped.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getcangroup)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getCanGroup: () => boolean\n /**\n * Returns the index of the column in the grouping state.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedindex)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getGroupedIndex: () => number\n /**\n * Returns whether or not the column is currently grouped.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getIsGrouped: () => boolean\n /**\n * Returns a function that toggles the grouping state of the column. This is useful for passing to the `onClick` prop of a button.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#gettogglegroupinghandler)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getToggleGroupingHandler: () => () => void\n /**\n * Toggles the grouping state of the column.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#togglegrouping)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n toggleGrouping: () => void\n}\n\nexport interface GroupingRow {\n _groupingValuesCache: Record<string, any>\n /**\n * Returns the grouping value for any row and column (including leaf rows).\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupingvalue)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getGroupingValue: (columnId: string) => unknown\n /**\n * Returns whether or not the row is currently grouped.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getIsGrouped: () => boolean\n /**\n * If this row is grouped, this is the id of the column that this row is grouped by.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupingcolumnid)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n groupingColumnId?: string\n /**\n * If this row is grouped, this is the unique/shared value for the `groupingColumnId` for all of the rows in this group.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupingvalue)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n groupingValue?: unknown\n}\n\nexport interface GroupingCell {\n /**\n * Returns whether or not the cell is currently aggregated.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisaggregated)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getIsAggregated: () => boolean\n /**\n * Returns whether or not the cell is currently grouped.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisgrouped)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getIsGrouped: () => boolean\n /**\n * Returns whether or not the cell is currently a placeholder cell.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getisplaceholder)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getIsPlaceholder: () => boolean\n}\n\nexport interface ColumnDefaultOptions {\n enableGrouping: boolean\n onGroupingChange: OnChangeFn<GroupingState>\n}\n\ninterface GroupingOptionsBase {\n /**\n * Enables/disables grouping for the table.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#enablegrouping)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n enableGrouping?: boolean\n /**\n * Returns the row model after grouping has taken place, but no further.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getGroupedRowModel?: (table: Table<any>) => () => RowModel<any>\n /**\n * Grouping columns are automatically reordered by default to the start of the columns list. If you would rather remove them or leave them as-is, set the appropriate mode here.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#groupedcolumnmode)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n groupedColumnMode?: false | 'reorder' | 'remove'\n /**\n * Enables manual grouping. If this option is set to `true`, the table will not automatically group rows using `getGroupedRowModel()` and instead will expect you to manually group the rows before passing them to the table. This is useful if you are doing server-side grouping and aggregation.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#manualgrouping)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n manualGrouping?: boolean\n /**\n * If this function is provided, it will be called when the grouping state changes and you will be expected to manage the state yourself. You can pass the managed state back to the table via the `tableOptions.state.grouping` option.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#ongroupingchange)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n onGroupingChange?: OnChangeFn<GroupingState>\n}\n\ntype ResolvedAggregationFns = keyof AggregationFns extends never\n ? {\n aggregationFns?: Record<string, AggregationFn<any>>\n }\n : {\n aggregationFns: Record<keyof AggregationFns, AggregationFn<any>>\n }\n\nexport interface GroupingOptions\n extends GroupingOptionsBase,\n ResolvedAggregationFns {}\n\nexport type GroupingColumnMode = false | 'reorder' | 'remove'\n\nexport interface GroupingInstance<TData extends RowData> {\n _getGroupedRowModel?: () => RowModel<TData>\n /**\n * Returns the row model for the table after grouping has been applied.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getgroupedrowmodel)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getGroupedRowModel: () => RowModel<TData>\n /**\n * Returns the row model for the table before any grouping has been applied.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#getpregroupedrowmodel)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n getPreGroupedRowModel: () => RowModel<TData>\n /**\n * Resets the **grouping** state to `initialState.grouping`, or `true` can be passed to force a default blank state reset to `[]`.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#resetgrouping)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n resetGrouping: (defaultState?: boolean) => void\n /**\n * Updates the grouping state of the table via an update function or value.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/grouping#setgrouping)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/grouping)\n */\n setGrouping: (updater: Updater<GroupingState>) => void\n}\n\n//\n\nexport const ColumnGrouping: TableFeature = {\n getDefaultColumnDef: <TData extends RowData>(): GroupingColumnDef<\n TData,\n unknown\n > => {\n return {\n aggregatedCell: props => (props.getValue() as any)?.toString?.() ?? null,\n aggregationFn: 'auto',\n }\n },\n\n getInitialState: (state): GroupingTableState => {\n return {\n grouping: [],\n ...state,\n }\n },\n\n getDefaultOptions: <TData extends RowData>(\n table: Table<TData>\n ): GroupingOptions => {\n return {\n onGroupingChange: makeStateUpdater('grouping', table),\n groupedColumnMode: 'reorder',\n }\n },\n\n createColumn: <TData extends RowData, TValue>(\n column: Column<TData, TValue>,\n table: Table<TData>\n ): void => {\n column.toggleGrouping = () => {\n table.setGrouping(old => {\n // Find any existing grouping for this column\n if (old?.includes(column.id)) {\n return old.filter(d => d !== column.id)\n }\n\n return [...(old ?? []), column.id]\n })\n }\n\n column.getCanGroup = () => {\n return (\n column.columnDef.enableGrouping ??\n true ??\n table.options.enableGrouping ??\n true ??\n !!column.accessorFn\n )\n }\n\n column.getIsGrouped = () => {\n return table.getState().grouping?.includes(column.id)\n }\n\n column.getGroupedIndex = () => table.getState().grouping?.indexOf(column.id)\n\n column.getToggleGroupingHandler = () => {\n const canGroup = column.getCanGroup()\n\n return () => {\n if (!canGroup) return\n column.toggleGrouping()\n }\n }\n column.getAutoAggregationFn = () => {\n const firstRow = table.getCoreRowModel().flatRows[0]\n\n const value = firstRow?.getValue(column.id)\n\n if (typeof value === 'number') {\n return aggregationFns.sum\n }\n\n if (Object.prototype.toString.call(value) === '[object Date]') {\n return aggregationFns.extent\n }\n }\n column.getAggregationFn = () => {\n if (!column) {\n throw new Error()\n }\n\n return isFunction(column.columnDef.aggregationFn)\n ? column.columnDef.aggregationFn\n : column.columnDef.aggregationFn === 'auto'\n ? column.getAutoAggregationFn()\n : table.options.aggregationFns?.[\n column.columnDef.aggregationFn as string\n ] ??\n aggregationFns[\n column.columnDef.aggregationFn as BuiltInAggregationFn\n ]\n }\n },\n\n createTable: <TData extends RowData>(table: Table<TData>): void => {\n table.setGrouping = updater => table.options.onGroupingChange?.(updater)\n\n table.resetGrouping = defaultState => {\n table.setGrouping(defaultState ? [] : table.initialState?.grouping ?? [])\n }\n\n table.getPreGroupedRowModel = () => table.getFilteredRowModel()\n table.getGroupedRowModel = () => {\n if (!table._getGroupedRowModel && table.options.getGroupedRowModel) {\n table._getGroupedRowModel = table.options.getGroupedRowModel(table)\n }\n\n if (table.options.manualGrouping || !table._getGroupedRowModel) {\n return table.getPreGroupedRowModel()\n }\n\n return table._getGroupedRowModel()\n }\n },\n\n createRow: <TData extends RowData>(\n row: Row<TData>,\n table: Table<TData>\n ): void => {\n row.getIsGrouped = () => !!row.groupingColumnId\n row.getGroupingValue = columnId => {\n if (row._groupingValuesCache.hasOwnProperty(columnId)) {\n return row._groupingValuesCache[columnId]\n }\n\n const column = table.getColumn(columnId)\n\n if (!column?.columnDef.getGroupingValue) {\n return row.getValue(columnId)\n }\n\n row._groupingValuesCache[columnId] = column.columnDef.getGroupingValue(\n row.original\n )\n\n return row._groupingValuesCache[columnId]\n }\n row._groupingValuesCache = {}\n },\n\n createCell: <TData extends RowData, TValue>(\n cell: Cell<TData, TValue>,\n column: Column<TData, TValue>,\n row: Row<TData>,\n table: Table<TData>\n ): void => {\n const getRenderValue = () =>\n cell.getValue() ?? table.options.renderFallbackValue\n\n cell.getIsGrouped = () =>\n column.getIsGrouped() && column.id === row.groupingColumnId\n cell.getIsPlaceholder = () => !cell.getIsGrouped() && column.getIsGrouped()\n cell.getIsAggregated = () =>\n !cell.getIsGrouped() && !cell.getIsPlaceholder() && !!row.subRows?.length\n },\n}\n\nexport function orderColumns<TData extends RowData>(\n leafColumns: Column<TData, unknown>[],\n grouping: string[],\n groupedColumnMode?: GroupingColumnMode\n) {\n if (!grouping?.length || !groupedColumnMode) {\n return leafColumns\n }\n\n const nonGroupingColumns = leafColumns.filter(\n col => !grouping.includes(col.id)\n )\n\n if (groupedColumnMode === 'remove') {\n return nonGroupingColumns\n }\n\n const groupingColumns = grouping\n .map(g => leafColumns.find(col => col.id === g)!)\n .filter(Boolean)\n\n return [...groupingColumns, ...nonGroupingColumns]\n}\n"],"names":["ColumnGrouping","getDefaultColumnDef","aggregatedCell","props","_toString","_props$getValue","getValue","toString","aggregationFn","getInitialState","state","grouping","getDefaultOptions","table","onGroupingChange","makeStateUpdater","groupedColumnMode","createColumn","column","toggleGrouping","setGrouping","old","includes","id","filter","d","getCanGroup","_ref","_ref2","_ref3","_column$columnDef$ena","columnDef","enableGrouping","options","accessorFn","getIsGrouped","_table$getState$group","getState","getGroupedIndex","_table$getState$group2","indexOf","getToggleGroupingHandler","canGroup","getAutoAggregationFn","firstRow","getCoreRowModel","flatRows","value","aggregationFns","sum","Object","prototype","call","extent","getAggregationFn","_table$options$aggreg","_table$options$aggreg2","Error","isFunction","createTable","updater","resetGrouping","defaultState","_table$initialState$g","_table$initialState","initialState","getPreGroupedRowModel","getFilteredRowModel","getGroupedRowModel","_getGroupedRowModel","manualGrouping","createRow","row","groupingColumnId","getGroupingValue","columnId","_groupingValuesCache","hasOwnProperty","getColumn","original","createCell","cell","getIsPlaceholder","getIsAggregated","_row$subRows","subRows","length","orderColumns","leafColumns","nonGroupingColumns","col","groupingColumns","map","g","find","Boolean"],"mappings":";;;;;;;;;;;;;;;AA+OA;;AAEO,MAAMA,cAA4B,GAAG;EAC1CC,mBAAmB,EAAEA,MAGhB;IACH,OAAO;AACLC,MAAAA,cAAc,EAAEC,KAAK,IAAA;QAAA,IAAAC,SAAA,EAAAC,eAAA,CAAA;QAAA,OAAAD,CAAAA,SAAA,IAAAC,eAAA,GAAKF,KAAK,CAACG,QAAQ,EAAE,KAAjBD,IAAAA,IAAAA,eAAA,CAA2BE,QAAQ,IAAA,IAAA,GAAA,KAAA,CAAA,GAAnCF,eAAA,CAA2BE,QAAQ,EAAI,KAAA,IAAA,GAAAH,SAAA,GAAI,IAAI,CAAA;AAAA,OAAA;AACxEI,MAAAA,aAAa,EAAE,MAAA;KAChB,CAAA;GACF;EAEDC,eAAe,EAAGC,KAAK,IAAyB;IAC9C,OAAO;AACLC,MAAAA,QAAQ,EAAE,EAAE;MACZ,GAAGD,KAAAA;KACJ,CAAA;GACF;EAEDE,iBAAiB,EACfC,KAAmB,IACC;IACpB,OAAO;AACLC,MAAAA,gBAAgB,EAAEC,sBAAgB,CAAC,UAAU,EAAEF,KAAK,CAAC;AACrDG,MAAAA,iBAAiB,EAAE,SAAA;KACpB,CAAA;GACF;AAEDC,EAAAA,YAAY,EAAEA,CACZC,MAA6B,EAC7BL,KAAmB,KACV;IACTK,MAAM,CAACC,cAAc,GAAG,MAAM;AAC5BN,MAAAA,KAAK,CAACO,WAAW,CAACC,GAAG,IAAI;AACvB;QACA,IAAIA,GAAG,IAAHA,IAAAA,IAAAA,GAAG,CAAEC,QAAQ,CAACJ,MAAM,CAACK,EAAE,CAAC,EAAE;UAC5B,OAAOF,GAAG,CAACG,MAAM,CAACC,CAAC,IAAIA,CAAC,KAAKP,MAAM,CAACK,EAAE,CAAC,CAAA;AACzC,SAAA;AAEA,QAAA,OAAO,CAAC,IAAIF,GAAG,IAAA,IAAA,GAAHA,GAAG,GAAI,EAAE,GAAGH,MAAM,CAACK,EAAE,CAAC,CAAA;AACpC,OAAC,CAAC,CAAA;KACH,CAAA;IAEDL,MAAM,CAACQ,WAAW,GAAG,MAAM;AAAA,MAAA,IAAAC,IAAA,EAAAC,KAAA,EAAAC,KAAA,EAAAC,qBAAA,CAAA;AACzB,MAAA,OAAA,CAAAH,IAAA,GAAAC,CAAAA,KAAA,GAAAC,CAAAA,KAAA,IAAAC,qBAAA,GACEZ,MAAM,CAACa,SAAS,CAACC,cAAc,KAAAF,IAAAA,GAAAA,qBAAA,GAC/B,IAAI,KAAA,IAAA,GAAAD,KAAA,GACJhB,KAAK,CAACoB,OAAO,CAACD,cAAc,YAAAJ,KAAA,GAC5B,IAAI,KAAA,IAAA,GAAAD,IAAA,GACJ,CAAC,CAACT,MAAM,CAACgB,UAAU,CAAA;KAEtB,CAAA;IAEDhB,MAAM,CAACiB,YAAY,GAAG,MAAM;AAAA,MAAA,IAAAC,qBAAA,CAAA;AAC1B,MAAA,OAAA,CAAAA,qBAAA,GAAOvB,KAAK,CAACwB,QAAQ,EAAE,CAAC1B,QAAQ,KAAA,IAAA,GAAA,KAAA,CAAA,GAAzByB,qBAAA,CAA2Bd,QAAQ,CAACJ,MAAM,CAACK,EAAE,CAAC,CAAA;KACtD,CAAA;IAEDL,MAAM,CAACoB,eAAe,GAAG,MAAA;AAAA,MAAA,IAAAC,sBAAA,CAAA;AAAA,MAAA,OAAA,CAAAA,sBAAA,GAAM1B,KAAK,CAACwB,QAAQ,EAAE,CAAC1B,QAAQ,KAAA,IAAA,GAAA,KAAA,CAAA,GAAzB4B,sBAAA,CAA2BC,OAAO,CAACtB,MAAM,CAACK,EAAE,CAAC,CAAA;AAAA,KAAA,CAAA;IAE5EL,MAAM,CAACuB,wBAAwB,GAAG,MAAM;AACtC,MAAA,MAAMC,QAAQ,GAAGxB,MAAM,CAACQ,WAAW,EAAE,CAAA;AAErC,MAAA,OAAO,MAAM;QACX,IAAI,CAACgB,QAAQ,EAAE,OAAA;QACfxB,MAAM,CAACC,cAAc,EAAE,CAAA;OACxB,CAAA;KACF,CAAA;IACDD,MAAM,CAACyB,oBAAoB,GAAG,MAAM;MAClC,MAAMC,QAAQ,GAAG/B,KAAK,CAACgC,eAAe,EAAE,CAACC,QAAQ,CAAC,CAAC,CAAC,CAAA;MAEpD,MAAMC,KAAK,GAAGH,QAAQ,IAARA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,QAAQ,CAAEtC,QAAQ,CAACY,MAAM,CAACK,EAAE,CAAC,CAAA;AAE3C,MAAA,IAAI,OAAOwB,KAAK,KAAK,QAAQ,EAAE;QAC7B,OAAOC,6BAAc,CAACC,GAAG,CAAA;AAC3B,OAAA;AAEA,MAAA,IAAIC,MAAM,CAACC,SAAS,CAAC5C,QAAQ,CAAC6C,IAAI,CAACL,KAAK,CAAC,KAAK,eAAe,EAAE;QAC7D,OAAOC,6BAAc,CAACK,MAAM,CAAA;AAC9B,OAAA;KACD,CAAA;IACDnC,MAAM,CAACoC,gBAAgB,GAAG,MAAM;MAAA,IAAAC,qBAAA,EAAAC,sBAAA,CAAA;MAC9B,IAAI,CAACtC,MAAM,EAAE;QACX,MAAM,IAAIuC,KAAK,EAAE,CAAA;AACnB,OAAA;MAEA,OAAOC,gBAAU,CAACxC,MAAM,CAACa,SAAS,CAACvB,aAAa,CAAC,GAC7CU,MAAM,CAACa,SAAS,CAACvB,aAAa,GAC9BU,MAAM,CAACa,SAAS,CAACvB,aAAa,KAAK,MAAM,GACvCU,MAAM,CAACyB,oBAAoB,EAAE,IAAAY,qBAAA,GAAA,CAAAC,sBAAA,GAC7B3C,KAAK,CAACoB,OAAO,CAACe,cAAc,KAAA,IAAA,GAAA,KAAA,CAAA,GAA5BQ,sBAAA,CACEtC,MAAM,CAACa,SAAS,CAACvB,aAAa,CAC/B,KAAA+C,IAAAA,GAAAA,qBAAA,GACDP,6BAAc,CACZ9B,MAAM,CAACa,SAAS,CAACvB,aAAa,CAC/B,CAAA;KACR,CAAA;GACF;EAEDmD,WAAW,EAA0B9C,KAAmB,IAAW;AACjEA,IAAAA,KAAK,CAACO,WAAW,GAAGwC,OAAO,IAAI/C,KAAK,CAACoB,OAAO,CAACnB,gBAAgB,IAAA,IAAA,GAAA,KAAA,CAAA,GAA9BD,KAAK,CAACoB,OAAO,CAACnB,gBAAgB,CAAG8C,OAAO,CAAC,CAAA;AAExE/C,IAAAA,KAAK,CAACgD,aAAa,GAAGC,YAAY,IAAI;MAAA,IAAAC,qBAAA,EAAAC,mBAAA,CAAA;MACpCnD,KAAK,CAACO,WAAW,CAAC0C,YAAY,GAAG,EAAE,GAAA,CAAAC,qBAAA,GAAA,CAAAC,mBAAA,GAAGnD,KAAK,CAACoD,YAAY,qBAAlBD,mBAAA,CAAoBrD,QAAQ,KAAAoD,IAAAA,GAAAA,qBAAA,GAAI,EAAE,CAAC,CAAA;KAC1E,CAAA;IAEDlD,KAAK,CAACqD,qBAAqB,GAAG,MAAMrD,KAAK,CAACsD,mBAAmB,EAAE,CAAA;IAC/DtD,KAAK,CAACuD,kBAAkB,GAAG,MAAM;MAC/B,IAAI,CAACvD,KAAK,CAACwD,mBAAmB,IAAIxD,KAAK,CAACoB,OAAO,CAACmC,kBAAkB,EAAE;QAClEvD,KAAK,CAACwD,mBAAmB,GAAGxD,KAAK,CAACoB,OAAO,CAACmC,kBAAkB,CAACvD,KAAK,CAAC,CAAA;AACrE,OAAA;MAEA,IAAIA,KAAK,CAACoB,OAAO,CAACqC,cAAc,IAAI,CAACzD,KAAK,CAACwD,mBAAmB,EAAE;AAC9D,QAAA,OAAOxD,KAAK,CAACqD,qBAAqB,EAAE,CAAA;AACtC,OAAA;AAEA,MAAA,OAAOrD,KAAK,CAACwD,mBAAmB,EAAE,CAAA;KACnC,CAAA;GACF;AAEDE,EAAAA,SAAS,EAAEA,CACTC,GAAe,EACf3D,KAAmB,KACV;IACT2D,GAAG,CAACrC,YAAY,GAAG,MAAM,CAAC,CAACqC,GAAG,CAACC,gBAAgB,CAAA;AAC/CD,IAAAA,GAAG,CAACE,gBAAgB,GAAGC,QAAQ,IAAI;MACjC,IAAIH,GAAG,CAACI,oBAAoB,CAACC,cAAc,CAACF,QAAQ,CAAC,EAAE;AACrD,QAAA,OAAOH,GAAG,CAACI,oBAAoB,CAACD,QAAQ,CAAC,CAAA;AAC3C,OAAA;AAEA,MAAA,MAAMzD,MAAM,GAAGL,KAAK,CAACiE,SAAS,CAACH,QAAQ,CAAC,CAAA;MAExC,IAAI,EAACzD,MAAM,IAANA,IAAAA,IAAAA,MAAM,CAAEa,SAAS,CAAC2C,gBAAgB,CAAE,EAAA;AACvC,QAAA,OAAOF,GAAG,CAAClE,QAAQ,CAACqE,QAAQ,CAAC,CAAA;AAC/B,OAAA;AAEAH,MAAAA,GAAG,CAACI,oBAAoB,CAACD,QAAQ,CAAC,GAAGzD,MAAM,CAACa,SAAS,CAAC2C,gBAAgB,CACpEF,GAAG,CAACO,QACN,CAAC,CAAA;AAED,MAAA,OAAOP,GAAG,CAACI,oBAAoB,CAACD,QAAQ,CAAC,CAAA;KAC1C,CAAA;AACDH,IAAAA,GAAG,CAACI,oBAAoB,GAAG,EAAE,CAAA;GAC9B;EAEDI,UAAU,EAAEA,CACVC,IAAyB,EACzB/D,MAA6B,EAC7BsD,GAAe,EACf3D,KAAmB,KACV;AAIToE,IAAAA,IAAI,CAAC9C,YAAY,GAAG,MAClBjB,MAAM,CAACiB,YAAY,EAAE,IAAIjB,MAAM,CAACK,EAAE,KAAKiD,GAAG,CAACC,gBAAgB,CAAA;AAC7DQ,IAAAA,IAAI,CAACC,gBAAgB,GAAG,MAAM,CAACD,IAAI,CAAC9C,YAAY,EAAE,IAAIjB,MAAM,CAACiB,YAAY,EAAE,CAAA;IAC3E8C,IAAI,CAACE,eAAe,GAAG,MAAA;AAAA,MAAA,IAAAC,YAAA,CAAA;MAAA,OACrB,CAACH,IAAI,CAAC9C,YAAY,EAAE,IAAI,CAAC8C,IAAI,CAACC,gBAAgB,EAAE,IAAI,CAAC,EAAAE,CAAAA,YAAA,GAACZ,GAAG,CAACa,OAAO,KAAA,IAAA,IAAXD,YAAA,CAAaE,MAAM,CAAA,CAAA;AAAA,KAAA,CAAA;AAC7E,GAAA;AACF,EAAC;AAEM,SAASC,YAAYA,CAC1BC,WAAqC,EACrC7E,QAAkB,EAClBK,iBAAsC,EACtC;EACA,IAAI,EAACL,QAAQ,IAARA,IAAAA,IAAAA,QAAQ,CAAE2E,MAAM,CAAA,IAAI,CAACtE,iBAAiB,EAAE;AAC3C,IAAA,OAAOwE,WAAW,CAAA;AACpB,GAAA;AAEA,EAAA,MAAMC,kBAAkB,GAAGD,WAAW,CAAChE,MAAM,CAC3CkE,GAAG,IAAI,CAAC/E,QAAQ,CAACW,QAAQ,CAACoE,GAAG,CAACnE,EAAE,CAClC,CAAC,CAAA;EAED,IAAIP,iBAAiB,KAAK,QAAQ,EAAE;AAClC,IAAA,OAAOyE,kBAAkB,CAAA;AAC3B,GAAA;EAEA,MAAME,eAAe,GAAGhF,QAAQ,CAC7BiF,GAAG,CAACC,CAAC,IAAIL,WAAW,CAACM,IAAI,CAACJ,GAAG,IAAIA,GAAG,CAACnE,EAAE,KAAKsE,CAAC,CAAE,CAAC,CAChDrE,MAAM,CAACuE,OAAO,CAAC,CAAA;AAElB,EAAA,OAAO,CAAC,GAAGJ,eAAe,EAAE,GAAGF,kBAAkB,CAAC,CAAA;AACpD;;;;;"}
@@ -1,5 +1,4 @@
1
- import { OnChangeFn, Updater, Column, RowData } from '../types';
2
- import { TableFeature } from '../core/table';
1
+ import { Column, OnChangeFn, RowData, TableFeature, Updater } from '../types';
3
2
  import { ColumnPinningPosition } from '..';
4
3
  export interface ColumnOrderTableState {
5
4
  columnOrder: ColumnOrderState;
@@ -51,4 +50,4 @@ export interface ColumnOrderInstance<TData extends RowData> {
51
50
  */
52
51
  setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
53
52
  }
54
- export declare const Ordering: TableFeature;
53
+ export declare const ColumnOrdering: TableFeature;
@@ -11,12 +11,12 @@
11
11
  'use strict';
12
12
 
13
13
  var utils = require('../utils.js');
14
- var Grouping = require('./Grouping.js');
15
- var Visibility = require('./Visibility.js');
14
+ var ColumnGrouping = require('./ColumnGrouping.js');
15
+ var ColumnVisibility = require('./ColumnVisibility.js');
16
16
 
17
17
  //
18
18
 
19
- const Ordering = {
19
+ const ColumnOrdering = {
20
20
  getInitialState: state => {
21
21
  return {
22
22
  columnOrder: [],
@@ -29,15 +29,15 @@ const Ordering = {
29
29
  };
30
30
  },
31
31
  createColumn: (column, table) => {
32
- column.getIndex = utils.memo(position => [Visibility._getVisibleLeafColumns(table, position)], columns => columns.findIndex(d => d.id === column.id), utils.getMemoOptions(table.options, 'debugColumns', 'getIndex'));
32
+ column.getIndex = utils.memo(position => [ColumnVisibility._getVisibleLeafColumns(table, position)], columns => columns.findIndex(d => d.id === column.id), utils.getMemoOptions(table.options, 'debugColumns', 'getIndex'));
33
33
  column.getIsFirstColumn = position => {
34
34
  var _columns$;
35
- const columns = Visibility._getVisibleLeafColumns(table, position);
35
+ const columns = ColumnVisibility._getVisibleLeafColumns(table, position);
36
36
  return ((_columns$ = columns[0]) == null ? void 0 : _columns$.id) === column.id;
37
37
  };
38
38
  column.getIsLastColumn = position => {
39
39
  var _columns;
40
- const columns = Visibility._getVisibleLeafColumns(table, position);
40
+ const columns = ColumnVisibility._getVisibleLeafColumns(table, position);
41
41
  return ((_columns = columns[columns.length - 1]) == null ? void 0 : _columns.id) === column.id;
42
42
  };
43
43
  },
@@ -75,10 +75,10 @@ const Ordering = {
75
75
  // If there are any columns left, add them to the end
76
76
  orderedColumns = [...orderedColumns, ...columnsCopy];
77
77
  }
78
- return Grouping.orderColumns(orderedColumns, grouping, groupedColumnMode);
78
+ return ColumnGrouping.orderColumns(orderedColumns, grouping, groupedColumnMode);
79
79
  }, utils.getMemoOptions(table.options, 'debugTable', '_getOrderColumnsFn'));
80
80
  }
81
81
  };
82
82
 
83
- exports.Ordering = Ordering;
84
- //# sourceMappingURL=Ordering.js.map
83
+ exports.ColumnOrdering = ColumnOrdering;
84
+ //# sourceMappingURL=ColumnOrdering.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ColumnOrdering.js","sources":["../../../src/features/ColumnOrdering.ts"],"sourcesContent":["import { getMemoOptions, makeStateUpdater, memo } from '../utils'\n\nimport {\n Column,\n OnChangeFn,\n RowData,\n Table,\n TableFeature,\n Updater,\n} from '../types'\n\nimport { orderColumns } from './ColumnGrouping'\nimport { ColumnPinningPosition, _getVisibleLeafColumns } from '..'\n\nexport interface ColumnOrderTableState {\n columnOrder: ColumnOrderState\n}\n\nexport type ColumnOrderState = string[]\n\nexport interface ColumnOrderOptions {\n /**\n * If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#oncolumnorderchange)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n */\n onColumnOrderChange?: OnChangeFn<ColumnOrderState>\n}\n\nexport interface ColumnOrderColumn {\n /**\n * Returns the index of the column in the order of the visible columns. Optionally pass a `position` parameter to get the index of the column in a sub-section of the table\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getindex)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n */\n getIndex: (position?: ColumnPinningPosition | 'center') => number\n /**\n * Returns `true` if the column is the first column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the first in a sub-section of the table.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getisfirstcolumn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n */\n getIsFirstColumn: (position?: ColumnPinningPosition | 'center') => boolean\n /**\n * Returns `true` if the column is the last column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the last in a sub-section of the table.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getislastcolumn)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n */\n getIsLastColumn: (position?: ColumnPinningPosition | 'center') => boolean\n}\n\nexport interface ColumnOrderDefaultOptions {\n onColumnOrderChange: OnChangeFn<ColumnOrderState>\n}\n\nexport interface ColumnOrderInstance<TData extends RowData> {\n _getOrderColumnsFn: () => (\n columns: Column<TData, unknown>[]\n ) => Column<TData, unknown>[]\n /**\n * Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#resetcolumnorder)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n */\n resetColumnOrder: (defaultState?: boolean) => void\n /**\n * Sets or updates the `state.columnOrder` state.\n * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#setcolumnorder)\n * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n */\n setColumnOrder: (updater: Updater<ColumnOrderState>) => void\n}\n\n//\n\nexport const ColumnOrdering: TableFeature = {\n getInitialState: (state): ColumnOrderTableState => {\n return {\n columnOrder: [],\n ...state,\n }\n },\n\n getDefaultOptions: <TData extends RowData>(\n table: Table<TData>\n ): ColumnOrderDefaultOptions => {\n return {\n onColumnOrderChange: makeStateUpdater('columnOrder', table),\n }\n },\n\n createColumn: <TData extends RowData>(\n column: Column<TData, unknown>,\n table: Table<TData>\n ): void => {\n column.getIndex = memo(\n position => [_getVisibleLeafColumns(table, position)],\n columns => columns.findIndex(d => d.id === column.id),\n getMemoOptions(table.options, 'debugColumns', 'getIndex')\n )\n column.getIsFirstColumn = position => {\n const columns = _getVisibleLeafColumns(table, position)\n return columns[0]?.id === column.id\n }\n column.getIsLastColumn = position => {\n const columns = _getVisibleLeafColumns(table, position)\n return columns[columns.length - 1]?.id === column.id\n }\n },\n\n createTable: <TData extends RowData>(table: Table<TData>): void => {\n table.setColumnOrder = updater =>\n table.options.onColumnOrderChange?.(updater)\n table.resetColumnOrder = defaultState => {\n table.setColumnOrder(\n defaultState ? [] : table.initialState.columnOrder ?? []\n )\n }\n table._getOrderColumnsFn = memo(\n () => [\n table.getState().columnOrder,\n table.getState().grouping,\n table.options.groupedColumnMode,\n ],\n (columnOrder, grouping, groupedColumnMode) =>\n (columns: Column<TData, unknown>[]) => {\n // Sort grouped columns to the start of the column list\n // before the headers are built\n let orderedColumns: Column<TData, unknown>[] = []\n\n // If there is no order, return the normal columns\n if (!columnOrder?.length) {\n orderedColumns = columns\n } else {\n const columnOrderCopy = [...columnOrder]\n\n // If there is an order, make a copy of the columns\n const columnsCopy = [...columns]\n\n // And make a new ordered array of the columns\n\n // Loop over the columns and place them in order into the new array\n while (columnsCopy.length && columnOrderCopy.length) {\n const targetColumnId = columnOrderCopy.shift()\n const foundIndex = columnsCopy.findIndex(\n d => d.id === targetColumnId\n )\n if (foundIndex > -1) {\n orderedColumns.push(columnsCopy.splice(foundIndex, 1)[0]!)\n }\n }\n\n // If there are any columns left, add them to the end\n orderedColumns = [...orderedColumns, ...columnsCopy]\n }\n\n return orderColumns(orderedColumns, grouping, groupedColumnMode)\n },\n getMemoOptions(table.options, 'debugTable', '_getOrderColumnsFn')\n )\n },\n}\n"],"names":["ColumnOrdering","getInitialState","state","columnOrder","getDefaultOptions","table","onColumnOrderChange","makeStateUpdater","createColumn","column","getIndex","memo","position","_getVisibleLeafColumns","columns","findIndex","d","id","getMemoOptions","options","getIsFirstColumn","_columns$","getIsLastColumn","_columns","length","createTable","setColumnOrder","updater","resetColumnOrder","defaultState","_table$initialState$c","initialState","_getOrderColumnsFn","getState","grouping","groupedColumnMode","orderedColumns","columnOrderCopy","columnsCopy","targetColumnId","shift","foundIndex","push","splice","orderColumns"],"mappings":";;;;;;;;;;;;;;;;AAwEA;;AAEO,MAAMA,cAA4B,GAAG;EAC1CC,eAAe,EAAGC,KAAK,IAA4B;IACjD,OAAO;AACLC,MAAAA,WAAW,EAAE,EAAE;MACf,GAAGD,KAAAA;KACJ,CAAA;GACF;EAEDE,iBAAiB,EACfC,KAAmB,IACW;IAC9B,OAAO;AACLC,MAAAA,mBAAmB,EAAEC,sBAAgB,CAAC,aAAa,EAAEF,KAAK,CAAA;KAC3D,CAAA;GACF;AAEDG,EAAAA,YAAY,EAAEA,CACZC,MAA8B,EAC9BJ,KAAmB,KACV;AACTI,IAAAA,MAAM,CAACC,QAAQ,GAAGC,UAAI,CACpBC,QAAQ,IAAI,CAACC,uCAAsB,CAACR,KAAK,EAAEO,QAAQ,CAAC,CAAC,EACrDE,OAAO,IAAIA,OAAO,CAACC,SAAS,CAACC,CAAC,IAAIA,CAAC,CAACC,EAAE,KAAKR,MAAM,CAACQ,EAAE,CAAC,EACrDC,oBAAc,CAACb,KAAK,CAACc,OAAO,EAAE,cAAc,EAAE,UAAU,CAC1D,CAAC,CAAA;AACDV,IAAAA,MAAM,CAACW,gBAAgB,GAAGR,QAAQ,IAAI;AAAA,MAAA,IAAAS,SAAA,CAAA;AACpC,MAAA,MAAMP,OAAO,GAAGD,uCAAsB,CAACR,KAAK,EAAEO,QAAQ,CAAC,CAAA;AACvD,MAAA,OAAO,CAAAS,CAAAA,SAAA,GAAAP,OAAO,CAAC,CAAC,CAAC,KAAVO,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,SAAA,CAAYJ,EAAE,MAAKR,MAAM,CAACQ,EAAE,CAAA;KACpC,CAAA;AACDR,IAAAA,MAAM,CAACa,eAAe,GAAGV,QAAQ,IAAI;AAAA,MAAA,IAAAW,QAAA,CAAA;AACnC,MAAA,MAAMT,OAAO,GAAGD,uCAAsB,CAACR,KAAK,EAAEO,QAAQ,CAAC,CAAA;AACvD,MAAA,OAAO,EAAAW,QAAA,GAAAT,OAAO,CAACA,OAAO,CAACU,MAAM,GAAG,CAAC,CAAC,qBAA3BD,QAAA,CAA6BN,EAAE,MAAKR,MAAM,CAACQ,EAAE,CAAA;KACrD,CAAA;GACF;EAEDQ,WAAW,EAA0BpB,KAAmB,IAAW;AACjEA,IAAAA,KAAK,CAACqB,cAAc,GAAGC,OAAO,IAC5BtB,KAAK,CAACc,OAAO,CAACb,mBAAmB,IAAA,IAAA,GAAA,KAAA,CAAA,GAAjCD,KAAK,CAACc,OAAO,CAACb,mBAAmB,CAAGqB,OAAO,CAAC,CAAA;AAC9CtB,IAAAA,KAAK,CAACuB,gBAAgB,GAAGC,YAAY,IAAI;AAAA,MAAA,IAAAC,qBAAA,CAAA;AACvCzB,MAAAA,KAAK,CAACqB,cAAc,CAClBG,YAAY,GAAG,EAAE,IAAAC,qBAAA,GAAGzB,KAAK,CAAC0B,YAAY,CAAC5B,WAAW,YAAA2B,qBAAA,GAAI,EACxD,CAAC,CAAA;KACF,CAAA;AACDzB,IAAAA,KAAK,CAAC2B,kBAAkB,GAAGrB,UAAI,CAC7B,MAAM,CACJN,KAAK,CAAC4B,QAAQ,EAAE,CAAC9B,WAAW,EAC5BE,KAAK,CAAC4B,QAAQ,EAAE,CAACC,QAAQ,EACzB7B,KAAK,CAACc,OAAO,CAACgB,iBAAiB,CAChC,EACD,CAAChC,WAAW,EAAE+B,QAAQ,EAAEC,iBAAiB,KACtCrB,OAAiC,IAAK;AACrC;AACA;MACA,IAAIsB,cAAwC,GAAG,EAAE,CAAA;;AAEjD;AACA,MAAA,IAAI,EAACjC,WAAW,IAAA,IAAA,IAAXA,WAAW,CAAEqB,MAAM,CAAE,EAAA;AACxBY,QAAAA,cAAc,GAAGtB,OAAO,CAAA;AAC1B,OAAC,MAAM;AACL,QAAA,MAAMuB,eAAe,GAAG,CAAC,GAAGlC,WAAW,CAAC,CAAA;;AAExC;AACA,QAAA,MAAMmC,WAAW,GAAG,CAAC,GAAGxB,OAAO,CAAC,CAAA;;AAEhC;;AAEA;AACA,QAAA,OAAOwB,WAAW,CAACd,MAAM,IAAIa,eAAe,CAACb,MAAM,EAAE;AACnD,UAAA,MAAMe,cAAc,GAAGF,eAAe,CAACG,KAAK,EAAE,CAAA;AAC9C,UAAA,MAAMC,UAAU,GAAGH,WAAW,CAACvB,SAAS,CACtCC,CAAC,IAAIA,CAAC,CAACC,EAAE,KAAKsB,cAChB,CAAC,CAAA;AACD,UAAA,IAAIE,UAAU,GAAG,CAAC,CAAC,EAAE;AACnBL,YAAAA,cAAc,CAACM,IAAI,CAACJ,WAAW,CAACK,MAAM,CAACF,UAAU,EAAE,CAAC,CAAC,CAAC,CAAC,CAAE,CAAC,CAAA;AAC5D,WAAA;AACF,SAAA;;AAEA;AACAL,QAAAA,cAAc,GAAG,CAAC,GAAGA,cAAc,EAAE,GAAGE,WAAW,CAAC,CAAA;AACtD,OAAA;AAEA,MAAA,OAAOM,2BAAY,CAACR,cAAc,EAAEF,QAAQ,EAAEC,iBAAiB,CAAC,CAAA;KACjE,EACHjB,oBAAc,CAACb,KAAK,CAACc,OAAO,EAAE,YAAY,EAAE,oBAAoB,CAClE,CAAC,CAAA;AACH,GAAA;AACF;;;;"}
@@ -0,0 +1,126 @@
1
+ import { OnChangeFn, Updater, Column, Cell, RowData, TableFeature } from '../types';
2
+ export type ColumnPinningPosition = false | 'left' | 'right';
3
+ export interface ColumnPinningState {
4
+ left?: string[];
5
+ right?: string[];
6
+ }
7
+ export interface ColumnPinningTableState {
8
+ columnPinning: ColumnPinningState;
9
+ }
10
+ export interface ColumnPinningOptions {
11
+ /**
12
+ * Enables/disables column pinning for the table. Defaults to `true`.
13
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablecolumnpinning)
14
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
15
+ */
16
+ enableColumnPinning?: boolean;
17
+ /**
18
+ * @deprecated Use `enableColumnPinning` or `enableRowPinning` instead.
19
+ * Enables/disables all pinning for the table. Defaults to `true`.
20
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning)
21
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
22
+ */
23
+ enablePinning?: boolean;
24
+ /**
25
+ * If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state.
26
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#oncolumnpinningchange)
27
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/oncolumnpinningchange)
28
+ */
29
+ onColumnPinningChange?: OnChangeFn<ColumnPinningState>;
30
+ }
31
+ export interface ColumnPinningDefaultOptions {
32
+ onColumnPinningChange: OnChangeFn<ColumnPinningState>;
33
+ }
34
+ export interface ColumnPinningColumnDef {
35
+ /**
36
+ * Enables/disables column pinning for this column. Defaults to `true`.
37
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning-1)
38
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
39
+ */
40
+ enablePinning?: boolean;
41
+ }
42
+ export interface ColumnPinningColumn {
43
+ /**
44
+ * Returns whether or not the column can be pinned.
45
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcanpin)
46
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
47
+ */
48
+ getCanPin: () => boolean;
49
+ /**
50
+ * Returns the pinned position of the column. (`'left'`, `'right'` or `false`)
51
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getispinned)
52
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
53
+ */
54
+ getIsPinned: () => ColumnPinningPosition;
55
+ /**
56
+ * Returns the numeric pinned index of the column within a pinned column group.
57
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getpinnedindex)
58
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
59
+ */
60
+ getPinnedIndex: () => number;
61
+ /**
62
+ * Pins a column to the `'left'` or `'right'`, or unpins the column to the center if `false` is passed.
63
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#pin)
64
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
65
+ */
66
+ pin: (position: ColumnPinningPosition) => void;
67
+ }
68
+ export interface ColumnPinningRow<TData extends RowData> {
69
+ /**
70
+ * Returns all center pinned (unpinned) leaf cells in the row.
71
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcentervisiblecells)
72
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
73
+ */
74
+ getCenterVisibleCells: () => Cell<TData, unknown>[];
75
+ /**
76
+ * Returns all left pinned leaf cells in the row.
77
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftvisiblecells)
78
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
79
+ */
80
+ getLeftVisibleCells: () => Cell<TData, unknown>[];
81
+ /**
82
+ * Returns all right pinned leaf cells in the row.
83
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightvisiblecells)
84
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
85
+ */
86
+ getRightVisibleCells: () => Cell<TData, unknown>[];
87
+ }
88
+ export interface ColumnPinningInstance<TData extends RowData> {
89
+ /**
90
+ * Returns all center pinned (unpinned) leaf columns.
91
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcenterleafcolumns)
92
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
93
+ */
94
+ getCenterLeafColumns: () => Column<TData, unknown>[];
95
+ /**
96
+ * Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the `left` or `right` position.
97
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getissomecolumnspinned)
98
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
99
+ */
100
+ getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean;
101
+ /**
102
+ * Returns all left pinned leaf columns.
103
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftleafcolumns)
104
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
105
+ */
106
+ getLeftLeafColumns: () => Column<TData, unknown>[];
107
+ /**
108
+ * Returns all right pinned leaf columns.
109
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightleafcolumns)
110
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
111
+ */
112
+ getRightLeafColumns: () => Column<TData, unknown>[];
113
+ /**
114
+ * Resets the **columnPinning** state to `initialState.columnPinning`, or `true` can be passed to force a default blank state reset to `{ left: [], right: [], }`.
115
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#resetcolumnpinning)
116
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
117
+ */
118
+ resetColumnPinning: (defaultState?: boolean) => void;
119
+ /**
120
+ * Sets or updates the `state.columnPinning` state.
121
+ * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#setcolumnpinning)
122
+ * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
123
+ */
124
+ setColumnPinning: (updater: Updater<ColumnPinningState>) => void;
125
+ }
126
+ export declare const ColumnPinning: TableFeature;