@tanstack/table-core 9.0.0-alpha.47 → 9.0.0-alpha.48

package/dist/features/global-filtering/globalFilteringFeature.utils.cjs

@@ -3,13 +3,14 @@ const require_filterFns = require('../../fns/filterFns.cjs');
 
 //#region src/features/global-filtering/globalFilteringFeature.utils.ts
 /**
-* Returns whether a column can use global filter.
+* Checks whether this accessor column participates in global filtering.
 *
-* This combines column options, table options, and any required accessor or feature state for the capability.
+* The column must have an accessor and pass column-level, table-level, and
+* optional `getColumnCanGlobalFilter` checks.
 *
 * @example
 * ```ts
-* const value = column_getCanGlobalFilter(column)
+* const canGlobalFilter = column_getCanGlobalFilter(column)
 * ```
 */
 function column_getCanGlobalFilter(column) {
@@ -17,26 +18,29 @@ function column_getCanGlobalFilter(column) {
 	return (column.columnDef.enableGlobalFilter ?? true) && (column.table.options.enableGlobalFilter ?? true) && (column.table.options.enableFilters ?? true) && (((_column$table$options = (_column$table$options2 = column.table.options).getColumnCanGlobalFilter) === null || _column$table$options === void 0 ? void 0 : _column$table$options.call(_column$table$options2, column)) ?? true) && !!column.accessorFn;
 }
 /**
-* Returns global auto filter fn for the table.
+* Provides the built-in automatic global filter function.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Global filtering defaults to `includesString`, which gives search-box style
+* matching across globally filterable columns.
 *
 * @example
 * ```ts
-* const value = table_getGlobalAutoFilterFn(table)
+* const filterFn = table_getGlobalAutoFilterFn()
 * ```
 */
 function table_getGlobalAutoFilterFn() {
 	return require_filterFns.filterFn_includesString;
 }
 /**
-* Returns global filter fn for the table.
+* Resolves the filter function used for global filtering.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+* delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+* the table's filter function registry.
 *
 * @example
 * ```ts
-* const value = table_getGlobalFilterFn(table)
+* const filterFn = table_getGlobalFilterFn(table)
 * ```
 */
 function table_getGlobalFilterFn(table) {
@@ -45,13 +49,14 @@ function table_getGlobalFilterFn(table) {
 	return require_utils.isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === "auto" ? table_getGlobalAutoFilterFn() : filterFns === null || filterFns === void 0 ? void 0 : filterFns[globalFilterFn];
 }
 /**
-* Updates the table's global filter state slice.
+* Routes a global filter updater through the table's global filter handler.
 *
-* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+* The updater may be a next value or a function of the previous value, matching
+* the instance `table.setGlobalFilter` behavior.
 *
 * @example
 * ```ts
-* table_setGlobalFilter(table, (old) => old)
+* table_setGlobalFilter(table, 'search text')
 * ```
 */
 function table_setGlobalFilter(table, updater) {
@@ -59,9 +64,10 @@ function table_setGlobalFilter(table, updater) {
 	(_table$options$onGlob = (_table$options = table.options).onGlobalFilterChange) === null || _table$options$onGlob === void 0 || _table$options$onGlob.call(_table$options, updater);
 }
 /**
-* Resets the table's global filter state slice.
+* Resets `globalFilter` to the configured initial state or feature default.
 *
-* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+* With no argument, the reset clones `table.initialState.globalFilter`. Passing
+* `true` ignores initial state and resets to `undefined`.
 *
 * @example
 * ```ts

package/dist/features/global-filtering/globalFilteringFeature.utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"globalFilteringFeature.utils.cjs","names":["filterFn_includesString","isFunction","cloneState"],"sources":["../../../src/features/global-filtering/globalFilteringFeature.utils.ts"],"sourcesContent":["import { filterFn_includesString } from '../../fns/filterFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { FilterFn } from '../column-filtering/columnFilteringFeature.types'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\n\n/**\n * Returns whether a column can use global filter.\n *\n * This combines column options, table options, and any required accessor or feature state for the capability.\n *\n * @example\n * ```ts\n * const value = column_getCanGlobalFilter(column)\n * ```\n */\nexport function column_getCanGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    (column.columnDef.enableGlobalFilter ?? true) &&\n    (column.table.options.enableGlobalFilter ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    (column.table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Returns global auto filter fn for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getGlobalAutoFilterFn(table)\n * ```\n */\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\n}\n\n/**\n * Returns global filter fn for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getGlobalFilterFn(table)\n * ```\n */\nexport function table_getGlobalFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined {\n  const { globalFilterFn: globalFilterFn } = table.options\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    table._rowModelFns.filterFns\n\n  return isFunction(globalFilterFn)\n    ? globalFilterFn\n    : globalFilterFn === 'auto'\n      ? table_getGlobalAutoFilterFn()\n      : filterFns?.[globalFilterFn as string]\n}\n\n/**\n * Updates the table's global filter state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_setGlobalFilter(table, (old) => old)\n * ```\n */\nexport function table_setGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: any) {\n  table.options.onGlobalFilterChange?.(updater)\n}\n\n/**\n * Resets the table's global filter state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_resetGlobalFilter(table)\n * table_resetGlobalFilter(table, true)\n * ```\n */\nexport function table_resetGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGlobalFilter(\n    table,\n    defaultState ? undefined : cloneState(table.initialState.globalFilter),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;AAkBA,SAAgB,0BAId,QAA4D;;CAC5D,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,OAAO,KAAI,SAC5D,CAAC,CAAC,OAAO;;;;;;;;;;;;AAcb,SAAgB,8BAA8B;CAC5C,OAAOA;;;;;;;;;;;;AAaT,SAAgB,wBAId,OACqE;CACrE,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;CAErB,OAAOC,yBAAW,eAAe,GAC7B,iBACA,mBAAmB,SACjB,6BAA6B,yDAC7B,UAAY;;;;;;;;;;;;AAapB,SAAgB,sBAGd,OAAyC,SAAc;;CACvD,iDAAM,SAAQ,iHAAuB,QAAQ;;;;;;;;;;;;;AAc/C,SAAgB,wBAGd,OAAyC,cAAwB;CACjE,sBACE,OACA,eAAe,SAAYC,yBAAW,MAAM,aAAa,aAAa,CACvE"}
+{"version":3,"file":"globalFilteringFeature.utils.cjs","names":["filterFn_includesString","isFunction","cloneState"],"sources":["../../../src/features/global-filtering/globalFilteringFeature.utils.ts"],"sourcesContent":["import { filterFn_includesString } from '../../fns/filterFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { FilterFn } from '../column-filtering/columnFilteringFeature.types'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\n\n/**\n * Checks whether this accessor column participates in global filtering.\n *\n * The column must have an accessor and pass column-level, table-level, and\n * optional `getColumnCanGlobalFilter` checks.\n *\n * @example\n * ```ts\n * const canGlobalFilter = column_getCanGlobalFilter(column)\n * ```\n */\nexport function column_getCanGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    (column.columnDef.enableGlobalFilter ?? true) &&\n    (column.table.options.enableGlobalFilter ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    (column.table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Provides the built-in automatic global filter function.\n *\n * Global filtering defaults to `includesString`, which gives search-box style\n * matching across globally filterable columns.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalAutoFilterFn()\n * ```\n */\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\n}\n\n/**\n * Resolves the filter function used for global filtering.\n *\n * Function-valued `options.globalFilterFn` is returned directly, `'auto'`\n * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in\n * the table's filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalFilterFn(table)\n * ```\n */\nexport function table_getGlobalFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined {\n  const { globalFilterFn: globalFilterFn } = table.options\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    table._rowModelFns.filterFns\n\n  return isFunction(globalFilterFn)\n    ? globalFilterFn\n    : globalFilterFn === 'auto'\n      ? table_getGlobalAutoFilterFn()\n      : filterFns?.[globalFilterFn as string]\n}\n\n/**\n * Routes a global filter updater through the table's global filter handler.\n *\n * The updater may be a next value or a function of the previous value, matching\n * the instance `table.setGlobalFilter` behavior.\n *\n * @example\n * ```ts\n * table_setGlobalFilter(table, 'search text')\n * ```\n */\nexport function table_setGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: any) {\n  table.options.onGlobalFilterChange?.(updater)\n}\n\n/**\n * Resets `globalFilter` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.globalFilter`. Passing\n * `true` ignores initial state and resets to `undefined`.\n *\n * @example\n * ```ts\n * table_resetGlobalFilter(table)\n * table_resetGlobalFilter(table, true)\n * ```\n */\nexport function table_resetGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGlobalFilter(\n    table,\n    defaultState ? undefined : cloneState(table.initialState.globalFilter),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;AAmBA,SAAgB,0BAId,QAA4D;;CAC5D,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,OAAO,KAAI,SAC5D,CAAC,CAAC,OAAO;;;;;;;;;;;;;AAeb,SAAgB,8BAA8B;CAC5C,OAAOA;;;;;;;;;;;;;;AAeT,SAAgB,wBAId,OACqE;CACrE,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;CAErB,OAAOC,yBAAW,eAAe,GAC7B,iBACA,mBAAmB,SACjB,6BAA6B,yDAC7B,UAAY;;;;;;;;;;;;;AAcpB,SAAgB,sBAGd,OAAyC,SAAc;;CACvD,iDAAM,SAAQ,iHAAuB,QAAQ;;;;;;;;;;;;;;AAe/C,SAAgB,wBAGd,OAAyC,cAAwB;CACjE,sBACE,OACA,eAAe,SAAYC,yBAAW,MAAM,aAAa,aAAa,CACvE"}

package/dist/features/global-filtering/globalFilteringFeature.utils.d.cts

@@ -6,53 +6,59 @@ import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/global-filtering/globalFilteringFeature.utils.d.ts
 /**
- * Returns whether a column can use global filter.
+ * Checks whether this accessor column participates in global filtering.
  *
- * This combines column options, table options, and any required accessor or feature state for the capability.
+ * The column must have an accessor and pass column-level, table-level, and
+ * optional `getColumnCanGlobalFilter` checks.
  *
  * @example
  * ```ts
- * const value = column_getCanGlobalFilter(column)
+ * const canGlobalFilter = column_getCanGlobalFilter(column)
  * ```
  */
 declare function column_getCanGlobalFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns global auto filter fn for the table.
+ * Provides the built-in automatic global filter function.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Global filtering defaults to `includesString`, which gives search-box style
+ * matching across globally filterable columns.
  *
  * @example
  * ```ts
- * const value = table_getGlobalAutoFilterFn(table)
+ * const filterFn = table_getGlobalAutoFilterFn()
  * ```
  */
 declare function table_getGlobalAutoFilterFn(): FilterFn<any, any>;
 /**
- * Returns global filter fn for the table.
+ * Resolves the filter function used for global filtering.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+ * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+ * the table's filter function registry.
  *
  * @example
  * ```ts
- * const value = table_getGlobalFilterFn(table)
+ * const filterFn = table_getGlobalFilterFn(table)
  * ```
  */
 declare function table_getGlobalFilterFn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined;
 /**
- * Updates the table's global filter state slice.
+ * Routes a global filter updater through the table's global filter handler.
  *
- * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ * The updater may be a next value or a function of the previous value, matching
+ * the instance `table.setGlobalFilter` behavior.
  *
  * @example
  * ```ts
- * table_setGlobalFilter(table, (old) => old)
+ * table_setGlobalFilter(table, 'search text')
  * ```
  */
 declare function table_setGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: any): void;
 /**
- * Resets the table's global filter state slice.
+ * Resets `globalFilter` to the configured initial state or feature default.
  *
- * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ * With no argument, the reset clones `table.initialState.globalFilter`. Passing
+ * `true` ignores initial state and resets to `undefined`.
  *
  * @example
  * ```ts

package/dist/features/global-filtering/globalFilteringFeature.utils.d.ts

@@ -6,53 +6,59 @@ import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/global-filtering/globalFilteringFeature.utils.d.ts
 /**
- * Returns whether a column can use global filter.
+ * Checks whether this accessor column participates in global filtering.
  *
- * This combines column options, table options, and any required accessor or feature state for the capability.
+ * The column must have an accessor and pass column-level, table-level, and
+ * optional `getColumnCanGlobalFilter` checks.
  *
  * @example
  * ```ts
- * const value = column_getCanGlobalFilter(column)
+ * const canGlobalFilter = column_getCanGlobalFilter(column)
  * ```
  */
 declare function column_getCanGlobalFilter<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
 /**
- * Returns global auto filter fn for the table.
+ * Provides the built-in automatic global filter function.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Global filtering defaults to `includesString`, which gives search-box style
+ * matching across globally filterable columns.
  *
  * @example
  * ```ts
- * const value = table_getGlobalAutoFilterFn(table)
+ * const filterFn = table_getGlobalAutoFilterFn()
  * ```
  */
 declare function table_getGlobalAutoFilterFn(): FilterFn<any, any>;
 /**
- * Returns global filter fn for the table.
+ * Resolves the filter function used for global filtering.
  *
- * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ * Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+ * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+ * the table's filter function registry.
  *
  * @example
  * ```ts
- * const value = table_getGlobalFilterFn(table)
+ * const filterFn = table_getGlobalFilterFn(table)
  * ```
  */
 declare function table_getGlobalFilterFn<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined;
 /**
- * Updates the table's global filter state slice.
+ * Routes a global filter updater through the table's global filter handler.
  *
- * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ * The updater may be a next value or a function of the previous value, matching
+ * the instance `table.setGlobalFilter` behavior.
  *
  * @example
  * ```ts
- * table_setGlobalFilter(table, (old) => old)
+ * table_setGlobalFilter(table, 'search text')
  * ```
  */
 declare function table_setGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: any): void;
 /**
- * Resets the table's global filter state slice.
+ * Resets `globalFilter` to the configured initial state or feature default.
  *
- * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ * With no argument, the reset clones `table.initialState.globalFilter`. Passing
+ * `true` ignores initial state and resets to `undefined`.
  *
  * @example
  * ```ts

package/dist/features/global-filtering/globalFilteringFeature.utils.js

@@ -3,13 +3,14 @@ import { filterFn_includesString } from "../../fns/filterFns.js";
 
 //#region src/features/global-filtering/globalFilteringFeature.utils.ts
 /**
-* Returns whether a column can use global filter.
+* Checks whether this accessor column participates in global filtering.
 *
-* This combines column options, table options, and any required accessor or feature state for the capability.
+* The column must have an accessor and pass column-level, table-level, and
+* optional `getColumnCanGlobalFilter` checks.
 *
 * @example
 * ```ts
-* const value = column_getCanGlobalFilter(column)
+* const canGlobalFilter = column_getCanGlobalFilter(column)
 * ```
 */
 function column_getCanGlobalFilter(column) {
@@ -17,26 +18,29 @@ function column_getCanGlobalFilter(column) {
 	return (column.columnDef.enableGlobalFilter ?? true) && (column.table.options.enableGlobalFilter ?? true) && (column.table.options.enableFilters ?? true) && (((_column$table$options = (_column$table$options2 = column.table.options).getColumnCanGlobalFilter) === null || _column$table$options === void 0 ? void 0 : _column$table$options.call(_column$table$options2, column)) ?? true) && !!column.accessorFn;
 }
 /**
-* Returns global auto filter fn for the table.
+* Provides the built-in automatic global filter function.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Global filtering defaults to `includesString`, which gives search-box style
+* matching across globally filterable columns.
 *
 * @example
 * ```ts
-* const value = table_getGlobalAutoFilterFn(table)
+* const filterFn = table_getGlobalAutoFilterFn()
 * ```
 */
 function table_getGlobalAutoFilterFn() {
 	return filterFn_includesString;
 }
 /**
-* Returns global filter fn for the table.
+* Resolves the filter function used for global filtering.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Function-valued `options.globalFilterFn` is returned directly, `'auto'`
+* delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in
+* the table's filter function registry.
 *
 * @example
 * ```ts
-* const value = table_getGlobalFilterFn(table)
+* const filterFn = table_getGlobalFilterFn(table)
 * ```
 */
 function table_getGlobalFilterFn(table) {
@@ -45,13 +49,14 @@ function table_getGlobalFilterFn(table) {
 	return isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === "auto" ? table_getGlobalAutoFilterFn() : filterFns === null || filterFns === void 0 ? void 0 : filterFns[globalFilterFn];
 }
 /**
-* Updates the table's global filter state slice.
+* Routes a global filter updater through the table's global filter handler.
 *
-* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+* The updater may be a next value or a function of the previous value, matching
+* the instance `table.setGlobalFilter` behavior.
 *
 * @example
 * ```ts
-* table_setGlobalFilter(table, (old) => old)
+* table_setGlobalFilter(table, 'search text')
 * ```
 */
 function table_setGlobalFilter(table, updater) {
@@ -59,9 +64,10 @@ function table_setGlobalFilter(table, updater) {
 	(_table$options$onGlob = (_table$options = table.options).onGlobalFilterChange) === null || _table$options$onGlob === void 0 || _table$options$onGlob.call(_table$options, updater);
 }
 /**
-* Resets the table's global filter state slice.
+* Resets `globalFilter` to the configured initial state or feature default.
 *
-* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+* With no argument, the reset clones `table.initialState.globalFilter`. Passing
+* `true` ignores initial state and resets to `undefined`.
 *
 * @example
 * ```ts

package/dist/features/global-filtering/globalFilteringFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"globalFilteringFeature.utils.js","names":[],"sources":["../../../src/features/global-filtering/globalFilteringFeature.utils.ts"],"sourcesContent":["import { filterFn_includesString } from '../../fns/filterFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { FilterFn } from '../column-filtering/columnFilteringFeature.types'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\n\n/**\n * Returns whether a column can use global filter.\n *\n * This combines column options, table options, and any required accessor or feature state for the capability.\n *\n * @example\n * ```ts\n * const value = column_getCanGlobalFilter(column)\n * ```\n */\nexport function column_getCanGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    (column.columnDef.enableGlobalFilter ?? true) &&\n    (column.table.options.enableGlobalFilter ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    (column.table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Returns global auto filter fn for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getGlobalAutoFilterFn(table)\n * ```\n */\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\n}\n\n/**\n * Returns global filter fn for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getGlobalFilterFn(table)\n * ```\n */\nexport function table_getGlobalFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined {\n  const { globalFilterFn: globalFilterFn } = table.options\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    table._rowModelFns.filterFns\n\n  return isFunction(globalFilterFn)\n    ? globalFilterFn\n    : globalFilterFn === 'auto'\n      ? table_getGlobalAutoFilterFn()\n      : filterFns?.[globalFilterFn as string]\n}\n\n/**\n * Updates the table's global filter state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_setGlobalFilter(table, (old) => old)\n * ```\n */\nexport function table_setGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: any) {\n  table.options.onGlobalFilterChange?.(updater)\n}\n\n/**\n * Resets the table's global filter state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_resetGlobalFilter(table)\n * table_resetGlobalFilter(table, true)\n * ```\n */\nexport function table_resetGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGlobalFilter(\n    table,\n    defaultState ? undefined : cloneState(table.initialState.globalFilter),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;AAkBA,SAAgB,0BAId,QAA4D;;CAC5D,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,OAAO,KAAI,SAC5D,CAAC,CAAC,OAAO;;;;;;;;;;;;AAcb,SAAgB,8BAA8B;CAC5C,OAAO;;;;;;;;;;;;AAaT,SAAgB,wBAId,OACqE;CACrE,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;CAErB,OAAO,WAAW,eAAe,GAC7B,iBACA,mBAAmB,SACjB,6BAA6B,yDAC7B,UAAY;;;;;;;;;;;;AAapB,SAAgB,sBAGd,OAAyC,SAAc;;CACvD,iDAAM,SAAQ,iHAAuB,QAAQ;;;;;;;;;;;;;AAc/C,SAAgB,wBAGd,OAAyC,cAAwB;CACjE,sBACE,OACA,eAAe,SAAY,WAAW,MAAM,aAAa,aAAa,CACvE"}
+{"version":3,"file":"globalFilteringFeature.utils.js","names":[],"sources":["../../../src/features/global-filtering/globalFilteringFeature.utils.ts"],"sourcesContent":["import { filterFn_includesString } from '../../fns/filterFns'\nimport { cloneState, isFunction } from '../../utils'\nimport type { Column_Internal } from '../../types/Column'\nimport type { FilterFn } from '../column-filtering/columnFilteringFeature.types'\nimport type { CellData, RowData } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\n\n/**\n * Checks whether this accessor column participates in global filtering.\n *\n * The column must have an accessor and pass column-level, table-level, and\n * optional `getColumnCanGlobalFilter` checks.\n *\n * @example\n * ```ts\n * const canGlobalFilter = column_getCanGlobalFilter(column)\n * ```\n */\nexport function column_getCanGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  return (\n    (column.columnDef.enableGlobalFilter ?? true) &&\n    (column.table.options.enableGlobalFilter ?? true) &&\n    (column.table.options.enableFilters ?? true) &&\n    (column.table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n    !!column.accessorFn\n  )\n}\n\n/**\n * Provides the built-in automatic global filter function.\n *\n * Global filtering defaults to `includesString`, which gives search-box style\n * matching across globally filterable columns.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalAutoFilterFn()\n * ```\n */\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\n}\n\n/**\n * Resolves the filter function used for global filtering.\n *\n * Function-valued `options.globalFilterFn` is returned directly, `'auto'`\n * delegates to `table_getGlobalAutoFilterFn`, and string values are looked up in\n * the table's filter function registry.\n *\n * @example\n * ```ts\n * const filterFn = table_getGlobalFilterFn(table)\n * ```\n */\nexport function table_getGlobalFilterFn<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n): FilterFn<TFeatures, TData> | FilterFn<TFeatures, TData> | undefined {\n  const { globalFilterFn: globalFilterFn } = table.options\n  const filterFns: Record<string, FilterFn<TFeatures, TData>> | undefined =\n    table._rowModelFns.filterFns\n\n  return isFunction(globalFilterFn)\n    ? globalFilterFn\n    : globalFilterFn === 'auto'\n      ? table_getGlobalAutoFilterFn()\n      : filterFns?.[globalFilterFn as string]\n}\n\n/**\n * Routes a global filter updater through the table's global filter handler.\n *\n * The updater may be a next value or a function of the previous value, matching\n * the instance `table.setGlobalFilter` behavior.\n *\n * @example\n * ```ts\n * table_setGlobalFilter(table, 'search text')\n * ```\n */\nexport function table_setGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, updater: any) {\n  table.options.onGlobalFilterChange?.(updater)\n}\n\n/**\n * Resets `globalFilter` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.globalFilter`. Passing\n * `true` ignores initial state and resets to `undefined`.\n *\n * @example\n * ```ts\n * table_resetGlobalFilter(table)\n * table_resetGlobalFilter(table, true)\n * ```\n */\nexport function table_resetGlobalFilter<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setGlobalFilter(\n    table,\n    defaultState ? undefined : cloneState(table.initialState.globalFilter),\n  )\n}\n"],"mappings":";;;;;;;;;;;;;;;AAmBA,SAAgB,0BAId,QAA4D;;CAC5D,QACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,OAAO,KAAI,SAC5D,CAAC,CAAC,OAAO;;;;;;;;;;;;;AAeb,SAAgB,8BAA8B;CAC5C,OAAO;;;;;;;;;;;;;;AAeT,SAAgB,wBAId,OACqE;CACrE,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;CAErB,OAAO,WAAW,eAAe,GAC7B,iBACA,mBAAmB,SACjB,6BAA6B,yDAC7B,UAAY;;;;;;;;;;;;;AAcpB,SAAgB,sBAGd,OAAyC,SAAc;;CACvD,iDAAM,SAAQ,iHAAuB,QAAQ;;;;;;;;;;;;;;AAe/C,SAAgB,wBAGd,OAAyC,cAAwB;CACjE,sBACE,OACA,eAAe,SAAY,WAAW,MAAM,aAAa,aAAa,CACvE"}

package/dist/features/row-expanding/rowExpandingFeature.types.d.cts

@@ -12,19 +12,19 @@ interface TableState_RowExpanding {
 }
 interface Row_RowExpanding {
   /**
-   * Returns whether the row can be expanded.
+   * Checks whether this row can be expanded.
    */
   getCanExpand: () => boolean;
   /**
-   * Returns whether all parent rows of the row are expanded.
+   * Checks whether every ancestor of this row is expanded.
    */
   getIsAllParentsExpanded: () => boolean;
   /**
-   * Returns whether the row is expanded.
+   * Checks whether this row is currently expanded.
    */
   getIsExpanded: () => boolean;
   /**
-   * Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button.
+   * Creates a handler that toggles this row's expanded state.
    */
   getToggleExpandedHandler: () => () => void;
   /**
@@ -38,7 +38,7 @@ interface TableOptions_RowExpanding<TFeatures extends TableFeatures, TData exten
    */
   autoResetExpanded?: boolean;
   /**
-   * Enable/disable expanding for all rows.
+   * Allows rows with subRows to be expanded.
    */
   enableExpanding?: boolean;
   /**
@@ -67,32 +67,33 @@ interface TableOptions_RowExpanding<TFeatures extends TableFeatures, TData exten
 interface Table_RowExpanding<TFeatures extends TableFeatures, TData extends RowData> {
   autoResetExpanded: () => void;
   /**
-   * Returns whether there are any rows that can be expanded.
+   * Checks whether at least one row can be expanded.
    */
   getCanSomeRowsExpand: () => boolean;
   /**
-   * Returns the maximum depth of the expanded rows.
+   * Computes the deepest expanded row id depth.
    */
   getExpandedDepth: () => number;
   /**
-   * Returns whether all rows are currently expanded.
+   * Checks whether all rows in the current row model are expanded.
    */
   getIsAllRowsExpanded: () => boolean;
   /**
-   * Returns whether there are any rows that are currently expanded.
+   * Checks whether any row is currently expanded.
    */
   getIsSomeRowsExpanded: () => boolean;
   /**
-   * Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an `input[type=checkbox]` element.
+   * Creates a handler that toggles all rows expanded.
    */
   getToggleAllRowsExpandedHandler: () => (event: unknown) => void;
   /**
-   * Resets expanded state to `initialState.expanded`. Pass `true` to reset to
-   * the feature default of `{}`.
+   * Resets `expanded` to `initialState.expanded`.
+   *
+   * Pass `true` to ignore initial state and reset to `{}`.
    */
   resetExpanded: (defaultState?: boolean) => void;
   /**
-   * Sets expanded state using a value or updater.
+   * Updates expanded state with `true`, a row-id map, or an updater function.
    */
   setExpanded: (updater: Updater<ExpandedState>) => void;
   /**
@@ -102,11 +103,11 @@ interface Table_RowExpanding<TFeatures extends TableFeatures, TData extends RowD
 }
 interface Table_RowModels_Expanded<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model after expansion has been applied.
+   * Resolves the row model after expanded rows have been flattened into view.
    */
   getExpandedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model before expansion has been applied.
+   * Reads the row model immediately before expansion.
    */
   getPreExpandedRowModel: () => RowModel<TFeatures, TData>;
 }

package/dist/features/row-expanding/rowExpandingFeature.types.d.ts

@@ -12,19 +12,19 @@ interface TableState_RowExpanding {
 }
 interface Row_RowExpanding {
   /**
-   * Returns whether the row can be expanded.
+   * Checks whether this row can be expanded.
    */
   getCanExpand: () => boolean;
   /**
-   * Returns whether all parent rows of the row are expanded.
+   * Checks whether every ancestor of this row is expanded.
    */
   getIsAllParentsExpanded: () => boolean;
   /**
-   * Returns whether the row is expanded.
+   * Checks whether this row is currently expanded.
    */
   getIsExpanded: () => boolean;
   /**
-   * Returns a function that can be used to toggle the expanded state of the row. This function can be used to bind to an event handler to a button.
+   * Creates a handler that toggles this row's expanded state.
    */
   getToggleExpandedHandler: () => () => void;
   /**
@@ -38,7 +38,7 @@ interface TableOptions_RowExpanding<TFeatures extends TableFeatures, TData exten
    */
   autoResetExpanded?: boolean;
   /**
-   * Enable/disable expanding for all rows.
+   * Allows rows with subRows to be expanded.
    */
   enableExpanding?: boolean;
   /**
@@ -67,32 +67,33 @@ interface TableOptions_RowExpanding<TFeatures extends TableFeatures, TData exten
 interface Table_RowExpanding<TFeatures extends TableFeatures, TData extends RowData> {
   autoResetExpanded: () => void;
   /**
-   * Returns whether there are any rows that can be expanded.
+   * Checks whether at least one row can be expanded.
    */
   getCanSomeRowsExpand: () => boolean;
   /**
-   * Returns the maximum depth of the expanded rows.
+   * Computes the deepest expanded row id depth.
    */
   getExpandedDepth: () => number;
   /**
-   * Returns whether all rows are currently expanded.
+   * Checks whether all rows in the current row model are expanded.
    */
   getIsAllRowsExpanded: () => boolean;
   /**
-   * Returns whether there are any rows that are currently expanded.
+   * Checks whether any row is currently expanded.
    */
   getIsSomeRowsExpanded: () => boolean;
   /**
-   * Returns a handler that can be used to toggle the expanded state of all rows. This handler is meant to be used with an `input[type=checkbox]` element.
+   * Creates a handler that toggles all rows expanded.
    */
   getToggleAllRowsExpandedHandler: () => (event: unknown) => void;
   /**
-   * Resets expanded state to `initialState.expanded`. Pass `true` to reset to
-   * the feature default of `{}`.
+   * Resets `expanded` to `initialState.expanded`.
+   *
+   * Pass `true` to ignore initial state and reset to `{}`.
    */
   resetExpanded: (defaultState?: boolean) => void;
   /**
-   * Sets expanded state using a value or updater.
+   * Updates expanded state with `true`, a row-id map, or an updater function.
    */
   setExpanded: (updater: Updater<ExpandedState>) => void;
   /**
@@ -102,11 +103,11 @@ interface Table_RowExpanding<TFeatures extends TableFeatures, TData extends RowD
 }
 interface Table_RowModels_Expanded<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model after expansion has been applied.
+   * Resolves the row model after expanded rows have been flattened into view.
    */
   getExpandedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model before expansion has been applied.
+   * Reads the row model immediately before expansion.
    */
   getPreExpandedRowModel: () => RowModel<TFeatures, TData>;
 }