@tanstack/table-core 8.16.0 → 9.0.0-alpha.0

package/dist/cjs/features/ColumnSizing.d.cts

@@ -0,0 +1,194 @@
+import { OnChangeFn, Updater, TableFeature } from '../types';
+import { ColumnPinningPosition } from './ColumnPinning.cjs';
+
+export interface ColumnSizingTableState {
+    columnSizing: ColumnSizingState;
+    columnSizingInfo: ColumnSizingInfoState;
+}
+export type ColumnSizingState = Record<string, number>;
+export interface ColumnSizingInfoState {
+    columnSizingStart: [string, number][];
+    deltaOffset: null | number;
+    deltaPercentage: null | number;
+    isResizingColumn: false | string;
+    startOffset: null | number;
+    startSize: null | number;
+}
+export type ColumnResizeMode = 'onChange' | 'onEnd';
+export type ColumnResizeDirection = 'ltr' | 'rtl';
+export interface ColumnSizingOptions {
+    /**
+     * Determines when the columnSizing state is updated. `onChange` updates the state when the user is dragging the resize handle. `onEnd` updates the state when the user releases the resize handle.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#columnresizemode)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    columnResizeMode?: ColumnResizeMode;
+    /**
+     * Enables or disables column resizing for the column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enablecolumnresizing)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    enableColumnResizing?: boolean;
+    /**
+     * Enables or disables right-to-left support for resizing the column. defaults to 'ltr'.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#columnResizeDirection)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    columnResizeDirection?: ColumnResizeDirection;
+    /**
+     * If provided, this function will be called with an `updaterFn` when `state.columnSizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizing` from your own managed state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#oncolumnsizingchange)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    onColumnSizingChange?: OnChangeFn<ColumnSizingState>;
+    /**
+     * If provided, this function will be called with an `updaterFn` when `state.columnSizingInfo` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizingInfo` from your own managed state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#oncolumnsizinginfochange)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    onColumnSizingInfoChange?: OnChangeFn<ColumnSizingInfoState>;
+}
+export type ColumnSizingDefaultOptions = Pick<ColumnSizingOptions, 'columnResizeMode' | 'onColumnSizingChange' | 'onColumnSizingInfoChange' | 'columnResizeDirection'>;
+export interface ColumnSizingInstance {
+    /**
+     * If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getcentertotalsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getCenterTotalSize: () => number;
+    /**
+     * Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getlefttotalsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getLeftTotalSize: () => number;
+    /**
+     * Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getrighttotalsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getRightTotalSize: () => number;
+    /**
+     * Returns the total size of the table by calculating the sum of the sizes of all leaf-columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#gettotalsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getTotalSize: () => number;
+    /**
+     * Resets column sizing to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetcolumnsizing)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    resetColumnSizing: (defaultState?: boolean) => void;
+    /**
+     * Resets column sizing info to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetheadersizeinfo)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    resetHeaderSizeInfo: (defaultState?: boolean) => void;
+    /**
+     * Sets the column sizing state using an updater function or a value. This will trigger the underlying `onColumnSizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#setcolumnsizing)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    setColumnSizing: (updater: Updater<ColumnSizingState>) => void;
+    /**
+     * Sets the column sizing info state using an updater function or a value. This will trigger the underlying `onColumnSizingInfoChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#setcolumnsizinginfo)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    setColumnSizingInfo: (updater: Updater<ColumnSizingInfoState>) => void;
+}
+export interface ColumnSizingColumnDef {
+    /**
+     * Enables or disables column resizing for the column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#enableresizing)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    enableResizing?: boolean;
+    /**
+     * The maximum allowed size for the column
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#maxsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    maxSize?: number;
+    /**
+     * The minimum allowed size for the column
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#minsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    minSize?: number;
+    /**
+     * The desired size for the column
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#size)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    size?: number;
+}
+export interface ColumnSizingColumn {
+    /**
+     * Returns `true` if the column can be resized.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getcanresize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getCanResize: () => boolean;
+    /**
+     * Returns `true` if the column is currently being resized.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getisresizing)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getIsResizing: () => boolean;
+    /**
+     * Returns the current size of the column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getSize: () => number;
+    /**
+     * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding (left) headers in relation to the current column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getstart)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getStart: (position?: ColumnPinningPosition | 'center') => number;
+    /**
+     * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all succeeding (right) headers in relation to the current column.
+     */
+    getAfter: (position?: ColumnPinningPosition | 'center') => number;
+    /**
+     * Resets the column to its initial size.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#resetsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    resetSize: () => void;
+}
+export interface ColumnSizingHeader {
+    /**
+     * Returns an event handler function that can be used to resize the header. It can be used as an:
+     * - `onMouseDown` handler
+     * - `onTouchStart` handler
+     *
+     * The dragging and release events are automatically handled for you.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getresizehandler)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getResizeHandler: (context?: Document) => (event: unknown) => void;
+    /**
+     * Returns the current size of the header.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getsize)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getSize: () => number;
+    /**
+     * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-sizing#getstart)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-sizing)
+     */
+    getStart: (position?: ColumnPinningPosition) => number;
+}
+export declare const defaultColumnSizing: {
+    size: number;
+    minSize: number;
+    maxSize: number;
+};
+export declare const ColumnSizing: TableFeature;
+export declare function passiveEventSupported(): boolean;

package/dist/cjs/features/ColumnVisibility.cjs

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const utils = require("../utils.cjs");
+const ColumnVisibility = {
+  getInitialState: (state) => {
+    return {
+      columnVisibility: {},
+      ...state
+    };
+  },
+  getDefaultOptions: (table) => {
+    return {
+      onColumnVisibilityChange: utils.makeStateUpdater("columnVisibility", table)
+    };
+  },
+  createColumn: (column, table) => {
+    column.toggleVisibility = (value) => {
+      if (column.getCanHide()) {
+        table.setColumnVisibility((old) => ({
+          ...old,
+          [column.id]: value ?? !column.getIsVisible()
+        }));
+      }
+    };
+    column.getIsVisible = () => {
+      var _a;
+      const childColumns = column.columns;
+      return (childColumns.length ? childColumns.some((c) => c.getIsVisible()) : (_a = table.getState().columnVisibility) == null ? void 0 : _a[column.id]) ?? true;
+    };
+    column.getCanHide = () => {
+      return (column.columnDef.enableHiding ?? true) && (table.options.enableHiding ?? true);
+    };
+    column.getToggleVisibilityHandler = () => {
+      return (e) => {
+        var _a;
+        (_a = column.toggleVisibility) == null ? void 0 : _a.call(
+          column,
+          e.target.checked
+        );
+      };
+    };
+  },
+  createRow: (row, table) => {
+    row._getAllVisibleCells = utils.memo(
+      () => [row.getAllCells(), table.getState().columnVisibility],
+      (cells) => {
+        return cells.filter((cell) => cell.column.getIsVisible());
+      },
+      utils.getMemoOptions(table.options, "debugRows", "_getAllVisibleCells")
+    );
+    row.getVisibleCells = utils.memo(
+      () => [
+        row.getLeftVisibleCells(),
+        row.getCenterVisibleCells(),
+        row.getRightVisibleCells()
+      ],
+      (left, center, right) => [...left, ...center, ...right],
+      utils.getMemoOptions(table.options, "debugRows", "getVisibleCells")
+    );
+  },
+  createTable: (table) => {
+    const makeVisibleColumnsMethod = (key, getColumns) => {
+      return utils.memo(
+        () => [
+          getColumns(),
+          getColumns().filter((d) => d.getIsVisible()).map((d) => d.id).join("_")
+        ],
+        (columns) => {
+          return columns.filter((d) => {
+            var _a;
+            return (_a = d.getIsVisible) == null ? void 0 : _a.call(d);
+          });
+        },
+        utils.getMemoOptions(table.options, "debugColumns", key)
+      );
+    };
+    table.getVisibleFlatColumns = makeVisibleColumnsMethod(
+      "getVisibleFlatColumns",
+      () => table.getAllFlatColumns()
+    );
+    table.getVisibleLeafColumns = makeVisibleColumnsMethod(
+      "getVisibleLeafColumns",
+      () => table.getAllLeafColumns()
+    );
+    table.getLeftVisibleLeafColumns = makeVisibleColumnsMethod(
+      "getLeftVisibleLeafColumns",
+      () => table.getLeftLeafColumns()
+    );
+    table.getRightVisibleLeafColumns = makeVisibleColumnsMethod(
+      "getRightVisibleLeafColumns",
+      () => table.getRightLeafColumns()
+    );
+    table.getCenterVisibleLeafColumns = makeVisibleColumnsMethod(
+      "getCenterVisibleLeafColumns",
+      () => table.getCenterLeafColumns()
+    );
+    table.setColumnVisibility = (updater) => {
+      var _a, _b;
+      return (_b = (_a = table.options).onColumnVisibilityChange) == null ? void 0 : _b.call(_a, updater);
+    };
+    table.resetColumnVisibility = (defaultState) => {
+      table.setColumnVisibility(
+        defaultState ? {} : table.initialState.columnVisibility ?? {}
+      );
+    };
+    table.toggleAllColumnsVisible = (value) => {
+      value = value ?? !table.getIsAllColumnsVisible();
+      table.setColumnVisibility(
+        table.getAllLeafColumns().reduce(
+          (obj, column) => {
+            var _a;
+            return {
+              ...obj,
+              [column.id]: !value ? !((_a = column.getCanHide) == null ? void 0 : _a.call(column)) : value
+            };
+          },
+          {}
+        )
+      );
+    };
+    table.getIsAllColumnsVisible = () => !table.getAllLeafColumns().some((column) => {
+      var _a;
+      return !((_a = column.getIsVisible) == null ? void 0 : _a.call(column));
+    });
+    table.getIsSomeColumnsVisible = () => table.getAllLeafColumns().some((column) => {
+      var _a;
+      return (_a = column.getIsVisible) == null ? void 0 : _a.call(column);
+    });
+    table.getToggleAllColumnsVisibilityHandler = () => {
+      return (e) => {
+        var _a;
+        table.toggleAllColumnsVisible(
+          (_a = e.target) == null ? void 0 : _a.checked
+        );
+      };
+    };
+  }
+};
+function _getVisibleLeafColumns(table, position) {
+  return !position ? table.getVisibleLeafColumns() : position === "center" ? table.getCenterVisibleLeafColumns() : position === "left" ? table.getLeftVisibleLeafColumns() : table.getRightVisibleLeafColumns();
+}
+exports.ColumnVisibility = ColumnVisibility;
+exports._getVisibleLeafColumns = _getVisibleLeafColumns;
+//# sourceMappingURL=ColumnVisibility.cjs.map

package/dist/cjs/features/ColumnVisibility.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColumnVisibility.cjs","sources":["../../../src/features/ColumnVisibility.ts"],"sourcesContent":["import { ColumnPinningPosition } from '..'\nimport {\n  Cell,\n  Column,\n  OnChangeFn,\n  Table,\n  Updater,\n  Row,\n  RowData,\n  TableFeature,\n} from '../types'\nimport { getMemoOptions, makeStateUpdater, memo } from '../utils'\n\nexport type VisibilityState = Record<string, boolean>\n\nexport interface VisibilityTableState {\n  columnVisibility: VisibilityState\n}\n\nexport interface VisibilityOptions {\n  /**\n   * Whether to enable column hiding. Defaults to `true`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#enablehiding)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  enableHiding?: boolean\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#oncolumnvisibilitychange)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  onColumnVisibilityChange?: OnChangeFn<VisibilityState>\n}\n\nexport type VisibilityDefaultOptions = Pick<\n  VisibilityOptions,\n  'onColumnVisibilityChange'\n>\n\nexport interface VisibilityInstance<TData extends RowData> {\n  /**\n   * If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcentervisibleleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getCenterVisibleLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * Returns whether all columns are visible\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisallcolumnsvisible)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getIsAllColumnsVisible: () => boolean\n  /**\n   * Returns whether any columns are visible\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getissomecolumnsvisible)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getIsSomeColumnsVisible: () => boolean\n  /**\n   * If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getleftvisibleleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getLeftVisibleLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getrightvisibleleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getRightVisibleLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * Returns a handler for toggling the visibility of all columns, meant to be bound to a `input[type=checkbox]` element.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettoggleallcolumnsvisibilityhandler)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getToggleAllColumnsVisibilityHandler: () => (event: unknown) => void\n  /**\n   * Returns a flat array of columns that are visible, including parent columns.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleflatcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getVisibleFlatColumns: () => Column<TData, unknown>[]\n  /**\n   * Returns a flat array of leaf-node columns that are visible.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getVisibleLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * Resets the column visibility state to the initial state. If `defaultState` is provided, the state will be reset to `{}`\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#resetcolumnvisibility)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  resetColumnVisibility: (defaultState?: boolean) => void\n  /**\n   * Sets or updates the `state.columnVisibility` state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#setcolumnvisibility)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  setColumnVisibility: (updater: Updater<VisibilityState>) => void\n  /**\n   * Toggles the visibility of all columns.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#toggleallcolumnsvisible)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  toggleAllColumnsVisible: (value?: boolean) => void\n}\n\nexport interface VisibilityColumnDef {\n  enableHiding?: boolean\n}\n\nexport interface VisibilityRow<TData extends RowData> {\n  _getAllVisibleCells: () => Cell<TData, unknown>[]\n  /**\n   * Returns an array of cells that account for column visibility for the row.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisiblecells)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getVisibleCells: () => Cell<TData, unknown>[]\n}\n\nexport interface VisibilityColumn {\n  /**\n   * Returns whether the column can be hidden\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcanhide)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getCanHide: () => boolean\n  /**\n   * Returns whether the column is visible\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisvisible)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getIsVisible: () => boolean\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettogglevisibilityhandler)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  getToggleVisibilityHandler: () => (event: unknown) => void\n  /**\n   * Toggles the visibility of the column.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#togglevisibility)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)\n   */\n  toggleVisibility: (value?: boolean) => void\n}\n\n//\n\nexport const ColumnVisibility: TableFeature = {\n  getInitialState: (state): VisibilityTableState => {\n    return {\n      columnVisibility: {},\n      ...state,\n    }\n  },\n\n  getDefaultOptions: <TData extends RowData>(\n    table: Table<TData>\n  ): VisibilityDefaultOptions => {\n    return {\n      onColumnVisibilityChange: makeStateUpdater('columnVisibility', table),\n    }\n  },\n\n  createColumn: <TData extends RowData, TValue>(\n    column: Column<TData, TValue>,\n    table: Table<TData>\n  ): void => {\n    column.toggleVisibility = value => {\n      if (column.getCanHide()) {\n        table.setColumnVisibility(old => ({\n          ...old,\n          [column.id]: value ?? !column.getIsVisible(),\n        }))\n      }\n    }\n    column.getIsVisible = () => {\n      const childColumns = column.columns\n      return (\n        (childColumns.length\n          ? childColumns.some(c => c.getIsVisible())\n          : table.getState().columnVisibility?.[column.id]) ?? true\n      )\n    }\n\n    column.getCanHide = () => {\n      return (\n        (column.columnDef.enableHiding ?? true) &&\n        (table.options.enableHiding ?? true)\n      )\n    }\n    column.getToggleVisibilityHandler = () => {\n      return (e: unknown) => {\n        column.toggleVisibility?.(\n          ((e as MouseEvent).target as HTMLInputElement).checked\n        )\n      }\n    }\n  },\n\n  createRow: <TData extends RowData>(\n    row: Row<TData>,\n    table: Table<TData>\n  ): void => {\n    row._getAllVisibleCells = memo(\n      () => [row.getAllCells(), table.getState().columnVisibility],\n      cells => {\n        return cells.filter(cell => cell.column.getIsVisible())\n      },\n      getMemoOptions(table.options, 'debugRows', '_getAllVisibleCells')\n    )\n    row.getVisibleCells = memo(\n      () => [\n        row.getLeftVisibleCells(),\n        row.getCenterVisibleCells(),\n        row.getRightVisibleCells(),\n      ],\n      (left, center, right) => [...left, ...center, ...right],\n      getMemoOptions(table.options, 'debugRows', 'getVisibleCells')\n    )\n  },\n\n  createTable: <TData extends RowData>(table: Table<TData>): void => {\n    const makeVisibleColumnsMethod = (\n      key: string,\n      getColumns: () => Column<TData, unknown>[]\n    ): (() => Column<TData, unknown>[]) => {\n      return memo(\n        () => [\n          getColumns(),\n          getColumns()\n            .filter(d => d.getIsVisible())\n            .map(d => d.id)\n            .join('_'),\n        ],\n        columns => {\n          return columns.filter(d => d.getIsVisible?.())\n        },\n        getMemoOptions(table.options, 'debugColumns', key)\n      )\n    }\n\n    table.getVisibleFlatColumns = makeVisibleColumnsMethod(\n      'getVisibleFlatColumns',\n      () => table.getAllFlatColumns()\n    )\n    table.getVisibleLeafColumns = makeVisibleColumnsMethod(\n      'getVisibleLeafColumns',\n      () => table.getAllLeafColumns()\n    )\n    table.getLeftVisibleLeafColumns = makeVisibleColumnsMethod(\n      'getLeftVisibleLeafColumns',\n      () => table.getLeftLeafColumns()\n    )\n    table.getRightVisibleLeafColumns = makeVisibleColumnsMethod(\n      'getRightVisibleLeafColumns',\n      () => table.getRightLeafColumns()\n    )\n    table.getCenterVisibleLeafColumns = makeVisibleColumnsMethod(\n      'getCenterVisibleLeafColumns',\n      () => table.getCenterLeafColumns()\n    )\n\n    table.setColumnVisibility = updater =>\n      table.options.onColumnVisibilityChange?.(updater)\n\n    table.resetColumnVisibility = defaultState => {\n      table.setColumnVisibility(\n        defaultState ? {} : table.initialState.columnVisibility ?? {}\n      )\n    }\n\n    table.toggleAllColumnsVisible = value => {\n      value = value ?? !table.getIsAllColumnsVisible()\n\n      table.setColumnVisibility(\n        table.getAllLeafColumns().reduce(\n          (obj, column) => ({\n            ...obj,\n            [column.id]: !value ? !column.getCanHide?.() : value,\n          }),\n          {}\n        )\n      )\n    }\n\n    table.getIsAllColumnsVisible = () =>\n      !table.getAllLeafColumns().some(column => !column.getIsVisible?.())\n\n    table.getIsSomeColumnsVisible = () =>\n      table.getAllLeafColumns().some(column => column.getIsVisible?.())\n\n    table.getToggleAllColumnsVisibilityHandler = () => {\n      return (e: unknown) => {\n        table.toggleAllColumnsVisible(\n          ((e as MouseEvent).target as HTMLInputElement)?.checked\n        )\n      }\n    }\n  },\n}\n\nexport function _getVisibleLeafColumns<TData extends RowData>(\n  table: Table<TData>,\n  position?: ColumnPinningPosition | 'center'\n) {\n  return !position\n    ? table.getVisibleLeafColumns()\n    : position === 'center'\n      ? table.getCenterVisibleLeafColumns()\n      : position === 'left'\n        ? table.getLeftVisibleLeafColumns()\n        : table.getRightVisibleLeafColumns()\n}\n"],"names":["makeStateUpdater","memo","getMemoOptions"],"mappings":";;;AAuJO,MAAM,mBAAiC;AAAA,EAC5C,iBAAiB,CAAC,UAAgC;AACzC,WAAA;AAAA,MACL,kBAAkB,CAAC;AAAA,MACnB,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEA,mBAAmB,CACjB,UAC6B;AACtB,WAAA;AAAA,MACL,0BAA0BA,MAAAA,iBAAiB,oBAAoB,KAAK;AAAA,IAAA;AAAA,EAExE;AAAA,EAEA,cAAc,CACZ,QACA,UACS;AACT,WAAO,mBAAmB,CAAS,UAAA;AAC7B,UAAA,OAAO,cAAc;AACvB,cAAM,oBAAoB,CAAQ,SAAA;AAAA,UAChC,GAAG;AAAA,UACH,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,OAAO,aAAa;AAAA,QAC3C,EAAA;AAAA,MACJ;AAAA,IAAA;AAEF,WAAO,eAAe,MAAM;;AAC1B,YAAM,eAAe,OAAO;AAC5B,cACG,aAAa,SACV,aAAa,KAAK,OAAK,EAAE,aAAc,CAAA,KACvC,WAAM,WAAW,qBAAjB,mBAAoC,OAAO,QAAQ;AAAA,IAAA;AAI3D,WAAO,aAAa,MAAM;AACxB,cACG,OAAO,UAAU,gBAAgB,UACjC,MAAM,QAAQ,gBAAgB;AAAA,IAAA;AAGnC,WAAO,6BAA6B,MAAM;AACxC,aAAO,CAAC,MAAe;;AACd,qBAAA,qBAAA;AAAA;AAAA,UACH,EAAiB,OAA4B;AAAA;AAAA,MACjD;AAAA,IACF;AAAA,EAEJ;AAAA,EAEA,WAAW,CACT,KACA,UACS;AACT,QAAI,sBAAsBC,MAAA;AAAA,MACxB,MAAM,CAAC,IAAI,YAAA,GAAe,MAAM,WAAW,gBAAgB;AAAA,MAC3D,CAAS,UAAA;AACP,eAAO,MAAM,OAAO,CAAA,SAAQ,KAAK,OAAO,cAAc;AAAA,MACxD;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,aAAa,qBAAqB;AAAA,IAAA;AAElE,QAAI,kBAAkBD,MAAA;AAAA,MACpB,MAAM;AAAA,QACJ,IAAI,oBAAoB;AAAA,QACxB,IAAI,sBAAsB;AAAA,QAC1B,IAAI,qBAAqB;AAAA,MAC3B;AAAA,MACA,CAAC,MAAM,QAAQ,UAAU,CAAC,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK;AAAA,MACtDC,MAAAA,eAAe,MAAM,SAAS,aAAa,iBAAiB;AAAA,IAAA;AAAA,EAEhE;AAAA,EAEA,aAAa,CAAwB,UAA8B;AAC3D,UAAA,2BAA2B,CAC/B,KACA,eACqC;AAC9B,aAAAD,MAAA;AAAA,QACL,MAAM;AAAA,UACJ,WAAW;AAAA,UACX,WAAW,EACR,OAAO,CAAA,MAAK,EAAE,aAAc,CAAA,EAC5B,IAAI,CAAK,MAAA,EAAE,EAAE,EACb,KAAK,GAAG;AAAA,QACb;AAAA,QACA,CAAW,YAAA;AACT,iBAAO,QAAQ,OAAO,CAAK,MAAA;;AAAA,2BAAE,iBAAF;AAAA,WAAkB;AAAA,QAC/C;AAAA,QACAC,MAAAA,eAAe,MAAM,SAAS,gBAAgB,GAAG;AAAA,MAAA;AAAA,IACnD;AAGF,UAAM,wBAAwB;AAAA,MAC5B;AAAA,MACA,MAAM,MAAM,kBAAkB;AAAA,IAAA;AAEhC,UAAM,wBAAwB;AAAA,MAC5B;AAAA,MACA,MAAM,MAAM,kBAAkB;AAAA,IAAA;AAEhC,UAAM,4BAA4B;AAAA,MAChC;AAAA,MACA,MAAM,MAAM,mBAAmB;AAAA,IAAA;AAEjC,UAAM,6BAA6B;AAAA,MACjC;AAAA,MACA,MAAM,MAAM,oBAAoB;AAAA,IAAA;AAElC,UAAM,8BAA8B;AAAA,MAClC;AAAA,MACA,MAAM,MAAM,qBAAqB;AAAA,IAAA;AAGnC,UAAM,sBAAsB,CAAA,YAAA;;AAC1B,+BAAM,SAAQ,6BAAd,4BAAyC;AAAA;AAE3C,UAAM,wBAAwB,CAAgB,iBAAA;AACtC,YAAA;AAAA,QACJ,eAAe,CAAA,IAAK,MAAM,aAAa,oBAAoB,CAAC;AAAA,MAAA;AAAA,IAC9D;AAGF,UAAM,0BAA0B,CAAS,UAAA;AAC/B,cAAA,SAAS,CAAC,MAAM,uBAAuB;AAEzC,YAAA;AAAA,QACJ,MAAM,oBAAoB;AAAA,UACxB,CAAC,KAAK,WAAY;;AAAA;AAAA,cAChB,GAAG;AAAA,cACH,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,GAAC,YAAO,eAAP,mCAAwB;AAAA,YAAA;AAAA;AAAA,UAEjD,CAAC;AAAA,QACH;AAAA,MAAA;AAAA,IACF;AAGI,UAAA,yBAAyB,MAC7B,CAAC,MAAM,kBAAoB,EAAA,KAAK,CAAU,WAAA;;AAAA,gBAAC,YAAO,iBAAP;AAAA,KAAuB;AAE9D,UAAA,0BAA0B,MAC9B,MAAM,oBAAoB,KAAK,CAAA,WAAU;;AAAA,0BAAO,iBAAP;AAAA,KAAuB;AAElE,UAAM,uCAAuC,MAAM;AACjD,aAAO,CAAC,MAAe;;AACf,cAAA;AAAA,WACF,OAAiB,WAAjB,mBAA8C;AAAA,QAAA;AAAA,MAClD;AAAA,IACF;AAAA,EAEJ;AACF;AAEgB,SAAA,uBACd,OACA,UACA;AACA,SAAO,CAAC,WACJ,MAAM,sBAAsB,IAC5B,aAAa,WACX,MAAM,4BAA4B,IAClC,aAAa,SACX,MAAM,0BAA0B,IAChC,MAAM;AAChB;;;"}

package/dist/cjs/features/ColumnVisibility.d.cts

@@ -0,0 +1,130 @@
+import { ColumnPinningPosition } from '..';
+import { Cell, Column, OnChangeFn, Table, Updater, RowData, TableFeature } from '../types';
+
+export type VisibilityState = Record<string, boolean>;
+export interface VisibilityTableState {
+    columnVisibility: VisibilityState;
+}
+export interface VisibilityOptions {
+    /**
+     * Whether to enable column hiding. Defaults to `true`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#enablehiding)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    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.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#oncolumnvisibilitychange)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    onColumnVisibilityChange?: OnChangeFn<VisibilityState>;
+}
+export type VisibilityDefaultOptions = Pick<VisibilityOptions, 'onColumnVisibilityChange'>;
+export interface VisibilityInstance<TData extends RowData> {
+    /**
+     * If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcentervisibleleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getCenterVisibleLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns whether all columns are visible
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisallcolumnsvisible)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getIsAllColumnsVisible: () => boolean;
+    /**
+     * Returns whether any columns are visible
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getissomecolumnsvisible)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getIsSomeColumnsVisible: () => boolean;
+    /**
+     * If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getleftvisibleleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getLeftVisibleLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getrightvisibleleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getRightVisibleLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns a handler for toggling the visibility of all columns, meant to be bound to a `input[type=checkbox]` element.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettoggleallcolumnsvisibilityhandler)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getToggleAllColumnsVisibilityHandler: () => (event: unknown) => void;
+    /**
+     * Returns a flat array of columns that are visible, including parent columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleflatcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getVisibleFlatColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns a flat array of leaf-node columns that are visible.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getVisibleLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Resets the column visibility state to the initial state. If `defaultState` is provided, the state will be reset to `{}`
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#resetcolumnvisibility)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    resetColumnVisibility: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.columnVisibility` state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#setcolumnvisibility)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    setColumnVisibility: (updater: Updater<VisibilityState>) => void;
+    /**
+     * Toggles the visibility of all columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#toggleallcolumnsvisible)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    toggleAllColumnsVisible: (value?: boolean) => void;
+}
+export interface VisibilityColumnDef {
+    enableHiding?: boolean;
+}
+export interface VisibilityRow<TData extends RowData> {
+    _getAllVisibleCells: () => Cell<TData, unknown>[];
+    /**
+     * Returns an array of cells that account for column visibility for the row.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisiblecells)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getVisibleCells: () => Cell<TData, unknown>[];
+}
+export interface VisibilityColumn {
+    /**
+     * Returns whether the column can be hidden
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcanhide)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getCanHide: () => boolean;
+    /**
+     * Returns whether the column is visible
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisvisible)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    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.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettogglevisibilityhandler)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    getToggleVisibilityHandler: () => (event: unknown) => void;
+    /**
+     * Toggles the visibility of the column.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#togglevisibility)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
+     */
+    toggleVisibility: (value?: boolean) => void;
+}
+export declare const ColumnVisibility: TableFeature;
+export declare function _getVisibleLeafColumns<TData extends RowData>(table: Table<TData>, position?: ColumnPinningPosition | 'center'): Column<TData, unknown>[];

package/dist/cjs/features/GlobalFaceting.cjs

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const GlobalFaceting = {
+  createTable: (table) => {
+    table._getGlobalFacetedRowModel = table.options.getFacetedRowModel && table.options.getFacetedRowModel(table, "__global__");
+    table.getGlobalFacetedRowModel = () => {
+      if (table.options.manualFiltering || !table._getGlobalFacetedRowModel) {
+        return table.getPreFilteredRowModel();
+      }
+      return table._getGlobalFacetedRowModel();
+    };
+    table._getGlobalFacetedUniqueValues = table.options.getFacetedUniqueValues && table.options.getFacetedUniqueValues(table, "__global__");
+    table.getGlobalFacetedUniqueValues = () => {
+      if (!table._getGlobalFacetedUniqueValues) {
+        return /* @__PURE__ */ new Map();
+      }
+      return table._getGlobalFacetedUniqueValues();
+    };
+    table._getGlobalFacetedMinMaxValues = table.options.getFacetedMinMaxValues && table.options.getFacetedMinMaxValues(table, "__global__");
+    table.getGlobalFacetedMinMaxValues = () => {
+      if (!table._getGlobalFacetedMinMaxValues) {
+        return;
+      }
+      return table._getGlobalFacetedMinMaxValues();
+    };
+  }
+};
+exports.GlobalFaceting = GlobalFaceting;
+//# sourceMappingURL=GlobalFaceting.cjs.map

package/dist/cjs/features/GlobalFaceting.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalFaceting.cjs","sources":["../../../src/features/GlobalFaceting.ts"],"sourcesContent":["import { RowModel } from '..'\nimport { Table, RowData, TableFeature } from '../types'\n\nexport interface GlobalFacetingInstance<TData extends RowData> {\n  _getGlobalFacetedMinMaxValues?: () => undefined | [number, number]\n  _getGlobalFacetedRowModel?: () => RowModel<TData>\n  _getGlobalFacetedUniqueValues?: () => Map<any, number>\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalautofilterfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)\n   */\n  getGlobalFacetedMinMaxValues: () => undefined | [number, number]\n  /**\n   * Returns the row model for the table after **global** filtering has been applied.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedrowmodel)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)\n   */\n  getGlobalFacetedRowModel: () => RowModel<TData>\n  /**\n   * Returns the faceted unique values for the global filter.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfaceteduniquevalues)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)\n   */\n  getGlobalFacetedUniqueValues: () => Map<any, number>\n}\n\n//\n\nexport const GlobalFaceting: TableFeature = {\n  createTable: <TData extends RowData>(table: Table<TData>): void => {\n    table._getGlobalFacetedRowModel =\n      table.options.getFacetedRowModel &&\n      table.options.getFacetedRowModel(table, '__global__')\n\n    table.getGlobalFacetedRowModel = () => {\n      if (table.options.manualFiltering || !table._getGlobalFacetedRowModel) {\n        return table.getPreFilteredRowModel()\n      }\n\n      return table._getGlobalFacetedRowModel()\n    }\n\n    table._getGlobalFacetedUniqueValues =\n      table.options.getFacetedUniqueValues &&\n      table.options.getFacetedUniqueValues(table, '__global__')\n    table.getGlobalFacetedUniqueValues = () => {\n      if (!table._getGlobalFacetedUniqueValues) {\n        return new Map()\n      }\n\n      return table._getGlobalFacetedUniqueValues()\n    }\n\n    table._getGlobalFacetedMinMaxValues =\n      table.options.getFacetedMinMaxValues &&\n      table.options.getFacetedMinMaxValues(table, '__global__')\n    table.getGlobalFacetedMinMaxValues = () => {\n      if (!table._getGlobalFacetedMinMaxValues) {\n        return\n      }\n\n      return table._getGlobalFacetedMinMaxValues()\n    }\n  },\n}\n"],"names":[],"mappings":";;AA6BO,MAAM,iBAA+B;AAAA,EAC1C,aAAa,CAAwB,UAA8B;AAC3D,UAAA,4BACJ,MAAM,QAAQ,sBACd,MAAM,QAAQ,mBAAmB,OAAO,YAAY;AAEtD,UAAM,2BAA2B,MAAM;AACrC,UAAI,MAAM,QAAQ,mBAAmB,CAAC,MAAM,2BAA2B;AACrE,eAAO,MAAM;MACf;AAEA,aAAO,MAAM;IAA0B;AAGnC,UAAA,gCACJ,MAAM,QAAQ,0BACd,MAAM,QAAQ,uBAAuB,OAAO,YAAY;AAC1D,UAAM,+BAA+B,MAAM;AACrC,UAAA,CAAC,MAAM,+BAA+B;AACxC,mCAAW,IAAI;AAAA,MACjB;AAEA,aAAO,MAAM;IAA8B;AAGvC,UAAA,gCACJ,MAAM,QAAQ,0BACd,MAAM,QAAQ,uBAAuB,OAAO,YAAY;AAC1D,UAAM,+BAA+B,MAAM;AACrC,UAAA,CAAC,MAAM,+BAA+B;AACxC;AAAA,MACF;AAEA,aAAO,MAAM;IAA8B;AAAA,EAE/C;AACF;;"}

package/dist/cjs/features/GlobalFaceting.d.cts

@@ -0,0 +1,27 @@
+import { RowModel } from '..';
+import { RowData, TableFeature } from '../types';
+
+export interface GlobalFacetingInstance<TData extends RowData> {
+    _getGlobalFacetedMinMaxValues?: () => undefined | [number, number];
+    _getGlobalFacetedRowModel?: () => RowModel<TData>;
+    _getGlobalFacetedUniqueValues?: () => Map<any, number>;
+    /**
+     * 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.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalautofilterfn)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
+     */
+    getGlobalFacetedMinMaxValues: () => undefined | [number, number];
+    /**
+     * Returns the row model for the table after **global** filtering has been applied.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedrowmodel)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
+     */
+    getGlobalFacetedRowModel: () => RowModel<TData>;
+    /**
+     * Returns the faceted unique values for the global filter.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfaceteduniquevalues)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
+     */
+    getGlobalFacetedUniqueValues: () => Map<any, number>;
+}
+export declare const GlobalFaceting: TableFeature;

package/dist/cjs/features/GlobalFiltering.cjs

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const filterFns = require("../filterFns.cjs");
+const utils = require("../utils.cjs");
+const GlobalFiltering = {
+  getInitialState: (state) => {
+    return {
+      globalFilter: void 0,
+      ...state
+    };
+  },
+  getDefaultOptions: (table) => {
+    return {
+      onGlobalFilterChange: utils.makeStateUpdater("globalFilter", table),
+      globalFilterFn: "auto",
+      getColumnCanGlobalFilter: (column) => {
+        var _a, _b;
+        const value = (_b = (_a = table.getCoreRowModel().flatRows[0]) == null ? void 0 : _a._getAllCellsByColumnId()[column.id]) == null ? void 0 : _b.getValue();
+        return typeof value === "string" || typeof value === "number";
+      }
+    };
+  },
+  createColumn: (column, table) => {
+    column.getCanGlobalFilter = () => {
+      var _a, _b;
+      return (column.columnDef.enableGlobalFilter ?? true) && (table.options.enableGlobalFilter ?? true) && (table.options.enableFilters ?? true) && (((_b = (_a = table.options).getColumnCanGlobalFilter) == null ? void 0 : _b.call(_a, column)) ?? true) && !!column.accessorFn;
+    };
+  },
+  createTable: (table) => {
+    table.getGlobalAutoFilterFn = () => {
+      return filterFns.filterFns.includesString;
+    };
+    table.getGlobalFilterFn = () => {
+      var _a;
+      const { globalFilterFn } = table.options;
+      return utils.isFunction(globalFilterFn) ? globalFilterFn : globalFilterFn === "auto" ? table.getGlobalAutoFilterFn() : ((_a = table.options.filterFns) == null ? void 0 : _a[globalFilterFn]) ?? filterFns.filterFns[globalFilterFn];
+    };
+    table.setGlobalFilter = (updater) => {
+      var _a, _b;
+      (_b = (_a = table.options).onGlobalFilterChange) == null ? void 0 : _b.call(_a, updater);
+    };
+    table.resetGlobalFilter = (defaultState) => {
+      table.setGlobalFilter(
+        defaultState ? void 0 : table.initialState.globalFilter
+      );
+    };
+  }
+};
+exports.GlobalFiltering = GlobalFiltering;
+//# sourceMappingURL=GlobalFiltering.cjs.map

