@tanstack/table-core 9.0.0-alpha.42 → 9.0.0-alpha.46

package/dist/features/column-visibility/columnVisibilityFeature.utils.js

@@ -1,64 +1,225 @@
 import { callMemoOrStaticFn, cloneState } from "../../utils.js";
+import { getDefaultColumnPinningState } from "../column-pinning/columnPinningFeature.utils.js";
 
 //#region src/features/column-visibility/columnVisibilityFeature.utils.ts
+/**
+* Returns the default column visibility state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultColumnVisibilityState()
+* ```
+*/
 function getDefaultColumnVisibilityState() {
 	return {};
 }
+/**
+* Toggles visibility for a column.
+*
+* The update is applied through the owning table state slice and respects the feature options for that column.
+*
+* @example
+* ```ts
+* column_toggleVisibility(column)
+* ```
+*/
 function column_toggleVisibility(column, visible) {
 	if (column_getCanHide(column)) table_setColumnVisibility(column.table, (old) => ({
 		...old,
 		[column.id]: visible ?? !callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible)
 	}));
 }
+/**
+* Returns is visible for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getIsVisible(column)
+* ```
+*/
 function column_getIsVisible(column) {
 	var _column$table$atoms$c;
 	const childColumns = column.columns;
 	return (childColumns.length ? childColumns.some((childColumn) => callMemoOrStaticFn(childColumn, "getIsVisible", column_getIsVisible)) : (_column$table$atoms$c = column.table.atoms.columnVisibility) === null || _column$table$atoms$c === void 0 || (_column$table$atoms$c = _column$table$atoms$c.get()) === null || _column$table$atoms$c === void 0 ? void 0 : _column$table$atoms$c[column.id]) ?? true;
 }
+/**
+* Returns whether a column can use hide.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = column_getCanHide(column)
+* ```
+*/
 function column_getCanHide(column) {
 	return (column.columnDef.enableHiding ?? true) && (column.table.options.enableHiding ?? true);
 }
+/**
+* Returns an event handler for toggling visibility handler.
+*
+* The handler is intended for direct use in column header controls such as buttons or checkboxes.
+*
+* @example
+* ```ts
+* const value = column_getToggleVisibilityHandler(column)
+* ```
+*/
 function column_getToggleVisibilityHandler(column) {
 	return (e) => {
 		column_toggleVisibility(column, e.target.checked);
 	};
 }
