@tanstack/table-core 8.19.2 → 9.0.0-alpha.10

package/dist/cjs/features/ColumnOrdering.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColumnOrdering.cjs","sources":["../../../src/features/ColumnOrdering.ts"],"sourcesContent":["import { getMemoOptions, makeStateUpdater, memo } from '../utils'\n\nimport {\n  Column,\n  OnChangeFn,\n  RowData,\n  Table,\n  TableFeature,\n  Updater,\n} from '../types'\n\nimport { orderColumns } from './ColumnGrouping'\nimport { ColumnPinningPosition, _getVisibleLeafColumns } from '..'\n\nexport interface ColumnOrderTableState {\n  columnOrder: ColumnOrderState\n}\n\nexport type ColumnOrderState = string[]\n\nexport interface ColumnOrderOptions {\n  /**\n   * If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#oncolumnorderchange)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n   */\n  onColumnOrderChange?: OnChangeFn<ColumnOrderState>\n}\n\nexport interface ColumnOrderColumn {\n  /**\n   * Returns the index of the column in the order of the visible columns. Optionally pass a `position` parameter to get the index of the column in a sub-section of the table\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getindex)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n   */\n  getIndex: (position?: ColumnPinningPosition | 'center') => number\n  /**\n   * Returns `true` if the column is the first column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the first in a sub-section of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getisfirstcolumn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n   */\n  getIsFirstColumn: (position?: ColumnPinningPosition | 'center') => boolean\n  /**\n   * Returns `true` if the column is the last column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the last in a sub-section of the table.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getislastcolumn)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n   */\n  getIsLastColumn: (position?: ColumnPinningPosition | 'center') => boolean\n}\n\nexport interface ColumnOrderDefaultOptions {\n  onColumnOrderChange: OnChangeFn<ColumnOrderState>\n}\n\nexport interface ColumnOrderInstance<TData extends RowData> {\n  _getOrderColumnsFn: () => (\n    columns: Column<TData, unknown>[]\n  ) => Column<TData, unknown>[]\n  /**\n   * Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#resetcolumnorder)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n   */\n  resetColumnOrder: (defaultState?: boolean) => void\n  /**\n   * Sets or updates the `state.columnOrder` state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#setcolumnorder)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)\n   */\n  setColumnOrder: (updater: Updater<ColumnOrderState>) => void\n}\n\n//\n\nexport const ColumnOrdering: TableFeature = {\n  _getInitialState: (state): ColumnOrderTableState => {\n    return {\n      columnOrder: [],\n      ...state,\n    }\n  },\n\n  _getDefaultOptions: <TData extends RowData>(\n    table: Table<TData>\n  ): ColumnOrderDefaultOptions => {\n    return {\n      onColumnOrderChange: makeStateUpdater('columnOrder', table),\n    }\n  },\n\n  _createColumn: <TData extends RowData>(\n    column: Column<TData, unknown>,\n    table: Table<TData>\n  ): void => {\n    column.getIndex = memo(\n      position => [_getVisibleLeafColumns(table, position)],\n      columns => columns.findIndex(d => d.id === column.id),\n      getMemoOptions(table.options, 'debugColumns', 'getIndex')\n    )\n    column.getIsFirstColumn = position => {\n      const columns = _getVisibleLeafColumns(table, position)\n      return columns[0]?.id === column.id\n    }\n    column.getIsLastColumn = position => {\n      const columns = _getVisibleLeafColumns(table, position)\n      return columns[columns.length - 1]?.id === column.id\n    }\n  },\n\n  _createTable: <TData extends RowData>(table: Table<TData>): void => {\n    table.setColumnOrder = updater =>\n      table.options.onColumnOrderChange?.(updater)\n    table.resetColumnOrder = defaultState => {\n      table.setColumnOrder(\n        defaultState ? [] : table.initialState.columnOrder ?? []\n      )\n    }\n    table._getOrderColumnsFn = memo(\n      () => [\n        table.getState().columnOrder,\n        table.getState().grouping,\n        table.options.groupedColumnMode,\n      ],\n      (columnOrder, grouping, groupedColumnMode) =>\n        (columns: Column<TData, unknown>[]) => {\n          // Sort grouped columns to the start of the column list\n          // before the headers are built\n          let orderedColumns: Column<TData, unknown>[] = []\n\n          // If there is no order, return the normal columns\n          if (!columnOrder?.length) {\n            orderedColumns = columns\n          } else {\n            const columnOrderCopy = [...columnOrder]\n\n            // If there is an order, make a copy of the columns\n            const columnsCopy = [...columns]\n\n            // And make a new ordered array of the columns\n\n            // Loop over the columns and place them in order into the new array\n            while (columnsCopy.length && columnOrderCopy.length) {\n              const targetColumnId = columnOrderCopy.shift()\n              const foundIndex = columnsCopy.findIndex(\n                d => d.id === targetColumnId\n              )\n              if (foundIndex > -1) {\n                orderedColumns.push(columnsCopy.splice(foundIndex, 1)[0]!)\n              }\n            }\n\n            // If there are any columns left, add them to the end\n            orderedColumns = [...orderedColumns, ...columnsCopy]\n          }\n\n          return orderColumns(orderedColumns, grouping, groupedColumnMode)\n        },\n      getMemoOptions(table.options, 'debugTable', '_getOrderColumnsFn')\n    )\n  },\n}\n"],"names":["makeStateUpdater","memo","_getVisibleLeafColumns","getMemoOptions","orderColumns"],"mappings":";;;;;AA0EO,MAAM,iBAA+B;AAAA,EAC1C,kBAAkB,CAAC,UAAiC;AAC3C,WAAA;AAAA,MACL,aAAa,CAAC;AAAA,MACd,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEA,oBAAoB,CAClB,UAC8B;AACvB,WAAA;AAAA,MACL,qBAAqBA,MAAAA,iBAAiB,eAAe,KAAK;AAAA,IAAA;AAAA,EAE9D;AAAA,EAEA,eAAe,CACb,QACA,UACS;AACT,WAAO,WAAWC,MAAA;AAAA,MAChB,CAAY,aAAA,CAACC,iBAAAA,uBAAuB,OAAO,QAAQ,CAAC;AAAA,MACpD,aAAW,QAAQ,UAAU,OAAK,EAAE,OAAO,OAAO,EAAE;AAAA,MACpDC,MAAAA,eAAe,MAAM,SAAS,gBAAgB,UAAU;AAAA,IAAA;AAE1D,WAAO,mBAAmB,CAAY,aAAA;;AAC9B,YAAA,UAAUD,iBAAAA,uBAAuB,OAAO,QAAQ;AACtD,eAAO,aAAQ,CAAC,MAAT,mBAAY,QAAO,OAAO;AAAA,IAAA;AAEnC,WAAO,kBAAkB,CAAY,aAAA;;AAC7B,YAAA,UAAUA,iBAAAA,uBAAuB,OAAO,QAAQ;AACtD,eAAO,aAAQ,QAAQ,SAAS,CAAC,MAA1B,mBAA6B,QAAO,OAAO;AAAA,IAAA;AAAA,EAEtD;AAAA,EAEA,cAAc,CAAwB,UAA8B;AAClE,UAAM,iBAAiB,CAAA,YAAA;;AACrB,+BAAM,SAAQ,wBAAd,4BAAoC;AAAA;AACtC,UAAM,mBAAmB,CAAgB,iBAAA;AACjC,YAAA;AAAA,QACJ,eAAe,CAAA,IAAK,MAAM,aAAa,eAAe,CAAC;AAAA,MAAA;AAAA,IACzD;AAEF,UAAM,qBAAqBD,MAAA;AAAA,MACzB,MAAM;AAAA,QACJ,MAAM,WAAW;AAAA,QACjB,MAAM,WAAW;AAAA,QACjB,MAAM,QAAQ;AAAA,MAChB;AAAA,MACA,CAAC,aAAa,UAAU,sBACtB,CAAC,YAAsC;AAGrC,YAAI,iBAA2C,CAAA;AAG3C,YAAA,EAAC,2CAAa,SAAQ;AACP,2BAAA;AAAA,QAAA,OACZ;AACC,gBAAA,kBAAkB,CAAC,GAAG,WAAW;AAGjC,gBAAA,cAAc,CAAC,GAAG,OAAO;AAKxB,iBAAA,YAAY,UAAU,gBAAgB,QAAQ;AAC7C,kBAAA,iBAAiB,gBAAgB;AACvC,kBAAM,aAAa,YAAY;AAAA,cAC7B,CAAA,MAAK,EAAE,OAAO;AAAA,YAAA;AAEhB,gBAAI,aAAa,IAAI;AACnB,6BAAe,KAAK,YAAY,OAAO,YAAY,CAAC,EAAE,CAAC,CAAE;AAAA,YAC3D;AAAA,UACF;AAGA,2BAAiB,CAAC,GAAG,gBAAgB,GAAG,WAAW;AAAA,QACrD;AAEO,eAAAG,4BAAa,gBAAgB,UAAU,iBAAiB;AAAA,MACjE;AAAA,MACFD,MAAAA,eAAe,MAAM,SAAS,cAAc,oBAAoB;AAAA,IAAA;AAAA,EAEpE;AACF;;"}

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

@@ -0,0 +1,54 @@
+import { Column, OnChangeFn, RowData, TableFeature, Updater } from '../types';
+import { ColumnPinningPosition } from '..';
+
+export interface ColumnOrderTableState {
+    columnOrder: ColumnOrderState;
+}
+export type ColumnOrderState = string[];
+export interface ColumnOrderOptions {
+    /**
+     * If provided, this function will be called with an `updaterFn` when `state.columnOrder` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#oncolumnorderchange)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+     */
+    onColumnOrderChange?: OnChangeFn<ColumnOrderState>;
+}
+export interface ColumnOrderColumn {
+    /**
+     * Returns the index of the column in the order of the visible columns. Optionally pass a `position` parameter to get the index of the column in a sub-section of the table
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getindex)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+     */
+    getIndex: (position?: ColumnPinningPosition | 'center') => number;
+    /**
+     * Returns `true` if the column is the first column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the first in a sub-section of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getisfirstcolumn)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+     */
+    getIsFirstColumn: (position?: ColumnPinningPosition | 'center') => boolean;
+    /**
+     * Returns `true` if the column is the last column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the last in a sub-section of the table.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getislastcolumn)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+     */
+    getIsLastColumn: (position?: ColumnPinningPosition | 'center') => boolean;
+}
+export interface ColumnOrderDefaultOptions {
+    onColumnOrderChange: OnChangeFn<ColumnOrderState>;
+}
+export interface ColumnOrderInstance<TData extends RowData> {
+    _getOrderColumnsFn: () => (columns: Column<TData, unknown>[]) => Column<TData, unknown>[];
+    /**
+     * Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#resetcolumnorder)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+     */
+    resetColumnOrder: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.columnOrder` state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#setcolumnorder)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
+     */
+    setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
+}
+export declare const ColumnOrdering: TableFeature;

package/dist/cjs/features/ColumnPinning.cjs

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const utils = require("../utils.cjs");
+const getDefaultColumnPinningState = () => ({
+  left: [],
+  right: []
+});
+const ColumnPinning = {
+  _getInitialState: (state) => {
+    return {
+      columnPinning: getDefaultColumnPinningState(),
+      ...state
+    };
+  },
+  _getDefaultOptions: (table) => {
+    return {
+      onColumnPinningChange: utils.makeStateUpdater("columnPinning", table)
+    };
+  },
+  _createColumn: (column, table) => {
+    column.pin = (position) => {
+      const columnIds = column.getLeafColumns().map((d) => d.id).filter(Boolean);
+      table.setColumnPinning((old) => {
+        if (position === "right") {
+          return {
+            left: ((old == null ? void 0 : old.left) ?? []).filter((d) => !(columnIds == null ? void 0 : columnIds.includes(d))),
+            right: [
+              ...((old == null ? void 0 : old.right) ?? []).filter((d) => !(columnIds == null ? void 0 : columnIds.includes(d))),
+              ...columnIds
+            ]
+          };
+        }
+        if (position === "left") {
+          return {
+            left: [
+              ...((old == null ? void 0 : old.left) ?? []).filter((d) => !(columnIds == null ? void 0 : columnIds.includes(d))),
+              ...columnIds
+            ],
+            right: ((old == null ? void 0 : old.right) ?? []).filter((d) => !(columnIds == null ? void 0 : columnIds.includes(d)))
+          };
+        }
+        return {
+          left: ((old == null ? void 0 : old.left) ?? []).filter((d) => !(columnIds == null ? void 0 : columnIds.includes(d))),
+          right: ((old == null ? void 0 : old.right) ?? []).filter((d) => !(columnIds == null ? void 0 : columnIds.includes(d)))
+        };
+      });
+    };
+    column.getCanPin = () => {
+      const leafColumns = column.getLeafColumns();
+      return leafColumns.some(
+        (d) => (d.columnDef.enablePinning ?? true) && (table.options.enableColumnPinning ?? table.options.enablePinning ?? true)
+      );
+    };
+    column.getIsPinned = () => {
+      const leafColumnIds = column.getLeafColumns().map((d) => d.id);
+      const { left, right } = table.getState().columnPinning;
+      const isLeft = leafColumnIds.some((d) => left == null ? void 0 : left.includes(d));
+      const isRight = leafColumnIds.some((d) => right == null ? void 0 : right.includes(d));
+      return isLeft ? "left" : isRight ? "right" : false;
+    };
+    column.getPinnedIndex = () => {
+      var _a, _b;
+      const position = column.getIsPinned();
+      return position ? ((_b = (_a = table.getState().columnPinning) == null ? void 0 : _a[position]) == null ? void 0 : _b.indexOf(column.id)) ?? -1 : 0;
+    };
+  },
+  _createRow: (row, table) => {
+    row.getCenterVisibleCells = utils.memo(
+      () => [
+        row._getAllVisibleCells(),
+        table.getState().columnPinning.left,
+        table.getState().columnPinning.right
+      ],
+      (allCells, left, right) => {
+        const leftAndRight = [...left ?? [], ...right ?? []];
+        return allCells.filter((d) => !leftAndRight.includes(d.column.id));
+      },
+      utils.getMemoOptions(table.options, "debugRows", "getCenterVisibleCells")
+    );
+    row.getLeftVisibleCells = utils.memo(
+      () => [row._getAllVisibleCells(), table.getState().columnPinning.left],
+      (allCells, left) => {
+        const cells = (left ?? []).map((columnId) => allCells.find((cell) => cell.column.id === columnId)).filter(Boolean).map((d) => ({ ...d, position: "left" }));
+        return cells;
+      },
+      utils.getMemoOptions(table.options, "debugRows", "getLeftVisibleCells")
+    );
+    row.getRightVisibleCells = utils.memo(
+      () => [row._getAllVisibleCells(), table.getState().columnPinning.right],
+      (allCells, right) => {
+        const cells = (right ?? []).map((columnId) => allCells.find((cell) => cell.column.id === columnId)).filter(Boolean).map((d) => ({ ...d, position: "right" }));
+        return cells;
+      },
+      utils.getMemoOptions(table.options, "debugRows", "getRightVisibleCells")
+    );
+  },
+  _createTable: (table) => {
+    table.setColumnPinning = (updater) => {
+      var _a, _b;
+      return (_b = (_a = table.options).onColumnPinningChange) == null ? void 0 : _b.call(_a, updater);
+    };
+    table.resetColumnPinning = (defaultState) => {
+      var _a;
+      return table.setColumnPinning(
+        defaultState ? getDefaultColumnPinningState() : ((_a = table.initialState) == null ? void 0 : _a.columnPinning) ?? getDefaultColumnPinningState()
+      );
+    };
+    table.getIsSomeColumnsPinned = (position) => {
+      var _a, _b, _c;
+      const pinningState = table.getState().columnPinning;
+      if (!position) {
+        return Boolean(((_a = pinningState.left) == null ? void 0 : _a.length) || ((_b = pinningState.right) == null ? void 0 : _b.length));
+      }
+      return Boolean((_c = pinningState[position]) == null ? void 0 : _c.length);
+    };
+    table.getLeftLeafColumns = utils.memo(
+      () => [table.getAllLeafColumns(), table.getState().columnPinning.left],
+      (allColumns, left) => {
+        return (left ?? []).map((columnId) => allColumns.find((column) => column.id === columnId)).filter(Boolean);
+      },
+      utils.getMemoOptions(table.options, "debugColumns", "getLeftLeafColumns")
+    );
+    table.getRightLeafColumns = utils.memo(
+      () => [table.getAllLeafColumns(), table.getState().columnPinning.right],
+      (allColumns, right) => {
+        return (right ?? []).map((columnId) => allColumns.find((column) => column.id === columnId)).filter(Boolean);
+      },
+      utils.getMemoOptions(table.options, "debugColumns", "getRightLeafColumns")
+    );
+    table.getCenterLeafColumns = utils.memo(
+      () => [
+        table.getAllLeafColumns(),
+        table.getState().columnPinning.left,
+        table.getState().columnPinning.right
+      ],
+      (allColumns, left, right) => {
+        const leftAndRight = [...left ?? [], ...right ?? []];
+        return allColumns.filter((d) => !leftAndRight.includes(d.id));
+      },
+      utils.getMemoOptions(table.options, "debugColumns", "getCenterLeafColumns")
+    );
+  }
+};
+exports.ColumnPinning = ColumnPinning;
+//# sourceMappingURL=ColumnPinning.cjs.map

package/dist/cjs/features/ColumnPinning.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ColumnPinning.cjs","sources":["../../../src/features/ColumnPinning.ts"],"sourcesContent":["import {\n  OnChangeFn,\n  Updater,\n  Table,\n  Column,\n  Row,\n  Cell,\n  RowData,\n  TableFeature,\n} from '../types'\nimport { getMemoOptions, makeStateUpdater, memo } from '../utils'\n\nexport type ColumnPinningPosition = false | 'left' | 'right'\n\nexport interface ColumnPinningState {\n  left?: string[]\n  right?: string[]\n}\n\nexport interface ColumnPinningTableState {\n  columnPinning: ColumnPinningState\n}\n\nexport interface ColumnPinningOptions {\n  /**\n   * Enables/disables column pinning for the table. Defaults to `true`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablecolumnpinning)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  enableColumnPinning?: boolean\n  /**\n   * @deprecated Use `enableColumnPinning` or `enableRowPinning` instead.\n   * Enables/disables all pinning for the table. Defaults to `true`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  enablePinning?: boolean\n  /**\n   * If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#oncolumnpinningchange)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/oncolumnpinningchange)\n   */\n  onColumnPinningChange?: OnChangeFn<ColumnPinningState>\n}\n\nexport interface ColumnPinningDefaultOptions {\n  onColumnPinningChange: OnChangeFn<ColumnPinningState>\n}\n\nexport interface ColumnPinningColumnDef {\n  /**\n   * Enables/disables column pinning for this column. Defaults to `true`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning-1)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  enablePinning?: boolean\n}\n\nexport interface ColumnPinningColumn {\n  /**\n   * Returns whether or not the column can be pinned.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcanpin)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getCanPin: () => boolean\n  /**\n   * Returns the pinned position of the column. (`'left'`, `'right'` or `false`)\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getispinned)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getIsPinned: () => ColumnPinningPosition\n  /**\n   * Returns the numeric pinned index of the column within a pinned column group.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getpinnedindex)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getPinnedIndex: () => number\n  /**\n   * Pins a column to the `'left'` or `'right'`, or unpins the column to the center if `false` is passed.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#pin)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  pin: (position: ColumnPinningPosition) => void\n}\n\nexport interface ColumnPinningRow<TData extends RowData> {\n  /**\n   * Returns all center pinned (unpinned) leaf cells in the row.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcentervisiblecells)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getCenterVisibleCells: () => Cell<TData, unknown>[]\n  /**\n   * Returns all left pinned leaf cells in the row.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftvisiblecells)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getLeftVisibleCells: () => Cell<TData, unknown>[]\n  /**\n   * Returns all right pinned leaf cells in the row.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightvisiblecells)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getRightVisibleCells: () => Cell<TData, unknown>[]\n}\n\nexport interface ColumnPinningInstance<TData extends RowData> {\n  /**\n   * Returns all center pinned (unpinned) leaf columns.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcenterleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getCenterLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the `left` or `right` position.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getissomecolumnspinned)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean\n  /**\n   * Returns all left pinned leaf columns.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getLeftLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * Returns all right pinned leaf columns.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightleafcolumns)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  getRightLeafColumns: () => Column<TData, unknown>[]\n  /**\n   * Resets the **columnPinning** state to `initialState.columnPinning`, or `true` can be passed to force a default blank state reset to `{ left: [], right: [], }`.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#resetcolumnpinning)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  resetColumnPinning: (defaultState?: boolean) => void\n  /**\n   * Sets or updates the `state.columnPinning` state.\n   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#setcolumnpinning)\n   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)\n   */\n  setColumnPinning: (updater: Updater<ColumnPinningState>) => void\n}\n\n//\n\nconst getDefaultColumnPinningState = (): ColumnPinningState => ({\n  left: [],\n  right: [],\n})\n\nexport const ColumnPinning: TableFeature = {\n  _getInitialState: (state): ColumnPinningTableState => {\n    return {\n      columnPinning: getDefaultColumnPinningState(),\n      ...state,\n    }\n  },\n\n  _getDefaultOptions: <TData extends RowData>(\n    table: Table<TData>\n  ): ColumnPinningDefaultOptions => {\n    return {\n      onColumnPinningChange: makeStateUpdater('columnPinning', table),\n    }\n  },\n\n  _createColumn: <TData extends RowData, TValue>(\n    column: Column<TData, TValue>,\n    table: Table<TData>\n  ): void => {\n    column.pin = position => {\n      const columnIds = column\n        .getLeafColumns()\n        .map(d => d.id)\n        .filter(Boolean) as string[]\n\n      table.setColumnPinning(old => {\n        if (position === 'right') {\n          return {\n            left: (old?.left ?? []).filter(d => !columnIds?.includes(d)),\n            right: [\n              ...(old?.right ?? []).filter(d => !columnIds?.includes(d)),\n              ...columnIds,\n            ],\n          }\n        }\n\n        if (position === 'left') {\n          return {\n            left: [\n              ...(old?.left ?? []).filter(d => !columnIds?.includes(d)),\n              ...columnIds,\n            ],\n            right: (old?.right ?? []).filter(d => !columnIds?.includes(d)),\n          }\n        }\n\n        return {\n          left: (old?.left ?? []).filter(d => !columnIds?.includes(d)),\n          right: (old?.right ?? []).filter(d => !columnIds?.includes(d)),\n        }\n      })\n    }\n\n    column.getCanPin = () => {\n      const leafColumns = column.getLeafColumns()\n\n      return leafColumns.some(\n        d =>\n          (d.columnDef.enablePinning ?? true) &&\n          (table.options.enableColumnPinning ??\n            table.options.enablePinning ??\n            true)\n      )\n    }\n\n    column.getIsPinned = () => {\n      const leafColumnIds = column.getLeafColumns().map(d => d.id)\n\n      const { left, right } = table.getState().columnPinning\n\n      const isLeft = leafColumnIds.some(d => left?.includes(d))\n      const isRight = leafColumnIds.some(d => right?.includes(d))\n\n      return isLeft ? 'left' : isRight ? 'right' : false\n    }\n\n    column.getPinnedIndex = () => {\n      const position = column.getIsPinned()\n\n      return position\n        ? table.getState().columnPinning?.[position]?.indexOf(column.id) ?? -1\n        : 0\n    }\n  },\n\n  _createRow: <TData extends RowData>(\n    row: Row<TData>,\n    table: Table<TData>\n  ): void => {\n    row.getCenterVisibleCells = memo(\n      () => [\n        row._getAllVisibleCells(),\n        table.getState().columnPinning.left,\n        table.getState().columnPinning.right,\n      ],\n      (allCells, left, right) => {\n        const leftAndRight: string[] = [...(left ?? []), ...(right ?? [])]\n\n        return allCells.filter(d => !leftAndRight.includes(d.column.id))\n      },\n      getMemoOptions(table.options, 'debugRows', 'getCenterVisibleCells')\n    )\n    row.getLeftVisibleCells = memo(\n      () => [row._getAllVisibleCells(), table.getState().columnPinning.left],\n      (allCells, left) => {\n        const cells = (left ?? [])\n          .map(columnId => allCells.find(cell => cell.column.id === columnId)!)\n          .filter(Boolean)\n          .map(d => ({ ...d, position: 'left' }) as Cell<TData, unknown>)\n\n        return cells\n      },\n      getMemoOptions(table.options, 'debugRows', 'getLeftVisibleCells')\n    )\n    row.getRightVisibleCells = memo(\n      () => [row._getAllVisibleCells(), table.getState().columnPinning.right],\n      (allCells, right) => {\n        const cells = (right ?? [])\n          .map(columnId => allCells.find(cell => cell.column.id === columnId)!)\n          .filter(Boolean)\n          .map(d => ({ ...d, position: 'right' }) as Cell<TData, unknown>)\n\n        return cells\n      },\n      getMemoOptions(table.options, 'debugRows', 'getRightVisibleCells')\n    )\n  },\n\n  _createTable: <TData extends RowData>(table: Table<TData>): void => {\n    table.setColumnPinning = updater =>\n      table.options.onColumnPinningChange?.(updater)\n\n    table.resetColumnPinning = defaultState =>\n      table.setColumnPinning(\n        defaultState\n          ? getDefaultColumnPinningState()\n          : table.initialState?.columnPinning ?? getDefaultColumnPinningState()\n      )\n\n    table.getIsSomeColumnsPinned = position => {\n      const pinningState = table.getState().columnPinning\n\n      if (!position) {\n        return Boolean(pinningState.left?.length || pinningState.right?.length)\n      }\n      return Boolean(pinningState[position]?.length)\n    }\n\n    table.getLeftLeafColumns = memo(\n      () => [table.getAllLeafColumns(), table.getState().columnPinning.left],\n      (allColumns, left) => {\n        return (left ?? [])\n          .map(columnId => allColumns.find(column => column.id === columnId)!)\n          .filter(Boolean)\n      },\n      getMemoOptions(table.options, 'debugColumns', 'getLeftLeafColumns')\n    )\n\n    table.getRightLeafColumns = memo(\n      () => [table.getAllLeafColumns(), table.getState().columnPinning.right],\n      (allColumns, right) => {\n        return (right ?? [])\n          .map(columnId => allColumns.find(column => column.id === columnId)!)\n          .filter(Boolean)\n      },\n      getMemoOptions(table.options, 'debugColumns', 'getRightLeafColumns')\n    )\n\n    table.getCenterLeafColumns = memo(\n      () => [\n        table.getAllLeafColumns(),\n        table.getState().columnPinning.left,\n        table.getState().columnPinning.right,\n      ],\n      (allColumns, left, right) => {\n        const leftAndRight: string[] = [...(left ?? []), ...(right ?? [])]\n\n        return allColumns.filter(d => !leftAndRight.includes(d.id))\n      },\n      getMemoOptions(table.options, 'debugColumns', 'getCenterLeafColumns')\n    )\n  },\n}\n"],"names":["makeStateUpdater","memo","getMemoOptions"],"mappings":";;;AAmJA,MAAM,+BAA+B,OAA2B;AAAA,EAC9D,MAAM,CAAC;AAAA,EACP,OAAO,CAAC;AACV;AAEO,MAAM,gBAA8B;AAAA,EACzC,kBAAkB,CAAC,UAAmC;AAC7C,WAAA;AAAA,MACL,eAAe,6BAA6B;AAAA,MAC5C,GAAG;AAAA,IAAA;AAAA,EAEP;AAAA,EAEA,oBAAoB,CAClB,UACgC;AACzB,WAAA;AAAA,MACL,uBAAuBA,MAAAA,iBAAiB,iBAAiB,KAAK;AAAA,IAAA;AAAA,EAElE;AAAA,EAEA,eAAe,CACb,QACA,UACS;AACT,WAAO,MAAM,CAAY,aAAA;AACjB,YAAA,YAAY,OACf,eAAA,EACA,IAAI,OAAK,EAAE,EAAE,EACb,OAAO,OAAO;AAEjB,YAAM,iBAAiB,CAAO,QAAA;AAC5B,YAAI,aAAa,SAAS;AACjB,iBAAA;AAAA,YACL,QAAO,2BAAK,SAAQ,IAAI,OAAO,CAAA,MAAK,EAAC,uCAAW,SAAS,GAAE;AAAA,YAC3D,OAAO;AAAA,cACL,KAAI,2BAAK,UAAS,CAAA,GAAI,OAAO,CAAA,MAAK,EAAC,uCAAW,SAAS,GAAE;AAAA,cACzD,GAAG;AAAA,YACL;AAAA,UAAA;AAAA,QAEJ;AAEA,YAAI,aAAa,QAAQ;AAChB,iBAAA;AAAA,YACL,MAAM;AAAA,cACJ,KAAI,2BAAK,SAAQ,CAAA,GAAI,OAAO,CAAA,MAAK,EAAC,uCAAW,SAAS,GAAE;AAAA,cACxD,GAAG;AAAA,YACL;AAAA,YACA,SAAQ,2BAAK,UAAS,IAAI,OAAO,CAAA,MAAK,EAAC,uCAAW,SAAS,GAAE;AAAA,UAAA;AAAA,QAEjE;AAEO,eAAA;AAAA,UACL,QAAO,2BAAK,SAAQ,IAAI,OAAO,CAAA,MAAK,EAAC,uCAAW,SAAS,GAAE;AAAA,UAC3D,SAAQ,2BAAK,UAAS,IAAI,OAAO,CAAA,MAAK,EAAC,uCAAW,SAAS,GAAE;AAAA,QAAA;AAAA,MAC/D,CACD;AAAA,IAAA;AAGH,WAAO,YAAY,MAAM;AACjB,YAAA,cAAc,OAAO;AAE3B,aAAO,YAAY;AAAA,QACjB,CAAA,OACG,EAAE,UAAU,iBAAiB,UAC7B,MAAM,QAAQ,uBACb,MAAM,QAAQ,iBACd;AAAA,MAAA;AAAA,IACN;AAGF,WAAO,cAAc,MAAM;AACzB,YAAM,gBAAgB,OAAO,iBAAiB,IAAI,CAAA,MAAK,EAAE,EAAE;AAE3D,YAAM,EAAE,MAAM,MAAA,IAAU,MAAM,SAAW,EAAA;AAEzC,YAAM,SAAS,cAAc,KAAK,OAAK,6BAAM,SAAS,EAAE;AACxD,YAAM,UAAU,cAAc,KAAK,OAAK,+BAAO,SAAS,EAAE;AAEnD,aAAA,SAAS,SAAS,UAAU,UAAU;AAAA,IAAA;AAG/C,WAAO,iBAAiB,MAAM;;AACtB,YAAA,WAAW,OAAO;AAEjB,aAAA,aACH,iBAAM,SAAW,EAAA,kBAAjB,mBAAiC,cAAjC,mBAA4C,QAAQ,OAAO,QAAO,KAClE;AAAA,IAAA;AAAA,EAER;AAAA,EAEA,YAAY,CACV,KACA,UACS;AACT,QAAI,wBAAwBC,MAAA;AAAA,MAC1B,MAAM;AAAA,QACJ,IAAI,oBAAoB;AAAA,QACxB,MAAM,WAAW,cAAc;AAAA,QAC/B,MAAM,WAAW,cAAc;AAAA,MACjC;AAAA,MACA,CAAC,UAAU,MAAM,UAAU;AACnB,cAAA,eAAyB,CAAC,GAAI,QAAQ,CAAK,GAAA,GAAI,SAAS,CAAA,CAAG;AAE1D,eAAA,SAAS,OAAO,CAAK,MAAA,CAAC,aAAa,SAAS,EAAE,OAAO,EAAE,CAAC;AAAA,MACjE;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,aAAa,uBAAuB;AAAA,IAAA;AAEpE,QAAI,sBAAsBD,MAAA;AAAA,MACxB,MAAM,CAAC,IAAI,uBAAuB,MAAM,SAAW,EAAA,cAAc,IAAI;AAAA,MACrE,CAAC,UAAU,SAAS;AACZ,cAAA,SAAS,QAAQ,CAAA,GACpB,IAAI,cAAY,SAAS,KAAK,CAAQ,SAAA,KAAK,OAAO,OAAO,QAAQ,CAAE,EACnE,OAAO,OAAO,EACd,IAAI,CAAM,OAAA,EAAE,GAAG,GAAG,UAAU,OAAA,EAAiC;AAEzD,eAAA;AAAA,MACT;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,aAAa,qBAAqB;AAAA,IAAA;AAElE,QAAI,uBAAuBD,MAAA;AAAA,MACzB,MAAM,CAAC,IAAI,uBAAuB,MAAM,SAAW,EAAA,cAAc,KAAK;AAAA,MACtE,CAAC,UAAU,UAAU;AACb,cAAA,SAAS,SAAS,CAAA,GACrB,IAAI,cAAY,SAAS,KAAK,CAAQ,SAAA,KAAK,OAAO,OAAO,QAAQ,CAAE,EACnE,OAAO,OAAO,EACd,IAAI,CAAM,OAAA,EAAE,GAAG,GAAG,UAAU,QAAA,EAAkC;AAE1D,eAAA;AAAA,MACT;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,aAAa,sBAAsB;AAAA,IAAA;AAAA,EAErE;AAAA,EAEA,cAAc,CAAwB,UAA8B;AAClE,UAAM,mBAAmB,CAAA,YAAA;;AACvB,+BAAM,SAAQ,0BAAd,4BAAsC;AAAA;AAElC,UAAA,qBAAqB;;AACzB,mBAAM;AAAA,QACJ,eACI,6BAA6B,MAC7B,WAAM,iBAAN,mBAAoB,kBAAiB,6BAA6B;AAAA,MAAA;AAAA;AAG1E,UAAM,yBAAyB,CAAY,aAAA;;AACnC,YAAA,eAAe,MAAM,SAAA,EAAW;AAEtC,UAAI,CAAC,UAAU;AACb,eAAO,UAAQ,kBAAa,SAAb,mBAAmB,aAAU,kBAAa,UAAb,mBAAoB,OAAM;AAAA,MACxE;AACA,aAAO,SAAQ,kBAAa,QAAQ,MAArB,mBAAwB,MAAM;AAAA,IAAA;AAG/C,UAAM,qBAAqBD,MAAA;AAAA,MACzB,MAAM,CAAC,MAAM,qBAAqB,MAAM,SAAW,EAAA,cAAc,IAAI;AAAA,MACrE,CAAC,YAAY,SAAS;AACpB,gBAAQ,QAAQ,CACb,GAAA,IAAI,cAAY,WAAW,KAAK,CAAU,WAAA,OAAO,OAAO,QAAQ,CAAE,EAClE,OAAO,OAAO;AAAA,MACnB;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,gBAAgB,oBAAoB;AAAA,IAAA;AAGpE,UAAM,sBAAsBD,MAAA;AAAA,MAC1B,MAAM,CAAC,MAAM,qBAAqB,MAAM,SAAW,EAAA,cAAc,KAAK;AAAA,MACtE,CAAC,YAAY,UAAU;AACrB,gBAAQ,SAAS,CACd,GAAA,IAAI,cAAY,WAAW,KAAK,CAAU,WAAA,OAAO,OAAO,QAAQ,CAAE,EAClE,OAAO,OAAO;AAAA,MACnB;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,gBAAgB,qBAAqB;AAAA,IAAA;AAGrE,UAAM,uBAAuBD,MAAA;AAAA,MAC3B,MAAM;AAAA,QACJ,MAAM,kBAAkB;AAAA,QACxB,MAAM,WAAW,cAAc;AAAA,QAC/B,MAAM,WAAW,cAAc;AAAA,MACjC;AAAA,MACA,CAAC,YAAY,MAAM,UAAU;AACrB,cAAA,eAAyB,CAAC,GAAI,QAAQ,CAAK,GAAA,GAAI,SAAS,CAAA,CAAG;AAE1D,eAAA,WAAW,OAAO,CAAK,MAAA,CAAC,aAAa,SAAS,EAAE,EAAE,CAAC;AAAA,MAC5D;AAAA,MACAC,MAAAA,eAAe,MAAM,SAAS,gBAAgB,sBAAsB;AAAA,IAAA;AAAA,EAExE;AACF;;"}

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

@@ -0,0 +1,127 @@
+import { OnChangeFn, Updater, Column, Cell, RowData, TableFeature } from '../types';
+
+export type ColumnPinningPosition = false | 'left' | 'right';
+export interface ColumnPinningState {
+    left?: string[];
+    right?: string[];
+}
+export interface ColumnPinningTableState {
+    columnPinning: ColumnPinningState;
+}
+export interface ColumnPinningOptions {
+    /**
+     * Enables/disables column pinning for the table. Defaults to `true`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablecolumnpinning)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    enableColumnPinning?: boolean;
+    /**
+     * @deprecated Use `enableColumnPinning` or `enableRowPinning` instead.
+     * Enables/disables all pinning for the table. Defaults to `true`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    enablePinning?: boolean;
+    /**
+     * If provided, this function will be called with an `updaterFn` when `state.columnPinning` changes. This overrides the default internal state management, so you will also need to supply `state.columnPinning` from your own managed state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#oncolumnpinningchange)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/oncolumnpinningchange)
+     */
+    onColumnPinningChange?: OnChangeFn<ColumnPinningState>;
+}
+export interface ColumnPinningDefaultOptions {
+    onColumnPinningChange: OnChangeFn<ColumnPinningState>;
+}
+export interface ColumnPinningColumnDef {
+    /**
+     * Enables/disables column pinning for this column. Defaults to `true`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#enablepinning-1)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    enablePinning?: boolean;
+}
+export interface ColumnPinningColumn {
+    /**
+     * Returns whether or not the column can be pinned.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcanpin)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getCanPin: () => boolean;
+    /**
+     * Returns the pinned position of the column. (`'left'`, `'right'` or `false`)
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getispinned)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getIsPinned: () => ColumnPinningPosition;
+    /**
+     * Returns the numeric pinned index of the column within a pinned column group.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getpinnedindex)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getPinnedIndex: () => number;
+    /**
+     * Pins a column to the `'left'` or `'right'`, or unpins the column to the center if `false` is passed.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#pin)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    pin: (position: ColumnPinningPosition) => void;
+}
+export interface ColumnPinningRow<TData extends RowData> {
+    /**
+     * Returns all center pinned (unpinned) leaf cells in the row.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcentervisiblecells)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getCenterVisibleCells: () => Cell<TData, unknown>[];
+    /**
+     * Returns all left pinned leaf cells in the row.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftvisiblecells)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getLeftVisibleCells: () => Cell<TData, unknown>[];
+    /**
+     * Returns all right pinned leaf cells in the row.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightvisiblecells)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getRightVisibleCells: () => Cell<TData, unknown>[];
+}
+export interface ColumnPinningInstance<TData extends RowData> {
+    /**
+     * Returns all center pinned (unpinned) leaf columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getcenterleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getCenterLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns whether or not any columns are pinned. Optionally specify to only check for pinned columns in either the `left` or `right` position.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getissomecolumnspinned)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean;
+    /**
+     * Returns all left pinned leaf columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getleftleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getLeftLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Returns all right pinned leaf columns.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#getrightleafcolumns)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    getRightLeafColumns: () => Column<TData, unknown>[];
+    /**
+     * Resets the **columnPinning** state to `initialState.columnPinning`, or `true` can be passed to force a default blank state reset to `{ left: [], right: [], }`.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#resetcolumnpinning)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    resetColumnPinning: (defaultState?: boolean) => void;
+    /**
+     * Sets or updates the `state.columnPinning` state.
+     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-pinning#setcolumnpinning)
+     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-pinning)
+     */
+    setColumnPinning: (updater: Updater<ColumnPinningState>) => void;
+}
+export declare const ColumnPinning: TableFeature;