package/dist/cjs/features/GlobalFiltering.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"GlobalFiltering.cjs","sources":["../../../src/features/GlobalFiltering.ts"],"sourcesContent":["import { FilterFn, FilterFnOption } from '..'\nimport { BuiltInFilterFn, filterFns } from '../filterFns'\nimport {\n  Column,\n  OnChangeFn,\n  Table,\n  Updater,\n  RowData,\n  TableFeature,\n} from '../types'\nimport { isFunction, makeStateUpdater } from '../utils'\n\nexport interface GlobalFilterTableState {\n  globalFilter: any\n}\n\nexport interface GlobalFilterColumnDef {\n  /**\n   * Enables/disables the **global** filter for this column.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#enableglobalfilter)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  enableGlobalFilter?: boolean\n}\n\nexport interface GlobalFilterColumn {\n  /**\n   * Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getcanglobalfilter)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  getCanGlobalFilter: () => boolean\n}\n\nexport interface GlobalFilterOptions<TData extends RowData> {\n  /**\n   * Enables/disables **global** filtering for all columns.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#enableglobalfilter)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  enableGlobalFilter?: boolean\n  /**\n   * 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.\n   *\n   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getcolumncanglobalfilter)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  getColumnCanGlobalFilter?: (column: Column<TData, unknown>) => boolean\n  /**\n   * The filter function to use for global filtering.\n   * - A `string` referencing a built-in filter function\n   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option\n   * - A custom filter function\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#globalfilterfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  globalFilterFn?: FilterFnOption<TData>\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#onglobalfilterchange)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  onGlobalFilterChange?: OnChangeFn<any>\n}\n\nexport interface GlobalFilterInstance<TData extends RowData> {\n  /**\n   * 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.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getglobalautofilterfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  getGlobalAutoFilterFn: () => FilterFn<TData> | undefined\n  /**\n   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getglobalfilterfn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  getGlobalFilterFn: () => FilterFn<TData> | undefined\n  /**\n   * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#resetglobalfilter)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  resetGlobalFilter: (defaultState?: boolean) => void\n  /**\n   * Sets or updates the `state.globalFilter` state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#setglobalfilter)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)\n   */\n  setGlobalFilter: (updater: Updater<any>) => void\n}\n\n//\n\nexport const GlobalFiltering: TableFeature = {\n  getInitialState: (state): GlobalFilterTableState => {\n    return {\n      globalFilter: undefined,\n      ...state,\n    }\n  },\n\n  getDefaultOptions: <TData extends RowData>(\n    table: Table<TData>\n  ): GlobalFilterOptions<TData> => {\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    } as GlobalFilterOptions<TData>\n  },\n\n  createColumn: <TData extends RowData>(\n    column: Column<TData, unknown>,\n    table: Table<TData>\n  ): void => {\n    column.getCanGlobalFilter = () => {\n      return (\n        (column.columnDef.enableGlobalFilter ?? true) &&\n        (table.options.enableGlobalFilter ?? true) &&\n        (table.options.enableFilters ?? true) &&\n        (table.options.getColumnCanGlobalFilter?.(column) ?? true) &&\n        !!column.accessorFn\n      )\n    }\n  },\n\n  createTable: <TData extends RowData>(table: Table<TData>): void => {\n    table.getGlobalAutoFilterFn = () => {\n      return filterFns.includesString\n    }\n\n    table.getGlobalFilterFn = () => {\n      const { globalFilterFn: globalFilterFn } = table.options\n\n      return isFunction(globalFilterFn)\n        ? globalFilterFn\n        : globalFilterFn === 'auto'\n          ? table.getGlobalAutoFilterFn()\n          : table.options.filterFns?.[globalFilterFn as string] ??\n            filterFns[globalFilterFn as BuiltInFilterFn]\n    }\n\n    table.setGlobalFilter = updater => {\n      table.options.onGlobalFilterChange?.(updater)\n    }\n\n    table.resetGlobalFilter = defaultState => {\n      table.setGlobalFilter(\n        defaultState ? undefined : table.initialState.globalFilter\n      )\n    }\n  },\n}\n"],"names":["makeStateUpdater","filterFns","isFunction"],"mappings":";;;;AA+FO,MAAM,kBAAgC;AAAA,EAC3C,iBAAiB,CAAC,UAAkC;AAC3C,WAAA;AAAA,MACL,cAAc;AAAA,MACd,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEA,mBAAmB,CACjB,UAC+B;AACxB,WAAA;AAAA,MACL,sBAAsBA,MAAAA,iBAAiB,gBAAgB,KAAK;AAAA,MAC5D,gBAAgB;AAAA,MAChB,0BAA0B,CAAU,WAAA;;AAClC,cAAM,SAAQ,iBACX,gBAAgB,EAChB,SAAS,CAAC,MAFC,mBAEE,yBACb,OAAO,QAHI,mBAGC;AAEf,eAAO,OAAO,UAAU,YAAY,OAAO,UAAU;AAAA,MACvD;AAAA,IAAA;AAAA,EAEJ;AAAA,EAEA,cAAc,CACZ,QACA,UACS;AACT,WAAO,qBAAqB,MAAM;;AAE7B,cAAA,OAAO,UAAU,sBAAsB,UACvC,MAAM,QAAQ,sBAAsB,UACpC,MAAM,QAAQ,iBAAiB,YAC/B,iBAAM,SAAQ,6BAAd,4BAAyC,YAAW,SACrD,CAAC,CAAC,OAAO;AAAA,IAAA;AAAA,EAGf;AAAA,EAEA,aAAa,CAAwB,UAA8B;AACjE,UAAM,wBAAwB,MAAM;AAClC,aAAOC,UAAAA,UAAU;AAAA,IAAA;AAGnB,UAAM,oBAAoB,MAAM;;AACxB,YAAA,EAAE,eAA+B,IAAI,MAAM;AAEjD,aAAOC,MAAAA,WAAW,cAAc,IAC5B,iBACA,mBAAmB,SACjB,MAAM,sBAAsB,MAC5B,WAAM,QAAQ,cAAd,mBAA0B,oBAC1BD,UAAAA,UAAU,cAAiC;AAAA,IAAA;AAGnD,UAAM,kBAAkB,CAAW,YAAA;;AAC3B,wBAAA,SAAQ,yBAAR,4BAA+B;AAAA,IAAO;AAG9C,UAAM,oBAAoB,CAAgB,iBAAA;AAClC,YAAA;AAAA,QACJ,eAAe,SAAY,MAAM,aAAa;AAAA,MAAA;AAAA,IAChD;AAAA,EAEJ;AACF;;"}