-function row_getAllVisibleCells(row) {
-	return row.getAllCells().filter((cell) => callMemoOrStaticFn(cell.column, "getIsVisible", column_getIsVisible));
-}
-function row_getVisibleCells(left, center, right) {
+/**
+* Returns visible cells for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getVisibleCells(row)
+* ```
+*/
+function row_getVisibleCells(row) {
+	var _row$table$atoms$colu;
+	const cells = row.getAllCells().filter((cell) => callMemoOrStaticFn(cell.column, "getIsVisible", column_getIsVisible));
+	const { left, right } = ((_row$table$atoms$colu = row.table.atoms.columnPinning) === null || _row$table$atoms$colu === void 0 ? void 0 : _row$table$atoms$colu.get()) ?? getDefaultColumnPinningState();
+	if (!left.length && !right.length) return cells;
+	const cellsByColumnId = /* @__PURE__ */ new Map();
+	for (const cell of cells) cellsByColumnId.set(cell.column.id, cell);
+	const leftCells = [];
+	for (const columnId of left) {
+		const cell = cellsByColumnId.get(columnId);
+		if (cell) leftCells.push(cell);
+	}
+	const rightCells = [];
+	for (const columnId of right) {
+		const cell = cellsByColumnId.get(columnId);
+		if (cell) rightCells.push(cell);
+	}
+	const leftSet = new Set(left);
+	const rightSet = new Set(right);
+	const centerCells = [];
+	for (const cell of cells) {
+		const id = cell.column.id;
+		if (!leftSet.has(id) && !rightSet.has(id)) centerCells.push(cell);
+	}
 	return [
-		...left,
-		...center,
-		...right
+		...leftCells,
+		...centerCells,
+		...rightCells
 	];
 }
+/**
+* Returns visible flat columns for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getVisibleFlatColumns(table)
+* ```
+*/
 function table_getVisibleFlatColumns(table) {
 	return table.getAllFlatColumns().filter((column) => callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
 }
+/**
+* Returns visible leaf columns for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getVisibleLeafColumns(table)
+* ```
+*/
 function table_getVisibleLeafColumns(table) {
 	return table.getAllLeafColumns().filter((column) => callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
 }
+/**
+* Updates the table's column visibility state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setColumnVisibility(table, (old) => old)
+* ```
+*/
 function table_setColumnVisibility(table, updater) {
 	var _table$options$onColu, _table$options;
 	(_table$options$onColu = (_table$options = table.options).onColumnVisibilityChange) === null || _table$options$onColu === void 0 || _table$options$onColu.call(_table$options, updater);
 }
+/**
+* Resets the table's column visibility state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetColumnVisibility(table)
+* table_resetColumnVisibility(table, true)
+* ```
+*/
 function table_resetColumnVisibility(table, defaultState) {
 	table_setColumnVisibility(table, defaultState ? {} : cloneState(table.initialState.columnVisibility ?? {}));
 }
+/**
+* Toggles all columns visible for the table.
+*
+* This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+*
+* @example
+* ```ts
+* table_toggleAllColumnsVisible(table)
+* ```
+*/
 function table_toggleAllColumnsVisible(table, value) {
 	value = value ?? !table_getIsAllColumnsVisible(table);
-	table_setColumnVisibility(table, table.getAllLeafColumns().reduce((obj, column) => ({
-		...obj,
-		[column.id]: !value ? !column_getCanHide(column) : value
-	}), {}));
+	const visibility = {};
+	for (const column of table.getAllLeafColumns()) visibility[column.id] = !value ? !column_getCanHide(column) : value;
+	table_setColumnVisibility(table, visibility);
 }
+/**
+* Returns is all columns visible for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsAllColumnsVisible(table)
+* ```
+*/
 function table_getIsAllColumnsVisible(table) {
 	return !table.getAllLeafColumns().some((column) => !callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
 }
+/**
+* Returns is some columns visible for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsSomeColumnsVisible(table)
+* ```
+*/
 function table_getIsSomeColumnsVisible(table) {
 	return table.getAllLeafColumns().some((column) => callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
 }
+/**
+* Returns an event handler for all columns visibility handler.
+*
+* The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+*
+* @example
+* ```ts
+* const value = table_getToggleAllColumnsVisibilityHandler(table)
+* ```
+*/
 function table_getToggleAllColumnsVisibilityHandler(table) {
 	return (e) => {
 		table_toggleAllColumnsVisible(table, e.target.checked);
@@ -66,5 +227,5 @@ function table_getToggleAllColumnsVisibilityHandler(table) {
 }
 
 //#endregion
-export { column_getCanHide, column_getIsVisible, column_getToggleVisibilityHandler, column_toggleVisibility, getDefaultColumnVisibilityState, row_getAllVisibleCells, row_getVisibleCells, table_getIsAllColumnsVisible, table_getIsSomeColumnsVisible, table_getToggleAllColumnsVisibilityHandler, table_getVisibleFlatColumns, table_getVisibleLeafColumns, table_resetColumnVisibility, table_setColumnVisibility, table_toggleAllColumnsVisible };
+export { column_getCanHide, column_getIsVisible, column_getToggleVisibilityHandler, column_toggleVisibility, getDefaultColumnVisibilityState, row_getVisibleCells, table_getIsAllColumnsVisible, table_getIsSomeColumnsVisible, table_getToggleAllColumnsVisibilityHandler, table_getVisibleFlatColumns, table_getVisibleLeafColumns, table_resetColumnVisibility, table_setColumnVisibility, table_toggleAllColumnsVisible };
 //# sourceMappingURL=columnVisibilityFeature.utils.js.map

package/dist/features/column-visibility/columnVisibilityFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"columnVisibilityFeature.utils.js","names":[],"sources":["../../../src/features/column-visibility/columnVisibilityFeature.utils.ts"],"sourcesContent":["import { callMemoOrStaticFn, cloneState } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Cell } from '../../types/Cell'\nimport type { Column_Internal } from '../../types/Column'\nimport type { ColumnVisibilityState } from './columnVisibilityFeature.types'\nimport type { Row } from '../../types/Row'\n\nexport function getDefaultColumnVisibilityState(): ColumnVisibilityState {\n  return {}\n}\n\nexport function column_toggleVisibility<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, visible?: boolean): void {\n  if (column_getCanHide(column)) {\n    table_setColumnVisibility(column.table, (old) => ({\n      ...old,\n      [column.id]:\n        visible ??\n        !callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    }))\n  }\n}\n\nexport function column_getIsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  const childColumns = column.columns\n  return (\n    (childColumns.length\n      ? childColumns.some((childColumn) =>\n          callMemoOrStaticFn(childColumn, 'getIsVisible', column_getIsVisible),\n        )\n      : column.table.atoms.columnVisibility?.get()?.[column.id]) ?? true\n  )\n}\n\nexport function column_getCanHide<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableHiding ?? true) &&\n    (column.table.options.enableHiding ?? true)\n  )\n}\n\nexport function column_getToggleVisibilityHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (e: unknown) => {\n    column_toggleVisibility(\n      column,\n      ((e as MouseEvent).target as HTMLInputElement).checked,\n    )\n  }\n}\n\nexport function row_getAllVisibleCells<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>) {\n  return row\n    .getAllCells()\n    .filter((cell) =>\n      callMemoOrStaticFn(cell.column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\nexport function row_getVisibleCells<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  left: Array<Cell<TFeatures, TData, unknown>>,\n  center: Array<Cell<TFeatures, TData, unknown>>,\n  right: Array<Cell<TFeatures, TData, unknown>>,\n) {\n  return [...left, ...center, ...right]\n}\n\nexport function table_getVisibleFlatColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getAllFlatColumns()\n    .filter((column) =>\n      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\nexport function table_getVisibleLeafColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getAllLeafColumns()\n    .filter((column) =>\n      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\nexport function table_setColumnVisibility<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<ColumnVisibilityState>,\n) {\n  table.options.onColumnVisibilityChange?.(updater)\n}\n\nexport function table_resetColumnVisibility<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setColumnVisibility(\n    table,\n    defaultState ? {} : cloneState(table.initialState.columnVisibility ?? {}),\n  )\n}\n\nexport function table_toggleAllColumnsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, value?: boolean) {\n  value = value ?? !table_getIsAllColumnsVisible(table)\n\n  table_setColumnVisibility(\n    table,\n    table.getAllLeafColumns().reduce(\n      (obj, column) => ({\n        ...obj,\n        [column.id]: !value ? !column_getCanHide(column) : value,\n      }),\n      {},\n    ),\n  )\n}\n\nexport function table_getIsAllColumnsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return !table\n    .getAllLeafColumns()\n    .some(\n      (column) =>\n        !callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\nexport function table_getIsSomeColumnsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getAllLeafColumns()\n    .some((column) =>\n      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\nexport function table_getToggleAllColumnsVisibilityHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (e: unknown) => {\n    table_toggleAllColumnsVisible(\n      table,\n      ((e as MouseEvent).target as HTMLInputElement).checked,\n    )\n  }\n}\n"],"mappings":";;;AASA,SAAgB,kCAAyD;AACvE,QAAO,EAAE;;AAGX,SAAgB,wBAId,QAAmD,SAAyB;AAC5E,KAAI,kBAAkB,OAAO,CAC3B,2BAA0B,OAAO,QAAQ,SAAS;EAChD,GAAG;GACF,OAAO,KACN,WACA,CAAC,mBAAmB,QAAQ,gBAAgB,oBAAoB;EACnE,EAAE;;AAIP,SAAgB,oBAId,QAA4D;;CAC5D,MAAM,eAAe,OAAO;AAC5B,SACG,aAAa,SACV,aAAa,MAAM,gBACjB,mBAAmB,aAAa,gBAAgB,oBAAoB,CACrE,4BACD,OAAO,MAAM,MAAM,iHAAkB,KAAK,gFAAG,OAAO,QAAQ;;AAIpE,SAAgB,kBAId,QAAmD;AACnD,SACG,OAAO,UAAU,gBAAgB,UACjC,OAAO,MAAM,QAAQ,gBAAgB;;AAI1C,SAAgB,kCAId,QAAmD;AACnD,SAAQ,MAAe;AACrB,0BACE,QACE,EAAiB,OAA4B,QAChD;;;AAIL,SAAgB,uBAGd,KAA4B;AAC5B,QAAO,IACJ,aAAa,CACb,QAAQ,SACP,mBAAmB,KAAK,QAAQ,gBAAgB,oBAAoB,CACrE;;AAGL,SAAgB,oBAId,MACA,QACA,OACA;AACA,QAAO;EAAC,GAAG;EAAM,GAAG;EAAQ,GAAG;EAAM;;AAGvC,SAAgB,4BAGd,OAAyC;AACzC,QAAO,MACJ,mBAAmB,CACnB,QAAQ,WACP,mBAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;AAGL,SAAgB,4BAGd,OAAyC;AACzC,QAAO,MACJ,mBAAmB,CACnB,QAAQ,WACP,mBAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;AAGL,SAAgB,0BAId,OACA,SACA;;AACA,kDAAM,SAAQ,qHAA2B,QAAQ;;AAGnD,SAAgB,4BAGd,OAAyC,cAAwB;AACjE,2BACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,oBAAoB,EAAE,CAAC,CAC1E;;AAGH,SAAgB,8BAGd,OAAyC,OAAiB;AAC1D,SAAQ,SAAS,CAAC,6BAA6B,MAAM;AAErD,2BACE,OACA,MAAM,mBAAmB,CAAC,QACvB,KAAK,YAAY;EAChB,GAAG;GACF,OAAO,KAAK,CAAC,QAAQ,CAAC,kBAAkB,OAAO,GAAG;EACpD,GACD,EAAE,CACH,CACF;;AAGH,SAAgB,6BAGd,OAAyC;AACzC,QAAO,CAAC,MACL,mBAAmB,CACnB,MACE,WACC,CAAC,mBAAmB,QAAQ,gBAAgB,oBAAoB,CACnE;;AAGL,SAAgB,8BAGd,OAAyC;AACzC,QAAO,MACJ,mBAAmB,CACnB,MAAM,WACL,mBAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;AAGL,SAAgB,2CAGd,OAAyC;AACzC,SAAQ,MAAe;AACrB,gCACE,OACE,EAAiB,OAA4B,QAChD"}
+{"version":3,"file":"columnVisibilityFeature.utils.js","names":[],"sources":["../../../src/features/column-visibility/columnVisibilityFeature.utils.ts"],"sourcesContent":["import { callMemoOrStaticFn, cloneState } from '../../utils'\nimport { getDefaultColumnPinningState } from '../column-pinning/columnPinningFeature.utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Cell } from '../../types/Cell'\nimport type { Column_Internal } from '../../types/Column'\nimport type { ColumnVisibilityState } from './columnVisibilityFeature.types'\nimport type { Row } from '../../types/Row'\n\n/**\n * Returns the default column visibility state.\n *\n * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.\n *\n * @example\n * ```ts\n * const initialValue = getDefaultColumnVisibilityState()\n * ```\n */\nexport function getDefaultColumnVisibilityState(): ColumnVisibilityState {\n  return {}\n}\n\n/**\n * Toggles visibility for a column.\n *\n * The update is applied through the owning table state slice and respects the feature options for that column.\n *\n * @example\n * ```ts\n * column_toggleVisibility(column)\n * ```\n */\nexport function column_toggleVisibility<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>, visible?: boolean): void {\n  if (column_getCanHide(column)) {\n    table_setColumnVisibility(column.table, (old) => ({\n      ...old,\n      [column.id]:\n        visible ??\n        !callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    }))\n  }\n}\n\n/**\n * Returns is visible for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getIsVisible(column)\n * ```\n */\nexport function column_getIsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>): boolean {\n  const childColumns = column.columns\n  return (\n    (childColumns.length\n      ? childColumns.some((childColumn) =>\n          callMemoOrStaticFn(childColumn, 'getIsVisible', column_getIsVisible),\n        )\n      : column.table.atoms.columnVisibility?.get()?.[column.id]) ?? true\n  )\n}\n\n/**\n * Returns whether a column can use hide.\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_getCanHide(column)\n * ```\n */\nexport function column_getCanHide<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableHiding ?? true) &&\n    (column.table.options.enableHiding ?? true)\n  )\n}\n\n/**\n * Returns an event handler for toggling visibility handler.\n *\n * The handler is intended for direct use in column header controls such as buttons or checkboxes.\n *\n * @example\n * ```ts\n * const value = column_getToggleVisibilityHandler(column)\n * ```\n */\nexport function column_getToggleVisibilityHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (e: unknown) => {\n    column_toggleVisibility(\n      column,\n      ((e as MouseEvent).target as HTMLInputElement).checked,\n    )\n  }\n}\n\n/**\n * Returns visible cells for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getVisibleCells(row)\n * ```\n */\nexport function row_getVisibleCells<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): Array<Cell<TFeatures, TData, unknown>> {\n  const cells = row\n    .getAllCells()\n    .filter((cell) =>\n      callMemoOrStaticFn(cell.column, 'getIsVisible', column_getIsVisible),\n    )\n  const { left, right } =\n    row.table.atoms.columnPinning?.get() ?? getDefaultColumnPinningState()\n  if (!left.length && !right.length) return cells // no pinning, return early\n\n  const cellsByColumnId = new Map<string, Cell<TFeatures, TData, unknown>>()\n  for (const cell of cells) cellsByColumnId.set(cell.column.id, cell)\n\n  const leftCells: Array<Cell<TFeatures, TData, unknown>> = []\n  for (const columnId of left) {\n    const cell = cellsByColumnId.get(columnId)\n    if (cell) leftCells.push(cell)\n  }\n\n  const rightCells: Array<Cell<TFeatures, TData, unknown>> = []\n  for (const columnId of right) {\n    const cell = cellsByColumnId.get(columnId)\n    if (cell) rightCells.push(cell)\n  }\n\n  // Center cells: visible cells in natural column order, minus pinned ones.\n  const leftSet = new Set(left)\n  const rightSet = new Set(right)\n  const centerCells: Array<Cell<TFeatures, TData, unknown>> = []\n  for (const cell of cells) {\n    const id = cell.column.id\n    if (!leftSet.has(id) && !rightSet.has(id)) centerCells.push(cell)\n  }\n\n  return [...leftCells, ...centerCells, ...rightCells]\n}\n\n/**\n * Returns visible flat columns 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_getVisibleFlatColumns(table)\n * ```\n */\nexport function table_getVisibleFlatColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getAllFlatColumns()\n    .filter((column) =>\n      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\n/**\n * Returns visible leaf columns 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_getVisibleLeafColumns(table)\n * ```\n */\nexport function table_getVisibleLeafColumns<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getAllLeafColumns()\n    .filter((column) =>\n      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\n/**\n * Updates the table's column visibility 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_setColumnVisibility(table, (old) => old)\n * ```\n */\nexport function table_setColumnVisibility<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<ColumnVisibilityState>,\n) {\n  table.options.onColumnVisibilityChange?.(updater)\n}\n\n/**\n * Resets the table's column visibility 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_resetColumnVisibility(table)\n * table_resetColumnVisibility(table, true)\n * ```\n */\nexport function table_resetColumnVisibility<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setColumnVisibility(\n    table,\n    defaultState ? {} : cloneState(table.initialState.columnVisibility ?? {}),\n  )\n}\n\n/**\n * Toggles all columns visible for the table.\n *\n * This is the table-level convenience API used by UI controls that affect many columns or rows at once.\n *\n * @example\n * ```ts\n * table_toggleAllColumnsVisible(table)\n * ```\n */\nexport function table_toggleAllColumnsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, value?: boolean) {\n  value = value ?? !table_getIsAllColumnsVisible(table)\n\n  const visibility: Record<string, boolean> = {}\n  for (const column of table.getAllLeafColumns()) {\n    visibility[column.id] = !value ? !column_getCanHide(column) : value\n  }\n\n  table_setColumnVisibility(table, visibility)\n}\n\n/**\n * Returns is all columns visible 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_getIsAllColumnsVisible(table)\n * ```\n */\nexport function table_getIsAllColumnsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return !table\n    .getAllLeafColumns()\n    .some(\n      (column) =>\n        !callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\n/**\n * Returns is some columns visible 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_getIsSomeColumnsVisible(table)\n * ```\n */\nexport function table_getIsSomeColumnsVisible<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return table\n    .getAllLeafColumns()\n    .some((column) =>\n      callMemoOrStaticFn(column, 'getIsVisible', column_getIsVisible),\n    )\n}\n\n/**\n * Returns an event handler for all columns visibility handler.\n *\n * The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.\n *\n * @example\n * ```ts\n * const value = table_getToggleAllColumnsVisibilityHandler(table)\n * ```\n */\nexport function table_getToggleAllColumnsVisibilityHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>) {\n  return (e: unknown) => {\n    table_toggleAllColumnsVisible(\n      table,\n      ((e as MouseEvent).target as HTMLInputElement).checked,\n    )\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;AAoBA,SAAgB,kCAAyD;CACvE,OAAO,EAAE;;;;;;;;;;;;AAaX,SAAgB,wBAId,QAAmD,SAAyB;CAC5E,IAAI,kBAAkB,OAAO,EAC3B,0BAA0B,OAAO,QAAQ,SAAS;EAChD,GAAG;GACF,OAAO,KACN,WACA,CAAC,mBAAmB,QAAQ,gBAAgB,oBAAoB;EACnE,EAAE;;;;;;;;;;;;AAcP,SAAgB,oBAId,QAA4D;;CAC5D,MAAM,eAAe,OAAO;CAC5B,QACG,aAAa,SACV,aAAa,MAAM,gBACjB,mBAAmB,aAAa,gBAAgB,oBAAoB,CACrE,4BACD,OAAO,MAAM,MAAM,iHAAkB,KAAK,gFAAG,OAAO,QAAQ;;;;;;;;;;;;AAcpE,SAAgB,kBAId,QAAmD;CACnD,QACG,OAAO,UAAU,gBAAgB,UACjC,OAAO,MAAM,QAAQ,gBAAgB;;;;;;;;;;;;AAc1C,SAAgB,kCAId,QAAmD;CACnD,QAAQ,MAAe;EACrB,wBACE,QACE,EAAiB,OAA4B,QAChD;;;;;;;;;;;;;AAcL,SAAgB,oBAGd,KAAoE;;CACpE,MAAM,QAAQ,IACX,aAAa,CACb,QAAQ,SACP,mBAAmB,KAAK,QAAQ,gBAAgB,oBAAoB,CACrE;CACH,MAAM,EAAE,MAAM,oCACZ,IAAI,MAAM,MAAM,6FAAe,KAAK,KAAI,8BAA8B;CACxE,IAAI,CAAC,KAAK,UAAU,CAAC,MAAM,QAAQ,OAAO;CAE1C,MAAM,kCAAkB,IAAI,KAA8C;CAC1E,KAAK,MAAM,QAAQ,OAAO,gBAAgB,IAAI,KAAK,OAAO,IAAI,KAAK;CAEnE,MAAM,YAAoD,EAAE;CAC5D,KAAK,MAAM,YAAY,MAAM;EAC3B,MAAM,OAAO,gBAAgB,IAAI,SAAS;EAC1C,IAAI,MAAM,UAAU,KAAK,KAAK;;CAGhC,MAAM,aAAqD,EAAE;CAC7D,KAAK,MAAM,YAAY,OAAO;EAC5B,MAAM,OAAO,gBAAgB,IAAI,SAAS;EAC1C,IAAI,MAAM,WAAW,KAAK,KAAK;;CAIjC,MAAM,UAAU,IAAI,IAAI,KAAK;CAC7B,MAAM,WAAW,IAAI,IAAI,MAAM;CAC/B,MAAM,cAAsD,EAAE;CAC9D,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,KAAK,KAAK,OAAO;EACvB,IAAI,CAAC,QAAQ,IAAI,GAAG,IAAI,CAAC,SAAS,IAAI,GAAG,EAAE,YAAY,KAAK,KAAK;;CAGnE,OAAO;EAAC,GAAG;EAAW,GAAG;EAAa,GAAG;EAAW;;;;;;;;;;;;AAatD,SAAgB,4BAGd,OAAyC;CACzC,OAAO,MACJ,mBAAmB,CACnB,QAAQ,WACP,mBAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;;;;;;;;;;;AAaL,SAAgB,4BAGd,OAAyC;CACzC,OAAO,MACJ,mBAAmB,CACnB,QAAQ,WACP,mBAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;;;;;;;;;;;AAaL,SAAgB,0BAId,OACA,SACA;;CACA,iDAAM,SAAQ,qHAA2B,QAAQ;;;;;;;;;;;;;AAcnD,SAAgB,4BAGd,OAAyC,cAAwB;CACjE,0BACE,OACA,eAAe,EAAE,GAAG,WAAW,MAAM,aAAa,oBAAoB,EAAE,CAAC,CAC1E;;;;;;;;;;;;AAaH,SAAgB,8BAGd,OAAyC,OAAiB;CAC1D,QAAQ,SAAS,CAAC,6BAA6B,MAAM;CAErD,MAAM,aAAsC,EAAE;CAC9C,KAAK,MAAM,UAAU,MAAM,mBAAmB,EAC5C,WAAW,OAAO,MAAM,CAAC,QAAQ,CAAC,kBAAkB,OAAO,GAAG;CAGhE,0BAA0B,OAAO,WAAW;;;;;;;;;;;;AAa9C,SAAgB,6BAGd,OAAyC;CACzC,OAAO,CAAC,MACL,mBAAmB,CACnB,MACE,WACC,CAAC,mBAAmB,QAAQ,gBAAgB,oBAAoB,CACnE;;;;;;;;;;;;AAaL,SAAgB,8BAGd,OAAyC;CACzC,OAAO,MACJ,mBAAmB,CACnB,MAAM,WACL,mBAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;;;;;;;;;;;AAaL,SAAgB,2CAGd,OAAyC;CACzC,QAAQ,MAAe;EACrB,8BACE,OACE,EAAiB,OAA4B,QAChD"}

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

@@ -2,6 +2,11 @@ const require_utils = require('../../utils.cjs');
 const require_globalFilteringFeature_utils = require('./globalFilteringFeature.utils.cjs');
 
 //#region src/features/global-filtering/globalFilteringFeature.ts
+/**
+* Creates the stock global filtering feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructGlobalFilteringFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -35,8 +40,10 @@ function constructGlobalFilteringFeature() {
 	};
 }
 /**
-* The Global Filtering feature adds global filtering state and APIs to the table and column objects.
-* **Note:** This is dependent on the columnFilteringFeature feature.
+* The stock global filtering feature.
+*
+* Register this feature with column filtering support to add global filter
+* state, global filter function resolution, and column eligibility APIs.
 */
 const globalFilteringFeature = constructGlobalFilteringFeature();
 

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

@@ -1 +1 @@
-{"version":3,"file":"globalFilteringFeature.cjs","names":["makeStateUpdater","column_getCanGlobalFilter","table_getGlobalAutoFilterFn","table_getGlobalFilterFn","table_setGlobalFilter","table_resetGlobalFilter"],"sources":["../../../src/features/global-filtering/globalFilteringFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanGlobalFilter,\n  table_getGlobalAutoFilterFn,\n  table_getGlobalFilterFn,\n  table_resetGlobalFilter,\n  table_setGlobalFilter,\n} from './globalFilteringFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   ColumnDef_GlobalFiltering,\n//   Column_GlobalFiltering,\n//   TableOptions_GlobalFiltering,\n//   TableState_GlobalFiltering,\n//   Table_GlobalFiltering,\n// } from './globalFilteringFeature.types'\n\nexport interface GlobalFilteringFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_GlobalFiltering\n  // ColumnDef: ColumnDef_GlobalFiltering\n  // Table: Table_GlobalFiltering<TFeatures, TData>\n  // TableOptions: TableOptions_GlobalFiltering<TFeatures, TData>\n  // TableState: TableState_GlobalFiltering\n}\n\nexport function constructGlobalFilteringFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        globalFilter: undefined,\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onGlobalFilterChange: makeStateUpdater('globalFilter', table),\n        globalFilterFn: 'auto',\n        getColumnCanGlobalFilter: (column) => {\n          const value = table\n            .getCoreRowModel()\n            .flatRows[0]?.getAllCellsByColumnId()\n            [column.id]?.getValue()\n\n          return typeof value === 'string' || typeof value === 'number'\n        },\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('globalFilteringFeature', prototype, table, {\n        column_getCanGlobalFilter: {\n          fn: (column) => column_getCanGlobalFilter(column),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('globalFilteringFeature', table, {\n        table_getGlobalAutoFilterFn: {\n          fn: () => table_getGlobalAutoFilterFn(),\n        },\n        table_getGlobalFilterFn: {\n          fn: () => table_getGlobalFilterFn(table),\n        },\n        table_setGlobalFilter: {\n          fn: (updater) => table_setGlobalFilter(table, updater),\n        },\n        table_resetGlobalFilter: {\n          fn: (defaultState) => table_resetGlobalFilter(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Global Filtering feature adds global filtering state and APIs to the table and column objects.\n * **Note:** This is dependent on the columnFilteringFeature feature.\n */\nexport const globalFilteringFeature = constructGlobalFilteringFeature()\n"],"mappings":";;;;AAiCA,SAAgB,kCAGwD;AACtE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,cAAc;IACd,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO;IACL,sBAAsBA,+BAAiB,gBAAgB,MAAM;IAC7D,gBAAgB;IAChB,2BAA2B,WAAW;;KACpC,MAAM,iCAAQ,MACX,iBAAiB,CACjB,SAAS,mGAAI,uBAAuB,CACpC,OAAO,mFAAK,UAAU;AAEzB,YAAO,OAAO,UAAU,YAAY,OAAO,UAAU;;IAExD;;EAGH,wBAAwB,WAAW,UAAU;AAC3C,qCAAoB,0BAA0B,WAAW,OAAO,EAC9D,2BAA2B,EACzB,KAAK,WAAWC,+DAA0B,OAAO,EAClD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,iCAAgB,0BAA0B,OAAO;IAC/C,6BAA6B,EAC3B,UAAUC,kEAA6B,EACxC;IACD,yBAAyB,EACvB,UAAUC,6DAAwB,MAAM,EACzC;IACD,uBAAuB,EACrB,KAAK,YAAYC,2DAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiBC,6DAAwB,OAAO,aAAa,EACnE;IACF,CAAC;;EAEL;;;;;;AAOH,MAAa,yBAAyB,iCAAiC"}
+{"version":3,"file":"globalFilteringFeature.cjs","names":["makeStateUpdater","column_getCanGlobalFilter","table_getGlobalAutoFilterFn","table_getGlobalFilterFn","table_setGlobalFilter","table_resetGlobalFilter"],"sources":["../../../src/features/global-filtering/globalFilteringFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanGlobalFilter,\n  table_getGlobalAutoFilterFn,\n  table_getGlobalFilterFn,\n  table_resetGlobalFilter,\n  table_setGlobalFilter,\n} from './globalFilteringFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   ColumnDef_GlobalFiltering,\n//   Column_GlobalFiltering,\n//   TableOptions_GlobalFiltering,\n//   TableState_GlobalFiltering,\n//   Table_GlobalFiltering,\n// } from './globalFilteringFeature.types'\n\nexport interface GlobalFilteringFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_GlobalFiltering\n  // ColumnDef: ColumnDef_GlobalFiltering\n  // Table: Table_GlobalFiltering<TFeatures, TData>\n  // TableOptions: TableOptions_GlobalFiltering<TFeatures, TData>\n  // TableState: TableState_GlobalFiltering\n}\n\n/**\n * Creates the stock global filtering feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructGlobalFilteringFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        globalFilter: undefined,\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onGlobalFilterChange: makeStateUpdater('globalFilter', table),\n        globalFilterFn: 'auto',\n        getColumnCanGlobalFilter: (column) => {\n          const value = table\n            .getCoreRowModel()\n            .flatRows[0]?.getAllCellsByColumnId()\n            [column.id]?.getValue()\n\n          return typeof value === 'string' || typeof value === 'number'\n        },\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('globalFilteringFeature', prototype, table, {\n        column_getCanGlobalFilter: {\n          fn: (column) => column_getCanGlobalFilter(column),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('globalFilteringFeature', table, {\n        table_getGlobalAutoFilterFn: {\n          fn: () => table_getGlobalAutoFilterFn(),\n        },\n        table_getGlobalFilterFn: {\n          fn: () => table_getGlobalFilterFn(table),\n        },\n        table_setGlobalFilter: {\n          fn: (updater) => table_setGlobalFilter(table, updater),\n        },\n        table_resetGlobalFilter: {\n          fn: (defaultState) => table_resetGlobalFilter(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock global filtering feature.\n *\n * Register this feature with column filtering support to add global filter\n * state, global filter function resolution, and column eligibility APIs.\n */\nexport const globalFilteringFeature = constructGlobalFilteringFeature()\n"],"mappings":";;;;;;;;;AAsCA,SAAgB,kCAGwD;CACtE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,cAAc;IACd,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO;IACL,sBAAsBA,+BAAiB,gBAAgB,MAAM;IAC7D,gBAAgB;IAChB,2BAA2B,WAAW;;KACpC,MAAM,iCAAQ,MACX,iBAAiB,CACjB,SAAS,mGAAI,uBAAuB,CACpC,OAAO,mFAAK,UAAU;KAEzB,OAAO,OAAO,UAAU,YAAY,OAAO,UAAU;;IAExD;;EAGH,wBAAwB,WAAW,UAAU;GAC3C,kCAAoB,0BAA0B,WAAW,OAAO,EAC9D,2BAA2B,EACzB,KAAK,WAAWC,+DAA0B,OAAO,EAClD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,8BAAgB,0BAA0B,OAAO;IAC/C,6BAA6B,EAC3B,UAAUC,kEAA6B,EACxC;IACD,yBAAyB,EACvB,UAAUC,6DAAwB,MAAM,EACzC;IACD,uBAAuB,EACrB,KAAK,YAAYC,2DAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiBC,6DAAwB,OAAO,aAAa,EACnE;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,yBAAyB,iCAAiC"}

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

@@ -3,10 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
 
 //#region src/features/global-filtering/globalFilteringFeature.d.ts
 interface GlobalFilteringFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock global filtering feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructGlobalFilteringFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>>;
 /**
- * The Global Filtering feature adds global filtering state and APIs to the table and column objects.
- * **Note:** This is dependent on the columnFilteringFeature feature.
+ * The stock global filtering feature.
+ *
+ * Register this feature with column filtering support to add global filter
+ * state, global filter function resolution, and column eligibility APIs.
  */
 declare const globalFilteringFeature: TableFeature<GlobalFilteringFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

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

@@ -3,10 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
 
 //#region src/features/global-filtering/globalFilteringFeature.d.ts
 interface GlobalFilteringFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock global filtering feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructGlobalFilteringFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>>;
 /**
- * The Global Filtering feature adds global filtering state and APIs to the table and column objects.
- * **Note:** This is dependent on the columnFilteringFeature feature.
+ * The stock global filtering feature.
+ *
+ * Register this feature with column filtering support to add global filter
+ * state, global filter function resolution, and column eligibility APIs.
  */
 declare const globalFilteringFeature: TableFeature<GlobalFilteringFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

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

@@ -2,6 +2,11 @@ import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../ut
 import { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter } from "./globalFilteringFeature.utils.js";
 
 //#region src/features/global-filtering/globalFilteringFeature.ts
+/**
+* Creates the stock global filtering feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructGlobalFilteringFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -35,8 +40,10 @@ function constructGlobalFilteringFeature() {
 	};
 }
 /**
-* The Global Filtering feature adds global filtering state and APIs to the table and column objects.
-* **Note:** This is dependent on the columnFilteringFeature feature.
+* The stock global filtering feature.
+*
+* Register this feature with column filtering support to add global filter
+* state, global filter function resolution, and column eligibility APIs.
 */
 const globalFilteringFeature = constructGlobalFilteringFeature();
 

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

@@ -1 +1 @@
-{"version":3,"file":"globalFilteringFeature.js","names":[],"sources":["../../../src/features/global-filtering/globalFilteringFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanGlobalFilter,\n  table_getGlobalAutoFilterFn,\n  table_getGlobalFilterFn,\n  table_resetGlobalFilter,\n  table_setGlobalFilter,\n} from './globalFilteringFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   ColumnDef_GlobalFiltering,\n//   Column_GlobalFiltering,\n//   TableOptions_GlobalFiltering,\n//   TableState_GlobalFiltering,\n//   Table_GlobalFiltering,\n// } from './globalFilteringFeature.types'\n\nexport interface GlobalFilteringFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_GlobalFiltering\n  // ColumnDef: ColumnDef_GlobalFiltering\n  // Table: Table_GlobalFiltering<TFeatures, TData>\n  // TableOptions: TableOptions_GlobalFiltering<TFeatures, TData>\n  // TableState: TableState_GlobalFiltering\n}\n\nexport function constructGlobalFilteringFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        globalFilter: undefined,\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onGlobalFilterChange: makeStateUpdater('globalFilter', table),\n        globalFilterFn: 'auto',\n        getColumnCanGlobalFilter: (column) => {\n          const value = table\n            .getCoreRowModel()\n            .flatRows[0]?.getAllCellsByColumnId()\n            [column.id]?.getValue()\n\n          return typeof value === 'string' || typeof value === 'number'\n        },\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('globalFilteringFeature', prototype, table, {\n        column_getCanGlobalFilter: {\n          fn: (column) => column_getCanGlobalFilter(column),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('globalFilteringFeature', table, {\n        table_getGlobalAutoFilterFn: {\n          fn: () => table_getGlobalAutoFilterFn(),\n        },\n        table_getGlobalFilterFn: {\n          fn: () => table_getGlobalFilterFn(table),\n        },\n        table_setGlobalFilter: {\n          fn: (updater) => table_setGlobalFilter(table, updater),\n        },\n        table_resetGlobalFilter: {\n          fn: (defaultState) => table_resetGlobalFilter(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Global Filtering feature adds global filtering state and APIs to the table and column objects.\n * **Note:** This is dependent on the columnFilteringFeature feature.\n */\nexport const globalFilteringFeature = constructGlobalFilteringFeature()\n"],"mappings":";;;;AAiCA,SAAgB,kCAGwD;AACtE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,cAAc;IACd,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO;IACL,sBAAsB,iBAAiB,gBAAgB,MAAM;IAC7D,gBAAgB;IAChB,2BAA2B,WAAW;;KACpC,MAAM,iCAAQ,MACX,iBAAiB,CACjB,SAAS,mGAAI,uBAAuB,CACpC,OAAO,mFAAK,UAAU;AAEzB,YAAO,OAAO,UAAU,YAAY,OAAO,UAAU;;IAExD;;EAGH,wBAAwB,WAAW,UAAU;AAC3C,uBAAoB,0BAA0B,WAAW,OAAO,EAC9D,2BAA2B,EACzB,KAAK,WAAW,0BAA0B,OAAO,EAClD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,mBAAgB,0BAA0B,OAAO;IAC/C,6BAA6B,EAC3B,UAAU,6BAA6B,EACxC;IACD,yBAAyB,EACvB,UAAU,wBAAwB,MAAM,EACzC;IACD,uBAAuB,EACrB,KAAK,YAAY,sBAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiB,wBAAwB,OAAO,aAAa,EACnE;IACF,CAAC;;EAEL;;;;;;AAOH,MAAa,yBAAyB,iCAAiC"}
+{"version":3,"file":"globalFilteringFeature.js","names":[],"sources":["../../../src/features/global-filtering/globalFilteringFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanGlobalFilter,\n  table_getGlobalAutoFilterFn,\n  table_getGlobalFilterFn,\n  table_resetGlobalFilter,\n  table_setGlobalFilter,\n} from './globalFilteringFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   ColumnDef_GlobalFiltering,\n//   Column_GlobalFiltering,\n//   TableOptions_GlobalFiltering,\n//   TableState_GlobalFiltering,\n//   Table_GlobalFiltering,\n// } from './globalFilteringFeature.types'\n\nexport interface GlobalFilteringFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_GlobalFiltering\n  // ColumnDef: ColumnDef_GlobalFiltering\n  // Table: Table_GlobalFiltering<TFeatures, TData>\n  // TableOptions: TableOptions_GlobalFiltering<TFeatures, TData>\n  // TableState: TableState_GlobalFiltering\n}\n\n/**\n * Creates the stock global filtering feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructGlobalFilteringFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<GlobalFilteringFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        globalFilter: undefined,\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onGlobalFilterChange: makeStateUpdater('globalFilter', table),\n        globalFilterFn: 'auto',\n        getColumnCanGlobalFilter: (column) => {\n          const value = table\n            .getCoreRowModel()\n            .flatRows[0]?.getAllCellsByColumnId()\n            [column.id]?.getValue()\n\n          return typeof value === 'string' || typeof value === 'number'\n        },\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('globalFilteringFeature', prototype, table, {\n        column_getCanGlobalFilter: {\n          fn: (column) => column_getCanGlobalFilter(column),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('globalFilteringFeature', table, {\n        table_getGlobalAutoFilterFn: {\n          fn: () => table_getGlobalAutoFilterFn(),\n        },\n        table_getGlobalFilterFn: {\n          fn: () => table_getGlobalFilterFn(table),\n        },\n        table_setGlobalFilter: {\n          fn: (updater) => table_setGlobalFilter(table, updater),\n        },\n        table_resetGlobalFilter: {\n          fn: (defaultState) => table_resetGlobalFilter(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock global filtering feature.\n *\n * Register this feature with column filtering support to add global filter\n * state, global filter function resolution, and column eligibility APIs.\n */\nexport const globalFilteringFeature = constructGlobalFilteringFeature()\n"],"mappings":";;;;;;;;;AAsCA,SAAgB,kCAGwD;CACtE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,cAAc;IACd,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO;IACL,sBAAsB,iBAAiB,gBAAgB,MAAM;IAC7D,gBAAgB;IAChB,2BAA2B,WAAW;;KACpC,MAAM,iCAAQ,MACX,iBAAiB,CACjB,SAAS,mGAAI,uBAAuB,CACpC,OAAO,mFAAK,UAAU;KAEzB,OAAO,OAAO,UAAU,YAAY,OAAO,UAAU;;IAExD;;EAGH,wBAAwB,WAAW,UAAU;GAC3C,oBAAoB,0BAA0B,WAAW,OAAO,EAC9D,2BAA2B,EACzB,KAAK,WAAW,0BAA0B,OAAO,EAClD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,gBAAgB,0BAA0B,OAAO;IAC/C,6BAA6B,EAC3B,UAAU,6BAA6B,EACxC;IACD,yBAAyB,EACvB,UAAU,wBAAwB,MAAM,EACzC;IACD,uBAAuB,EACrB,KAAK,YAAY,sBAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiB,wBAAwB,OAAO,aAAa,EACnE;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,yBAAyB,iCAAiC"}

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

@@ -37,7 +37,9 @@ interface TableOptions_GlobalFiltering<TFeatures extends TableFeatures, TData ex
    */
   globalFilterFn?: FilterFnOption<TFeatures, TData>;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.globalFilter` 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.
+   * Called with an updater when global filter state changes. Pair this with
+   * `state.globalFilter` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onGlobalFilterChange?: OnChangeFn<any>;
 }
@@ -55,7 +57,7 @@ interface Table_GlobalFiltering<TFeatures extends TableFeatures, TData extends R
    */
   resetGlobalFilter: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.globalFilter` state.
+   * Sets global filter state using a value or updater.
    */
   setGlobalFilter: (updater: Updater<any>) => void;
 }

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

@@ -37,7 +37,9 @@ interface TableOptions_GlobalFiltering<TFeatures extends TableFeatures, TData ex
    */
   globalFilterFn?: FilterFnOption<TFeatures, TData>;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.globalFilter` 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.
+   * Called with an updater when global filter state changes. Pair this with
+   * `state.globalFilter` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onGlobalFilterChange?: OnChangeFn<any>;
 }
@@ -55,7 +57,7 @@ interface Table_GlobalFiltering<TFeatures extends TableFeatures, TData extends R
    */
   resetGlobalFilter: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.globalFilter` state.
+   * Sets global filter state using a value or updater.
    */
   setGlobalFilter: (updater: Updater<any>) => void;
 }

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

@@ -2,22 +2,73 @@ const require_utils = require('../../utils.cjs');
 const require_filterFns = require('../../fns/filterFns.cjs');
 
 //#region src/features/global-filtering/globalFilteringFeature.utils.ts
+/**
+* Returns whether a column can use global filter.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = column_getCanGlobalFilter(column)
+* ```
+*/
 function column_getCanGlobalFilter(column) {
 	var _column$table$options, _column$table$options2;
 	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.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getGlobalAutoFilterFn(table)
+* ```
+*/
 function table_getGlobalAutoFilterFn() {
 	return require_filterFns.filterFn_includesString;
 }
+/**
+* Returns global filter fn for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getGlobalFilterFn(table)
+* ```
+*/
 function table_getGlobalFilterFn(table) {
 	const { globalFilterFn } = table.options;
 	const filterFns = table._rowModelFns.filterFns;
 	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.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setGlobalFilter(table, (old) => old)
+* ```
+*/
 function table_setGlobalFilter(table, updater) {
 	var _table$options$onGlob, _table$options;
 	(_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.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetGlobalFilter(table)
+* table_resetGlobalFilter(table, true)
+* ```
+*/
 function table_resetGlobalFilter(table, defaultState) {
 	table_setGlobalFilter(table, defaultState ? void 0 : require_utils.cloneState(table.initialState.globalFilter));
 }

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\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\nexport function table_getGlobalAutoFilterFn() {\n  return filterFn_includesString\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\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\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":";;;;AAQA,SAAgB,0BAId,QAA4D;;AAC5D,SACG,OAAO,UAAU,sBAAsB,UACvC,OAAO,MAAM,QAAQ,sBAAsB,UAC3C,OAAO,MAAM,QAAQ,iBAAiB,8DACtC,OAAO,MAAM,SAAQ,qIAA2B,OAAO,KAAI,SAC5D,CAAC,CAAC,OAAO;;AAIb,SAAgB,8BAA8B;AAC5C,QAAOA;;AAGT,SAAgB,wBAId,OACqE;CACrE,MAAM,EAAkB,mBAAmB,MAAM;CACjD,MAAM,YACJ,MAAM,aAAa;AAErB,QAAOC,yBAAW,eAAe,GAC7B,iBACA,mBAAmB,SACjB,6BAA6B,yDAC7B,UAAY;;AAGpB,SAAgB,sBAGd,OAAyC,SAAc;;AACvD,kDAAM,SAAQ,iHAAuB,QAAQ;;AAG/C,SAAgB,wBAGd,OAAyC,cAAwB;AACjE,uBACE,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 * 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"}

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

@@ -5,10 +5,61 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/global-filtering/globalFilteringFeature.utils.d.ts
+/**
+ * Returns whether a column can use global filter.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = table_getGlobalAutoFilterFn(table)
+ * ```
+ */
 declare function table_getGlobalAutoFilterFn(): FilterFn<any, any>;
+/**
+ * Returns global filter fn for the table.
+ *
+ * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+ *
+ * @example
+ * ```ts
+ * const value = 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.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setGlobalFilter(table, (old) => old)
+ * ```
+ */
 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.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetGlobalFilter(table)
+ * table_resetGlobalFilter(table, true)
+ * ```
+ */
 declare function table_resetGlobalFilter<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
 //#endregion
 export { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter };