@tanstack/table-core 9.0.0-alpha.4 → 9.0.0-alpha.41

package/dist/features/column-visibility/columnVisibilityFeature.types.d.ts

@@ -0,0 +1,89 @@
+import { OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
+import { Column } from "../../types/Column.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+import { Cell } from "../../types/Cell.js";
+
+//#region src/features/column-visibility/columnVisibilityFeature.types.d.ts
+type ColumnVisibilityState = Record<string, boolean>;
+interface TableState_ColumnVisibility {
+  columnVisibility: ColumnVisibilityState;
+}
+interface TableOptions_ColumnVisibility {
+  /**
+   * Whether to enable column hiding. Defaults to `true`.
+   */
+  enableHiding?: boolean;
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnVisibility` 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.
+   */
+  onColumnVisibilityChange?: OnChangeFn<ColumnVisibilityState>;
+}
+type VisibilityDefaultOptions = Pick<TableOptions_ColumnVisibility, 'onColumnVisibilityChange'>;
+interface Table_ColumnVisibility<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Returns whether all columns are visible
+   */
+  getIsAllColumnsVisible: () => boolean;
+  /**
+   * Returns whether any columns are visible
+   */
+  getIsSomeColumnsVisible: () => boolean;
+  /**
+   * Returns a handler for toggling the visibility of all columns, meant to be bound to a `input[type=checkbox]` element.
+   */
+  getToggleAllColumnsVisibilityHandler: () => (event: unknown) => void;
+  /**
+   * Returns a flat array of columns that are visible, including parent columns.
+   */
+  getVisibleFlatColumns: () => Array<Column<TFeatures, TData, unknown>>;
+  /**
+   * Returns a flat array of leaf-node columns that are visible.
+   */
+  getVisibleLeafColumns: () => Array<Column<TFeatures, TData, unknown>>;
+  /**
+   * Resets the column visibility state to the initial state. If `defaultState` is provided, the state will be reset to `{}`
+   */
+  resetColumnVisibility: (defaultState?: boolean) => void;
+  /**
+   * Sets or updates the `state.columnVisibility` state.
+   */
+  setColumnVisibility: (updater: Updater<ColumnVisibilityState>) => void;
+  /**
+   * Toggles the visibility of all columns.
+   */
+  toggleAllColumnsVisible: (value?: boolean) => void;
+}
+interface ColumnDef_ColumnVisibility {
+  /**
+   * Enables/disables column hiding for this column. Defaults to `true`.
+   */
+  enableHiding?: boolean;
+}
+interface Row_ColumnVisibility<TFeatures extends TableFeatures, TData extends RowData> {
+  getAllVisibleCells: () => Array<Cell<TFeatures, TData, unknown>>;
+  /**
+   * Returns an array of cells that account for column visibility for the row.
+   */
+  getVisibleCells: () => Array<Cell<TFeatures, TData, unknown>>;
+}
+interface Column_ColumnVisibility {
+  /**
+   * Returns whether the column can be hidden
+   */
+  getCanHide: () => boolean;
+  /**
+   * Returns whether the column is visible
+   */
+  getIsVisible: () => boolean;
+  /**
+   * Returns a function that can be used to toggle the column visibility. This function can be used to bind to an event handler to a checkbox.
+   */
+  getToggleVisibilityHandler: () => (event: unknown) => void;
+  /**
+   * Toggles the visibility of the column.
+   */
+  toggleVisibility: (value?: boolean) => void;
+}
+//#endregion
+export { ColumnDef_ColumnVisibility, ColumnVisibilityState, Column_ColumnVisibility, Row_ColumnVisibility, TableOptions_ColumnVisibility, TableState_ColumnVisibility, Table_ColumnVisibility, VisibilityDefaultOptions };
+//# sourceMappingURL=columnVisibilityFeature.types.d.ts.map

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

@@ -0,0 +1,84 @@
+const require_utils = require('../../utils.cjs');
+
+//#region src/features/column-visibility/columnVisibilityFeature.utils.ts
+function getDefaultColumnVisibilityState() {
+	return {};
+}
+function column_toggleVisibility(column, visible) {
+	if (column_getCanHide(column)) table_setColumnVisibility(column.table, (old) => ({
+		...old,
+		[column.id]: visible ?? !require_utils.callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible)
+	}));
+}
+function column_getIsVisible(column) {
+	var _column$table$atoms$c;
+	const childColumns = column.columns;
+	return (childColumns.length ? childColumns.some((childColumn) => require_utils.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;
+}
+function column_getCanHide(column) {
+	return (column.columnDef.enableHiding ?? true) && (column.table.options.enableHiding ?? true);
+}
+function column_getToggleVisibilityHandler(column) {
+	return (e) => {
+		column_toggleVisibility(column, e.target.checked);
+	};
+}
+function row_getAllVisibleCells(row) {
+	return row.getAllCells().filter((cell) => require_utils.callMemoOrStaticFn(cell.column, "getIsVisible", column_getIsVisible));
+}
+function row_getVisibleCells(left, center, right) {
+	return [
+		...left,
+		...center,
+		...right
+	];
+}
+function table_getVisibleFlatColumns(table) {
+	return table.getAllFlatColumns().filter((column) => require_utils.callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+function table_getVisibleLeafColumns(table) {
+	return table.getAllLeafColumns().filter((column) => require_utils.callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+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);
+}
+function table_resetColumnVisibility(table, defaultState) {
+	table_setColumnVisibility(table, defaultState ? {} : require_utils.cloneState(table.initialState.columnVisibility ?? {}));
+}
+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
+	}), {}));
+}
+function table_getIsAllColumnsVisible(table) {
+	return !table.getAllLeafColumns().some((column) => !require_utils.callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+function table_getIsSomeColumnsVisible(table) {
+	return table.getAllLeafColumns().some((column) => require_utils.callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+function table_getToggleAllColumnsVisibilityHandler(table) {
+	return (e) => {
+		table_toggleAllColumnsVisible(table, e.target.checked);
+	};
+}
+
+//#endregion
+exports.column_getCanHide = column_getCanHide;
+exports.column_getIsVisible = column_getIsVisible;
+exports.column_getToggleVisibilityHandler = column_getToggleVisibilityHandler;
+exports.column_toggleVisibility = column_toggleVisibility;
+exports.getDefaultColumnVisibilityState = getDefaultColumnVisibilityState;
+exports.row_getAllVisibleCells = row_getAllVisibleCells;
+exports.row_getVisibleCells = row_getVisibleCells;
+exports.table_getIsAllColumnsVisible = table_getIsAllColumnsVisible;
+exports.table_getIsSomeColumnsVisible = table_getIsSomeColumnsVisible;
+exports.table_getToggleAllColumnsVisibilityHandler = table_getToggleAllColumnsVisibilityHandler;
+exports.table_getVisibleFlatColumns = table_getVisibleFlatColumns;
+exports.table_getVisibleLeafColumns = table_getVisibleLeafColumns;
+exports.table_resetColumnVisibility = table_resetColumnVisibility;
+exports.table_setColumnVisibility = table_setColumnVisibility;
+exports.table_toggleAllColumnsVisible = table_toggleAllColumnsVisible;
+//# sourceMappingURL=columnVisibilityFeature.utils.cjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"columnVisibilityFeature.utils.cjs","names":["callMemoOrStaticFn","cloneState"],"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,CAACA,iCAAmB,QAAQ,gBAAgB,oBAAoB;EACnE,EAAE;;AAIP,SAAgB,oBAId,QAA4D;;CAC5D,MAAM,eAAe,OAAO;AAC5B,SACG,aAAa,SACV,aAAa,MAAM,gBACjBA,iCAAmB,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,SACPA,iCAAmB,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,WACPA,iCAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;AAGL,SAAgB,4BAGd,OAAyC;AACzC,QAAO,MACJ,mBAAmB,CACnB,QAAQ,WACPA,iCAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;AAGL,SAAgB,0BAId,OACA,SACA;;AACA,kDAAM,SAAQ,qHAA2B,QAAQ;;AAGnD,SAAgB,4BAGd,OAAyC,cAAwB;AACjE,2BACE,OACA,eAAe,EAAE,GAAGC,yBAAW,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,CAACD,iCAAmB,QAAQ,gBAAgB,oBAAoB,CACnE;;AAGL,SAAgB,8BAGd,OAAyC;AACzC,QAAO,MACJ,mBAAmB,CACnB,MAAM,WACLA,iCAAmB,QAAQ,gBAAgB,oBAAoB,CAChE;;AAGL,SAAgB,2CAGd,OAAyC;AACzC,SAAQ,MAAe;AACrB,gCACE,OACE,EAAiB,OAA4B,QAChD"}

package/dist/features/column-visibility/columnVisibilityFeature.utils.d.cts

@@ -0,0 +1,26 @@
+import { CellData, RowData, Updater } from "../../types/type-utils.cjs";
+import { Column, Column_Internal } from "../../types/Column.cjs";
+import { ColumnVisibilityState } from "./columnVisibilityFeature.types.cjs";
+import { Row } from "../../types/Row.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+import { Table_Internal } from "../../types/Table.cjs";
+import { Cell } from "../../types/Cell.cjs";
+//#region src/features/column-visibility/columnVisibilityFeature.utils.d.ts
+declare function getDefaultColumnVisibilityState(): ColumnVisibilityState;
+declare function column_toggleVisibility<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, visible?: boolean): void;
+declare function column_getIsVisible<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+declare function column_getCanHide<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+declare function column_getToggleVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): (e: unknown) => void;
+declare function row_getAllVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Cell<TFeatures, TData, unknown>[];
+declare function row_getVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(left: Array<Cell<TFeatures, TData, unknown>>, center: Array<Cell<TFeatures, TData, unknown>>, right: Array<Cell<TFeatures, TData, unknown>>): Cell<TFeatures, TData, unknown>[];
+declare function table_getVisibleFlatColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_getVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_setColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnVisibilityState>): void;
+declare function table_resetColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+declare function table_toggleAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
+declare function table_getIsAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getIsSomeColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getToggleAllColumnsVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+//#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 };
+//# sourceMappingURL=columnVisibilityFeature.utils.d.cts.map

package/dist/features/column-visibility/columnVisibilityFeature.utils.d.ts

@@ -0,0 +1,26 @@
+import { CellData, RowData, Updater } from "../../types/type-utils.js";
+import { Column, Column_Internal } from "../../types/Column.js";
+import { ColumnVisibilityState } from "./columnVisibilityFeature.types.js";
+import { Row } from "../../types/Row.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+import { Table_Internal } from "../../types/Table.js";
+import { Cell } from "../../types/Cell.js";
+//#region src/features/column-visibility/columnVisibilityFeature.utils.d.ts
+declare function getDefaultColumnVisibilityState(): ColumnVisibilityState;
+declare function column_toggleVisibility<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>, visible?: boolean): void;
+declare function column_getIsVisible<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+declare function column_getCanHide<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+declare function column_getToggleVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): (e: unknown) => void;
+declare function row_getAllVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): Cell<TFeatures, TData, unknown>[];
+declare function row_getVisibleCells<TFeatures extends TableFeatures, TData extends RowData>(left: Array<Cell<TFeatures, TData, unknown>>, center: Array<Cell<TFeatures, TData, unknown>>, right: Array<Cell<TFeatures, TData, unknown>>): Cell<TFeatures, TData, unknown>[];
+declare function table_getVisibleFlatColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_getVisibleLeafColumns<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): Column<TFeatures, TData, unknown>[];
+declare function table_setColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<ColumnVisibilityState>): void;
+declare function table_resetColumnVisibility<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+declare function table_toggleAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
+declare function table_getIsAllColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getIsSomeColumnsVisible<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getToggleAllColumnsVisibilityHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+//#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 };
+//# sourceMappingURL=columnVisibilityFeature.utils.d.ts.map

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

@@ -0,0 +1,70 @@
+import { callMemoOrStaticFn, cloneState } from "../../utils.js";
+
+//#region src/features/column-visibility/columnVisibilityFeature.utils.ts
+function getDefaultColumnVisibilityState() {
+	return {};
+}
+function column_toggleVisibility(column, visible) {
+	if (column_getCanHide(column)) table_setColumnVisibility(column.table, (old) => ({
+		...old,
+		[column.id]: visible ?? !callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible)
+	}));
+}
+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;
+}
+function column_getCanHide(column) {
+	return (column.columnDef.enableHiding ?? true) && (column.table.options.enableHiding ?? true);
+}
+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) {
+	return [
+		...left,
+		...center,
+		...right
+	];
+}
+function table_getVisibleFlatColumns(table) {
+	return table.getAllFlatColumns().filter((column) => callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+function table_getVisibleLeafColumns(table) {
+	return table.getAllLeafColumns().filter((column) => callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+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);
+}
+function table_resetColumnVisibility(table, defaultState) {
+	table_setColumnVisibility(table, defaultState ? {} : cloneState(table.initialState.columnVisibility ?? {}));
+}
+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
+	}), {}));
+}
+function table_getIsAllColumnsVisible(table) {
+	return !table.getAllLeafColumns().some((column) => !callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+function table_getIsSomeColumnsVisible(table) {
+	return table.getAllLeafColumns().some((column) => callMemoOrStaticFn(column, "getIsVisible", column_getIsVisible));
+}
+function table_getToggleAllColumnsVisibilityHandler(table) {
+	return (e) => {
+		table_toggleAllColumnsVisible(table, e.target.checked);
+	};
+}
+
+//#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 };
+//# sourceMappingURL=columnVisibilityFeature.utils.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,46 @@
+const require_utils = require('../../utils.cjs');
+const require_globalFilteringFeature_utils = require('./globalFilteringFeature.utils.cjs');
+
+//#region src/features/global-filtering/globalFilteringFeature.ts
+function constructGlobalFilteringFeature() {
+	return {
+		getInitialState: (initialState) => {
+			return {
+				globalFilter: void 0,
+				...initialState
+			};
+		},
+		getDefaultTableOptions: (table) => {
+			return {
+				onGlobalFilterChange: require_utils.makeStateUpdater("globalFilter", table),
+				globalFilterFn: "auto",
+				getColumnCanGlobalFilter: (column) => {
+					var _table$getCoreRowMode;
+					const value = (_table$getCoreRowMode = table.getCoreRowModel().flatRows[0]) === null || _table$getCoreRowMode === void 0 || (_table$getCoreRowMode = _table$getCoreRowMode.getAllCellsByColumnId()[column.id]) === null || _table$getCoreRowMode === void 0 ? void 0 : _table$getCoreRowMode.getValue();
+					return typeof value === "string" || typeof value === "number";
+				}
+			};
+		},
+		assignColumnPrototype: (prototype, table) => {
+			require_utils.assignPrototypeAPIs("globalFilteringFeature", prototype, table, { column_getCanGlobalFilter: { fn: (column) => require_globalFilteringFeature_utils.column_getCanGlobalFilter(column) } });
+		},
+		constructTableAPIs: (table) => {
+			require_utils.assignTableAPIs("globalFilteringFeature", table, {
+				table_getGlobalAutoFilterFn: { fn: () => require_globalFilteringFeature_utils.table_getGlobalAutoFilterFn() },
+				table_getGlobalFilterFn: { fn: () => require_globalFilteringFeature_utils.table_getGlobalFilterFn(table) },
+				table_setGlobalFilter: { fn: (updater) => require_globalFilteringFeature_utils.table_setGlobalFilter(table, updater) },
+				table_resetGlobalFilter: { fn: (defaultState) => require_globalFilteringFeature_utils.table_resetGlobalFilter(table, defaultState) }
+			});
+		}
+	};
+}
+/**
+* The Global Filtering feature adds global filtering state and APIs to the table and column objects.
+* **Note:** This is dependent on the columnFilteringFeature feature.
+*/
+const globalFilteringFeature = constructGlobalFilteringFeature();
+
+//#endregion
+exports.constructGlobalFilteringFeature = constructGlobalFilteringFeature;
+exports.globalFilteringFeature = globalFilteringFeature;
+//# sourceMappingURL=globalFilteringFeature.cjs.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,14 @@
+import { RowData } from "../../types/type-utils.cjs";
+import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
+
+//#region src/features/global-filtering/globalFilteringFeature.d.ts
+interface GlobalFilteringFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+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.
+ */
+declare const globalFilteringFeature: TableFeature<GlobalFilteringFeatureConstructors<TableFeatures, RowData>>;
+//#endregion
+export { GlobalFilteringFeatureConstructors, constructGlobalFilteringFeature, globalFilteringFeature };
+//# sourceMappingURL=globalFilteringFeature.d.cts.map

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

@@ -0,0 +1,14 @@
+import { RowData } from "../../types/type-utils.js";
+import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.d.ts
+interface GlobalFilteringFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+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.
+ */
+declare const globalFilteringFeature: TableFeature<GlobalFilteringFeatureConstructors<TableFeatures, RowData>>;
+//#endregion
+export { GlobalFilteringFeatureConstructors, constructGlobalFilteringFeature, globalFilteringFeature };
+//# sourceMappingURL=globalFilteringFeature.d.ts.map

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

@@ -0,0 +1,45 @@
+import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../utils.js";
+import { column_getCanGlobalFilter, table_getGlobalAutoFilterFn, table_getGlobalFilterFn, table_resetGlobalFilter, table_setGlobalFilter } from "./globalFilteringFeature.utils.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.ts
+function constructGlobalFilteringFeature() {
+	return {
+		getInitialState: (initialState) => {
+			return {
+				globalFilter: void 0,
+				...initialState
+			};
+		},
+		getDefaultTableOptions: (table) => {
+			return {
+				onGlobalFilterChange: makeStateUpdater("globalFilter", table),
+				globalFilterFn: "auto",
+				getColumnCanGlobalFilter: (column) => {
+					var _table$getCoreRowMode;
+					const value = (_table$getCoreRowMode = table.getCoreRowModel().flatRows[0]) === null || _table$getCoreRowMode === void 0 || (_table$getCoreRowMode = _table$getCoreRowMode.getAllCellsByColumnId()[column.id]) === null || _table$getCoreRowMode === void 0 ? void 0 : _table$getCoreRowMode.getValue();
+					return typeof value === "string" || typeof value === "number";
+				}
+			};
+		},
+		assignColumnPrototype: (prototype, table) => {
+			assignPrototypeAPIs("globalFilteringFeature", prototype, table, { column_getCanGlobalFilter: { fn: (column) => column_getCanGlobalFilter(column) } });
+		},
+		constructTableAPIs: (table) => {
+			assignTableAPIs("globalFilteringFeature", table, {
+				table_getGlobalAutoFilterFn: { fn: () => table_getGlobalAutoFilterFn() },
+				table_getGlobalFilterFn: { fn: () => table_getGlobalFilterFn(table) },
+				table_setGlobalFilter: { fn: (updater) => table_setGlobalFilter(table, updater) },
+				table_resetGlobalFilter: { fn: (defaultState) => table_resetGlobalFilter(table, defaultState) }
+			});
+		}
+	};
+}
+/**
+* The Global Filtering feature adds global filtering state and APIs to the table and column objects.
+* **Note:** This is dependent on the columnFilteringFeature feature.
+*/
+const globalFilteringFeature = constructGlobalFilteringFeature();
+
+//#endregion
+export { constructGlobalFilteringFeature, globalFilteringFeature };
+//# sourceMappingURL=globalFilteringFeature.js.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,64 @@
+import { CellData, OnChangeFn, RowData, Updater } from "../../types/type-utils.cjs";
+import { FilterFn, FilterFnOption } from "../column-filtering/columnFilteringFeature.types.cjs";
+import { Column } from "../../types/Column.cjs";
+import { TableFeatures } from "../../types/TableFeatures.cjs";
+
+//#region src/features/global-filtering/globalFilteringFeature.types.d.ts
+interface TableState_GlobalFiltering {
+  globalFilter: any;
+}
+interface ColumnDef_GlobalFiltering {
+  /**
+   * Enables/disables the **global** filter for this column.
+   */
+  enableGlobalFilter?: boolean;
+}
+interface Column_GlobalFiltering {
+  /**
+   * Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering.
+   */
+  getCanGlobalFilter: () => boolean;
+}
+interface TableOptions_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Enables/disables **global** filtering for all columns.
+   */
+  enableGlobalFilter?: boolean;
+  /**
+   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
+   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
+   */
+  getColumnCanGlobalFilter?: <TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>) => boolean;
+  /**
+   * The filter function to use for global filtering.
+   * - A `string` referencing a built-in filter function
+   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
+   * - A custom filter function
+   */
+  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.
+   */
+  onGlobalFilterChange?: OnChangeFn<any>;
+}
+interface Table_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
+   */
+  getGlobalAutoFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
+   */
+  getGlobalFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.
+   */
+  resetGlobalFilter: (defaultState?: boolean) => void;
+  /**
+   * Sets or updates the `state.globalFilter` state.
+   */
+  setGlobalFilter: (updater: Updater<any>) => void;
+}
+//#endregion
+export { ColumnDef_GlobalFiltering, Column_GlobalFiltering, TableOptions_GlobalFiltering, TableState_GlobalFiltering, Table_GlobalFiltering };
+//# sourceMappingURL=globalFilteringFeature.types.d.cts.map

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

@@ -0,0 +1,64 @@
+import { CellData, OnChangeFn, RowData, Updater } from "../../types/type-utils.js";
+import { FilterFn, FilterFnOption } from "../column-filtering/columnFilteringFeature.types.js";
+import { Column } from "../../types/Column.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
+
+//#region src/features/global-filtering/globalFilteringFeature.types.d.ts
+interface TableState_GlobalFiltering {
+  globalFilter: any;
+}
+interface ColumnDef_GlobalFiltering {
+  /**
+   * Enables/disables the **global** filter for this column.
+   */
+  enableGlobalFilter?: boolean;
+}
+interface Column_GlobalFiltering {
+  /**
+   * Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering.
+   */
+  getCanGlobalFilter: () => boolean;
+}
+interface TableOptions_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Enables/disables **global** filtering for all columns.
+   */
+  enableGlobalFilter?: boolean;
+  /**
+   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
+   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
+   */
+  getColumnCanGlobalFilter?: <TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column<TFeatures, TData, TValue>) => boolean;
+  /**
+   * The filter function to use for global filtering.
+   * - A `string` referencing a built-in filter function
+   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
+   * - A custom filter function
+   */
+  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.
+   */
+  onGlobalFilterChange?: OnChangeFn<any>;
+}
+interface Table_GlobalFiltering<TFeatures extends TableFeatures, TData extends RowData> {
+  /**
+   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
+   */
+  getGlobalAutoFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
+   */
+  getGlobalFilterFn: () => FilterFn<TFeatures, TData> | undefined;
+  /**
+   * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.
+   */
+  resetGlobalFilter: (defaultState?: boolean) => void;
+  /**
+   * Sets or updates the `state.globalFilter` state.
+   */
+  setGlobalFilter: (updater: Updater<any>) => void;
+}
+//#endregion
+export { ColumnDef_GlobalFiltering, Column_GlobalFiltering, TableOptions_GlobalFiltering, TableState_GlobalFiltering, Table_GlobalFiltering };
+//# sourceMappingURL=globalFilteringFeature.types.d.ts.map