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

package/dist/features/column-resizing/columnResizingFeature.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"columnResizingFeature.cjs","names":["getDefaultColumnResizingState","makeStateUpdater","column_getCanResize","column_getIsResizing","header_getResizeHandler","table_setColumnResizing","table_resetHeaderSizeInfo"],"sources":["../../../src/features/column-resizing/columnResizingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanResize,\n  column_getIsResizing,\n  getDefaultColumnResizingState,\n  header_getResizeHandler,\n  table_resetHeaderSizeInfo,\n  table_setColumnResizing,\n} from './columnResizingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnResizing,\n//   Header_ColumnResizing,\n//   TableOptions_ColumnResizing,\n//   TableState_ColumnResizing,\n//   Table_ColumnResizing,\n// } from './columnResizingFeature.types'\n\nexport interface ColumnResizingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnResizing\n  // Header: Header_ColumnResizing\n  // Table: Table_ColumnResizing\n  // TableOptions: TableOptions_ColumnResizing\n  // TableState: TableState_ColumnResizing\n}\n\nexport function constructColumnResizingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnResizing: getDefaultColumnResizingState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        columnResizeMode: 'onEnd',\n        columnResizeDirection: 'ltr',\n        onColumnResizingChange: makeStateUpdater('columnResizing', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        column_getCanResize: {\n          fn: (column) => column_getCanResize(column),\n        },\n        column_getIsResizing: {\n          fn: (column) => column_getIsResizing(column),\n        },\n      })\n    },\n\n    assignHeaderPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        header_getResizeHandler: {\n          fn: (header, _contextDocument) =>\n            header_getResizeHandler(header, _contextDocument),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnResizingFeature', table, {\n        table_setColumnResizing: {\n          fn: (updater) => table_setColumnResizing(table, updater),\n        },\n        table_resetHeaderSizeInfo: {\n          fn: (defaultState) => table_resetHeaderSizeInfo(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Column Resizing feature adds column resizing state and APIs to the table and column objects.\n * **Note:** This is dependent on the Column Sizing feature.\n */\nexport const columnResizingFeature = constructColumnResizingFeature()\n"],"mappings":";;;;AAkCA,SAAgB,iCAGuD;AACrE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,gBAAgBA,mEAA+B;IAC/C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO;IACL,kBAAkB;IAClB,uBAAuB;IACvB,wBAAwBC,+BAAiB,kBAAkB,MAAM;IAClE;;EAGH,wBAAwB,WAAW,UAAU;AAC3C,qCAAoB,yBAAyB,WAAW,OAAO;IAC7D,qBAAqB,EACnB,KAAK,WAAWC,wDAAoB,OAAO,EAC5C;IACD,sBAAsB,EACpB,KAAK,WAAWC,yDAAqB,OAAO,EAC7C;IACF,CAAC;;EAGJ,wBAAwB,WAAW,UAAU;AAC3C,qCAAoB,yBAAyB,WAAW,OAAO,EAC7D,yBAAyB,EACvB,KAAK,QAAQ,qBACXC,4DAAwB,QAAQ,iBAAiB,EACpD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,iCAAgB,yBAAyB,OAAO;IAC9C,yBAAyB,EACvB,KAAK,YAAYC,4DAAwB,OAAO,QAAQ,EACzD;IACD,2BAA2B,EACzB,KAAK,iBAAiBC,8DAA0B,OAAO,aAAa,EACrE;IACF,CAAC;;EAEL;;;;;;AAOH,MAAa,wBAAwB,gCAAgC"}
+{"version":3,"file":"columnResizingFeature.cjs","names":["getDefaultColumnResizingState","makeStateUpdater","column_getCanResize","column_getIsResizing","header_getResizeHandler","table_setColumnResizing","table_resetHeaderSizeInfo"],"sources":["../../../src/features/column-resizing/columnResizingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanResize,\n  column_getIsResizing,\n  getDefaultColumnResizingState,\n  header_getResizeHandler,\n  table_resetHeaderSizeInfo,\n  table_setColumnResizing,\n} from './columnResizingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnResizing,\n//   Header_ColumnResizing,\n//   TableOptions_ColumnResizing,\n//   TableState_ColumnResizing,\n//   Table_ColumnResizing,\n// } from './columnResizingFeature.types'\n\nexport interface ColumnResizingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnResizing\n  // Header: Header_ColumnResizing\n  // Table: Table_ColumnResizing\n  // TableOptions: TableOptions_ColumnResizing\n  // TableState: TableState_ColumnResizing\n}\n\n/**\n * Creates the stock column resizing feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructColumnResizingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnResizing: getDefaultColumnResizingState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        columnResizeMode: 'onEnd',\n        columnResizeDirection: 'ltr',\n        onColumnResizingChange: makeStateUpdater('columnResizing', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        column_getCanResize: {\n          fn: (column) => column_getCanResize(column),\n        },\n        column_getIsResizing: {\n          fn: (column) => column_getIsResizing(column),\n        },\n      })\n    },\n\n    assignHeaderPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        header_getResizeHandler: {\n          fn: (header, _contextDocument) =>\n            header_getResizeHandler(header, _contextDocument),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnResizingFeature', table, {\n        table_setColumnResizing: {\n          fn: (updater) => table_setColumnResizing(table, updater),\n        },\n        table_resetHeaderSizeInfo: {\n          fn: (defaultState) => table_resetHeaderSizeInfo(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock column resizing feature.\n *\n * Register this feature with `columnSizingFeature` to add resize interaction\n * state and APIs for drag-based column resizing.\n */\nexport const columnResizingFeature = constructColumnResizingFeature()\n"],"mappings":";;;;;;;;;AAuCA,SAAgB,iCAGuD;CACrE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,gBAAgBA,mEAA+B;IAC/C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO;IACL,kBAAkB;IAClB,uBAAuB;IACvB,wBAAwBC,+BAAiB,kBAAkB,MAAM;IAClE;;EAGH,wBAAwB,WAAW,UAAU;GAC3C,kCAAoB,yBAAyB,WAAW,OAAO;IAC7D,qBAAqB,EACnB,KAAK,WAAWC,wDAAoB,OAAO,EAC5C;IACD,sBAAsB,EACpB,KAAK,WAAWC,yDAAqB,OAAO,EAC7C;IACF,CAAC;;EAGJ,wBAAwB,WAAW,UAAU;GAC3C,kCAAoB,yBAAyB,WAAW,OAAO,EAC7D,yBAAyB,EACvB,KAAK,QAAQ,qBACXC,4DAAwB,QAAQ,iBAAiB,EACpD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,8BAAgB,yBAAyB,OAAO;IAC9C,yBAAyB,EACvB,KAAK,YAAYC,4DAAwB,OAAO,QAAQ,EACzD;IACD,2BAA2B,EACzB,KAAK,iBAAiBC,8DAA0B,OAAO,aAAa,EACrE;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,wBAAwB,gCAAgC"}

package/dist/features/column-resizing/columnResizingFeature.d.cts

@@ -3,10 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
 
 //#region src/features/column-resizing/columnResizingFeature.d.ts
 interface ColumnResizingFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock column resizing feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructColumnResizingFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>>;
 /**
- * The Column Resizing feature adds column resizing state and APIs to the table and column objects.
- * **Note:** This is dependent on the Column Sizing feature.
+ * The stock column resizing feature.
+ *
+ * Register this feature with `columnSizingFeature` to add resize interaction
+ * state and APIs for drag-based column resizing.
  */
 declare const columnResizingFeature: TableFeature<ColumnResizingFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/column-resizing/columnResizingFeature.d.ts

@@ -3,10 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
 
 //#region src/features/column-resizing/columnResizingFeature.d.ts
 interface ColumnResizingFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock column resizing feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructColumnResizingFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>>;
 /**
- * The Column Resizing feature adds column resizing state and APIs to the table and column objects.
- * **Note:** This is dependent on the Column Sizing feature.
+ * The stock column resizing feature.
+ *
+ * Register this feature with `columnSizingFeature` to add resize interaction
+ * state and APIs for drag-based column resizing.
  */
 declare const columnResizingFeature: TableFeature<ColumnResizingFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/column-resizing/columnResizingFeature.js

@@ -2,6 +2,11 @@ import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../ut
 import { column_getCanResize, column_getIsResizing, getDefaultColumnResizingState, header_getResizeHandler, table_resetHeaderSizeInfo, table_setColumnResizing } from "./columnResizingFeature.utils.js";
 
 //#region src/features/column-resizing/columnResizingFeature.ts
+/**
+* Creates the stock column resizing feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructColumnResizingFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -35,8 +40,10 @@ function constructColumnResizingFeature() {
 	};
 }
 /**
-* The Column Resizing feature adds column resizing state and APIs to the table and column objects.
-* **Note:** This is dependent on the Column Sizing feature.
+* The stock column resizing feature.
+*
+* Register this feature with `columnSizingFeature` to add resize interaction
+* state and APIs for drag-based column resizing.
 */
 const columnResizingFeature = constructColumnResizingFeature();
 

package/dist/features/column-resizing/columnResizingFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"columnResizingFeature.js","names":[],"sources":["../../../src/features/column-resizing/columnResizingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanResize,\n  column_getIsResizing,\n  getDefaultColumnResizingState,\n  header_getResizeHandler,\n  table_resetHeaderSizeInfo,\n  table_setColumnResizing,\n} from './columnResizingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnResizing,\n//   Header_ColumnResizing,\n//   TableOptions_ColumnResizing,\n//   TableState_ColumnResizing,\n//   Table_ColumnResizing,\n// } from './columnResizingFeature.types'\n\nexport interface ColumnResizingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnResizing\n  // Header: Header_ColumnResizing\n  // Table: Table_ColumnResizing\n  // TableOptions: TableOptions_ColumnResizing\n  // TableState: TableState_ColumnResizing\n}\n\nexport function constructColumnResizingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnResizing: getDefaultColumnResizingState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        columnResizeMode: 'onEnd',\n        columnResizeDirection: 'ltr',\n        onColumnResizingChange: makeStateUpdater('columnResizing', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        column_getCanResize: {\n          fn: (column) => column_getCanResize(column),\n        },\n        column_getIsResizing: {\n          fn: (column) => column_getIsResizing(column),\n        },\n      })\n    },\n\n    assignHeaderPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        header_getResizeHandler: {\n          fn: (header, _contextDocument) =>\n            header_getResizeHandler(header, _contextDocument),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnResizingFeature', table, {\n        table_setColumnResizing: {\n          fn: (updater) => table_setColumnResizing(table, updater),\n        },\n        table_resetHeaderSizeInfo: {\n          fn: (defaultState) => table_resetHeaderSizeInfo(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Column Resizing feature adds column resizing state and APIs to the table and column objects.\n * **Note:** This is dependent on the Column Sizing feature.\n */\nexport const columnResizingFeature = constructColumnResizingFeature()\n"],"mappings":";;;;AAkCA,SAAgB,iCAGuD;AACrE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,gBAAgB,+BAA+B;IAC/C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO;IACL,kBAAkB;IAClB,uBAAuB;IACvB,wBAAwB,iBAAiB,kBAAkB,MAAM;IAClE;;EAGH,wBAAwB,WAAW,UAAU;AAC3C,uBAAoB,yBAAyB,WAAW,OAAO;IAC7D,qBAAqB,EACnB,KAAK,WAAW,oBAAoB,OAAO,EAC5C;IACD,sBAAsB,EACpB,KAAK,WAAW,qBAAqB,OAAO,EAC7C;IACF,CAAC;;EAGJ,wBAAwB,WAAW,UAAU;AAC3C,uBAAoB,yBAAyB,WAAW,OAAO,EAC7D,yBAAyB,EACvB,KAAK,QAAQ,qBACX,wBAAwB,QAAQ,iBAAiB,EACpD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,mBAAgB,yBAAyB,OAAO;IAC9C,yBAAyB,EACvB,KAAK,YAAY,wBAAwB,OAAO,QAAQ,EACzD;IACD,2BAA2B,EACzB,KAAK,iBAAiB,0BAA0B,OAAO,aAAa,EACrE;IACF,CAAC;;EAEL;;;;;;AAOH,MAAa,wBAAwB,gCAAgC"}
+{"version":3,"file":"columnResizingFeature.js","names":[],"sources":["../../../src/features/column-resizing/columnResizingFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  column_getCanResize,\n  column_getIsResizing,\n  getDefaultColumnResizingState,\n  header_getResizeHandler,\n  table_resetHeaderSizeInfo,\n  table_setColumnResizing,\n} from './columnResizingFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Column_ColumnResizing,\n//   Header_ColumnResizing,\n//   TableOptions_ColumnResizing,\n//   TableState_ColumnResizing,\n//   Table_ColumnResizing,\n// } from './columnResizingFeature.types'\n\nexport interface ColumnResizingFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Column: Column_ColumnResizing\n  // Header: Header_ColumnResizing\n  // Table: Table_ColumnResizing\n  // TableOptions: TableOptions_ColumnResizing\n  // TableState: TableState_ColumnResizing\n}\n\n/**\n * Creates the stock column resizing feature.\n *\n * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.\n */\nexport function constructColumnResizingFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        columnResizing: getDefaultColumnResizingState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        columnResizeMode: 'onEnd',\n        columnResizeDirection: 'ltr',\n        onColumnResizingChange: makeStateUpdater('columnResizing', table),\n      }\n    },\n\n    assignColumnPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        column_getCanResize: {\n          fn: (column) => column_getCanResize(column),\n        },\n        column_getIsResizing: {\n          fn: (column) => column_getIsResizing(column),\n        },\n      })\n    },\n\n    assignHeaderPrototype: (prototype, table) => {\n      assignPrototypeAPIs('columnResizingFeature', prototype, table, {\n        header_getResizeHandler: {\n          fn: (header, _contextDocument) =>\n            header_getResizeHandler(header, _contextDocument),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('columnResizingFeature', table, {\n        table_setColumnResizing: {\n          fn: (updater) => table_setColumnResizing(table, updater),\n        },\n        table_resetHeaderSizeInfo: {\n          fn: (defaultState) => table_resetHeaderSizeInfo(table, defaultState),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock column resizing feature.\n *\n * Register this feature with `columnSizingFeature` to add resize interaction\n * state and APIs for drag-based column resizing.\n */\nexport const columnResizingFeature = constructColumnResizingFeature()\n"],"mappings":";;;;;;;;;AAuCA,SAAgB,iCAGuD;CACrE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,gBAAgB,+BAA+B;IAC/C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO;IACL,kBAAkB;IAClB,uBAAuB;IACvB,wBAAwB,iBAAiB,kBAAkB,MAAM;IAClE;;EAGH,wBAAwB,WAAW,UAAU;GAC3C,oBAAoB,yBAAyB,WAAW,OAAO;IAC7D,qBAAqB,EACnB,KAAK,WAAW,oBAAoB,OAAO,EAC5C;IACD,sBAAsB,EACpB,KAAK,WAAW,qBAAqB,OAAO,EAC7C;IACF,CAAC;;EAGJ,wBAAwB,WAAW,UAAU;GAC3C,oBAAoB,yBAAyB,WAAW,OAAO,EAC7D,yBAAyB,EACvB,KAAK,QAAQ,qBACX,wBAAwB,QAAQ,iBAAiB,EACpD,EACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,gBAAgB,yBAAyB,OAAO;IAC9C,yBAAyB,EACvB,KAAK,YAAY,wBAAwB,OAAO,QAAQ,EACzD;IACD,2BAA2B,EACzB,KAAK,iBAAiB,0BAA0B,OAAO,aAAa,EACrE;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,wBAAwB,gCAAgC"}

package/dist/features/column-resizing/columnResizingFeature.types.d.cts

@@ -16,30 +16,38 @@ type ColumnResizeMode = 'onChange' | 'onEnd';
 type ColumnResizeDirection = 'ltr' | 'rtl';
 interface TableOptions_ColumnResizing {
   /**
-   * 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.
+   * Determines when committed `columnSizing` values are updated. `onChange`
+   * commits sizes while the resize handle is dragged; `onEnd` commits when the
+   * resize interaction finishes.
    */
   columnResizeMode?: ColumnResizeMode;
   /**
-   * Enables or disables column resizing for the column.
+   * Enables or disables column resizing for the whole table.
    */
   enableColumnResizing?: boolean;
   /**
-   * Enables or disables right-to-left support for resizing the column. defaults to 'ltr'.
+   * Sets the resize direction used to calculate drag offsets. Defaults to `ltr`.
    */
   columnResizeDirection?: ColumnResizeDirection;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.columnResizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnResizing` from your own managed state.
+   * Called with an updater when the transient `columnResizing` state changes.
+   * Pair this with `state.columnResizing` when using external state; external
+   * atoms can own the slice without this callback.
    */
   onColumnResizingChange?: OnChangeFn<columnResizingState>;
 }
 type ColumnResizingDefaultOptions = Pick<TableOptions_ColumnResizing, 'columnResizeMode' | 'onColumnResizingChange' | 'columnResizeDirection'>;
 interface Table_ColumnResizing {
   /**
-   * 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.
+   * Resets transient resize interaction state to `initialState.columnResizing`.
+   * Pass `true` to reset to the feature's default blank resize state instead.
    */
   resetHeaderSizeInfo: (defaultState?: boolean) => void;
   /**
-   * Sets the column sizing info state using an updater function or a value. This will trigger the underlying `oncolumnResizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+   * Sets the transient resize interaction state using a value or updater.
+   *
+   * The lowercase `c` in this API name matches the current generated v9 table
+   * API for the `columnResizing` state slice.
    */
   setcolumnResizing: (updater: Updater<columnResizingState>) => void;
 }

package/dist/features/column-resizing/columnResizingFeature.types.d.ts

@@ -16,30 +16,38 @@ type ColumnResizeMode = 'onChange' | 'onEnd';
 type ColumnResizeDirection = 'ltr' | 'rtl';
 interface TableOptions_ColumnResizing {
   /**
-   * 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.
+   * Determines when committed `columnSizing` values are updated. `onChange`
+   * commits sizes while the resize handle is dragged; `onEnd` commits when the
+   * resize interaction finishes.
    */
   columnResizeMode?: ColumnResizeMode;
   /**
-   * Enables or disables column resizing for the column.
+   * Enables or disables column resizing for the whole table.
    */
   enableColumnResizing?: boolean;
   /**
-   * Enables or disables right-to-left support for resizing the column. defaults to 'ltr'.
+   * Sets the resize direction used to calculate drag offsets. Defaults to `ltr`.
    */
   columnResizeDirection?: ColumnResizeDirection;
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.columnResizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnResizing` from your own managed state.
+   * Called with an updater when the transient `columnResizing` state changes.
+   * Pair this with `state.columnResizing` when using external state; external
+   * atoms can own the slice without this callback.
    */
   onColumnResizingChange?: OnChangeFn<columnResizingState>;
 }
 type ColumnResizingDefaultOptions = Pick<TableOptions_ColumnResizing, 'columnResizeMode' | 'onColumnResizingChange' | 'columnResizeDirection'>;
 interface Table_ColumnResizing {
   /**
-   * 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.
+   * Resets transient resize interaction state to `initialState.columnResizing`.
+   * Pass `true` to reset to the feature's default blank resize state instead.
    */
   resetHeaderSizeInfo: (defaultState?: boolean) => void;
   /**
-   * Sets the column sizing info state using an updater function or a value. This will trigger the underlying `oncolumnResizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+   * Sets the transient resize interaction state using a value or updater.
+   *
+   * The lowercase `c` in this API name matches the current generated v9 table
+   * API for the `columnResizing` state slice.
    */
   setcolumnResizing: (updater: Updater<columnResizingState>) => void;
 }

package/dist/features/column-resizing/columnResizingFeature.utils.cjs

@@ -3,6 +3,16 @@ const require_coreColumnsFeature_utils = require('../../core/columns/coreColumns
 const require_columnSizingFeature_utils = require('../column-sizing/columnSizingFeature.utils.cjs');
 
 //#region src/features/column-resizing/columnResizingFeature.utils.ts
+/**
+* Returns the default column resizing state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultColumnResizingState()
+* ```
+*/
 function getDefaultColumnResizingState() {
 	return {
 		startOffset: null,
@@ -13,13 +23,43 @@ function getDefaultColumnResizingState() {
 		columnSizingStart: []
 	};
 }
+/**
+* Returns whether a column can use resize.
+*
+* This combines column options, table options, and any required accessor or feature state for the capability.
+*
+* @example
+* ```ts
+* const value = column_getCanResize(column)
+* ```
+*/
 function column_getCanResize(column) {
 	return (column.columnDef.enableResizing ?? true) && (column.table.options.enableColumnResizing ?? true);
 }
+/**
+* Returns is resizing for a column.
+*
+* This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+*
+* @example
+* ```ts
+* const value = column_getIsResizing(column)
+* ```
+*/
 function column_getIsResizing(column) {
 	var _column$table$atoms$c;
 	return ((_column$table$atoms$c = column.table.atoms.columnResizing) === null || _column$table$atoms$c === void 0 || (_column$table$atoms$c = _column$table$atoms$c.get()) === null || _column$table$atoms$c === void 0 ? void 0 : _column$table$atoms$c.isResizingColumn) === column.id;
 }
+/**
+* Returns resize handler for a header.
+*
+* This is the static implementation behind the matching header instance API and can account for nested header groups.
+*
+* @example
+* ```ts
+* const onMouseDown = header_getResizeHandler(header)
+* ```
+*/
 function header_getResizeHandler(header, _contextDocument) {
 	const column = require_coreColumnsFeature_utils.table_getColumn(header.column.table, header.column.id);
 	const canResize = column_getCanResize(column);
@@ -116,13 +156,44 @@ function header_getResizeHandler(header, _contextDocument) {
 		}));
 	};
 }
+/**
+* Updates the table's column resizing state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setColumnResizing(table, (old) => old)
+* ```
+*/
 function table_setColumnResizing(table, updater) {
 	var _table$options$onColu, _table$options;
 	(_table$options$onColu = (_table$options = table.options).onColumnResizingChange) === null || _table$options$onColu === void 0 || _table$options$onColu.call(_table$options, updater);
 }
+/**
+* Resets the table's header size info state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetHeaderSizeInfo(table)
+* table_resetHeaderSizeInfo(table, true)
+* ```
+*/
 function table_resetHeaderSizeInfo(table, defaultState) {
 	table_setColumnResizing(table, defaultState ? getDefaultColumnResizingState() : require_utils.cloneState(table.initialState.columnResizing ?? getDefaultColumnResizingState()));
 }
+/**
+* Detects whether the current environment supports passive event listeners.
+*
+* Column resizing uses this to register pointer and touch listeners with the safest available options.
+*
+* @example
+* ```ts
+* const canUsePassiveListeners = passiveEventSupported()
+* ```
+*/
 function passiveEventSupported() {
 	let passiveSupported = null;
 	if (typeof passiveSupported === "boolean") return passiveSupported;
@@ -141,6 +212,16 @@ function passiveEventSupported() {
 	passiveSupported = supported;
 	return passiveSupported;
 }
+/**
+* Returns whether an event is a touch-start event.
+*
+* Column resizing uses this to normalize mouse and touch resize interactions.
+*
+* @example
+* ```ts
+* const isTouch = isTouchStartEvent(event)
+* ```
+*/
 function isTouchStartEvent(e) {
 	return e.type === "touchstart";
 }

package/dist/features/column-resizing/columnResizingFeature.utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"columnResizingFeature.utils.cjs","names":["table_getColumn","header_getSize","column_getSize","cloneState"],"sources":["../../../src/features/column-resizing/columnResizingFeature.utils.ts"],"sourcesContent":["import {\n  column_getSize,\n  header_getSize,\n  table_setColumnSizing,\n} from '../column-sizing/columnSizingFeature.utils'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport { cloneState } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Header } from '../../types/Header'\nimport type { Column_Internal } from '../../types/Column'\nimport type { ColumnSizingState } from '../column-sizing/columnSizingFeature.types'\nimport type { columnResizingState } from './columnResizingFeature.types'\n\nexport function getDefaultColumnResizingState(): columnResizingState {\n  return {\n    startOffset: null,\n    startSize: null,\n    deltaOffset: null,\n    deltaPercentage: null,\n    isResizingColumn: false,\n    columnSizingStart: [],\n  }\n}\n\nexport function column_getCanResize<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableResizing ?? true) &&\n    (column.table.options.enableColumnResizing ?? true)\n  )\n}\n\nexport function column_getIsResizing<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    column.table.atoms.columnResizing?.get()?.isResizingColumn === column.id\n  )\n}\n\nexport function header_getResizeHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(header: Header<TFeatures, TData, TValue>, _contextDocument?: Document) {\n  const column = table_getColumn(header.column.table, header.column.id)!\n  const canResize = column_getCanResize(column)\n\n  return (event: unknown) => {\n    if (!canResize) {\n      return\n    }\n\n    ;(event as any).persist?.()\n\n    if (isTouchStartEvent(event)) {\n      // lets not respond to multiple touches (e.g. 2 or 3 fingers)\n      if (event.touches.length > 1) {\n        return\n      }\n    }\n\n    const startSize = header_getSize(header)\n\n    const columnSizingStart: Array<[string, number]> = header\n      .getLeafHeaders()\n      .map((leafHeader) => [\n        leafHeader.column.id,\n        column_getSize(leafHeader.column),\n      ])\n\n    const clientX = isTouchStartEvent(event)\n      ? Math.round(event.touches[0]!.clientX)\n      : (event as MouseEvent).clientX\n\n    const newColumnSizing: ColumnSizingState = {}\n\n    const updateOffset = (eventType: 'move' | 'end', clientXPos?: number) => {\n      if (typeof clientXPos !== 'number') {\n        return\n      }\n\n      table_setColumnResizing(column.table, (old) => {\n        const deltaDirection =\n          column.table.options.columnResizeDirection === 'rtl' ? -1 : 1\n        const deltaOffset =\n          (clientXPos - (old.startOffset ?? 0)) * deltaDirection\n        const startSize = old.startSize ?? 0\n        const deltaPercentage = Math.max(\n          startSize > 0 ? deltaOffset / startSize : 0,\n          -0.999999,\n        )\n\n        old.columnSizingStart.forEach(([columnId, headerSize]) => {\n          newColumnSizing[columnId] =\n            Math.round(\n              Math.max(\n                headerSize > 0\n                  ? headerSize + headerSize * deltaPercentage\n                  : deltaOffset / old.columnSizingStart.length,\n                0,\n              ) * 100,\n            ) / 100\n        })\n\n        return {\n          ...old,\n          deltaOffset,\n          deltaPercentage,\n        }\n      })\n\n      if (\n        column.table.options.columnResizeMode === 'onChange' ||\n        eventType === 'end'\n      ) {\n        table_setColumnSizing(column.table, (old) => ({\n          ...old,\n          ...newColumnSizing,\n        }))\n      }\n    }\n\n    const onMove = (clientXPos?: number) => updateOffset('move', clientXPos)\n\n    const onEnd = (clientXPos?: number) => {\n      updateOffset('end', clientXPos)\n\n      table_setColumnResizing(column.table, (old) => ({\n        ...old,\n        isResizingColumn: false,\n        startOffset: null,\n        startSize: null,\n        deltaOffset: null,\n        deltaPercentage: null,\n        columnSizingStart: [],\n      }))\n    }\n\n    const contextDocument =\n      _contextDocument || typeof document !== 'undefined' ? document : null\n\n    const mouseEvents = {\n      moveHandler: (e: MouseEvent) => onMove(e.clientX),\n      upHandler: (e: MouseEvent) => {\n        contextDocument?.removeEventListener(\n          'mousemove',\n          mouseEvents.moveHandler,\n        )\n        contextDocument?.removeEventListener('mouseup', mouseEvents.upHandler)\n        onEnd(e.clientX)\n      },\n    }\n\n    const touchEvents = {\n      moveHandler: (touchEvent: TouchEvent) => {\n        if (touchEvent.cancelable) {\n          touchEvent.preventDefault()\n          touchEvent.stopPropagation()\n        }\n        onMove(touchEvent.touches[0]!.clientX)\n        return false\n      },\n      upHandler: (e: TouchEvent) => {\n        contextDocument?.removeEventListener(\n          'touchmove',\n          touchEvents.moveHandler,\n        )\n        contextDocument?.removeEventListener('touchend', touchEvents.upHandler)\n        if (e.cancelable) {\n          e.preventDefault()\n          e.stopPropagation()\n        }\n        onEnd(e.touches[0]?.clientX)\n      },\n    }\n\n    const passiveIfSupported = passiveEventSupported()\n      ? { passive: false }\n      : false\n\n    if (isTouchStartEvent(event)) {\n      contextDocument?.addEventListener(\n        'touchmove',\n        touchEvents.moveHandler,\n        passiveIfSupported,\n      )\n      contextDocument?.addEventListener(\n        'touchend',\n        touchEvents.upHandler,\n        passiveIfSupported,\n      )\n    } else {\n      contextDocument?.addEventListener(\n        'mousemove',\n        mouseEvents.moveHandler,\n        passiveIfSupported,\n      )\n      contextDocument?.addEventListener(\n        'mouseup',\n        mouseEvents.upHandler,\n        passiveIfSupported,\n      )\n    }\n\n    table_setColumnResizing(column.table, (old) => ({\n      ...old,\n      startOffset: clientX,\n      startSize,\n      deltaOffset: 0,\n      deltaPercentage: 0,\n      columnSizingStart,\n      isResizingColumn: column.id,\n    }))\n  }\n}\n\nexport function table_setColumnResizing<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<columnResizingState>,\n) {\n  table.options.onColumnResizingChange?.(updater)\n}\n\nexport function table_resetHeaderSizeInfo<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setColumnResizing(\n    table,\n    defaultState\n      ? getDefaultColumnResizingState()\n      : cloneState(\n          table.initialState.columnResizing ?? getDefaultColumnResizingState(),\n        ),\n  )\n}\n\nexport function passiveEventSupported() {\n  let passiveSupported: boolean | null = null\n\n  if (typeof passiveSupported === 'boolean') return passiveSupported\n\n  let supported = false\n  try {\n    const options = {\n      get passive() {\n        supported = true\n        return false\n      },\n    }\n\n    const noop = () => {}\n\n    window.addEventListener('test', noop, options)\n    window.removeEventListener('test', noop)\n  } catch (err) {\n    supported = false\n  }\n  passiveSupported = supported\n  return passiveSupported\n}\n\nexport function isTouchStartEvent(e: unknown): e is TouchEvent {\n  return (e as TouchEvent).type === 'touchstart'\n}\n"],"mappings":";;;;;AAeA,SAAgB,gCAAqD;AACnE,QAAO;EACL,aAAa;EACb,WAAW;EACX,aAAa;EACb,iBAAiB;EACjB,kBAAkB;EAClB,mBAAmB,EAAE;EACtB;;AAGH,SAAgB,oBAId,QAAmD;AACnD,SACG,OAAO,UAAU,kBAAkB,UACnC,OAAO,MAAM,QAAQ,wBAAwB;;AAIlD,SAAgB,qBAId,QAAmD;;AACnD,kCACE,OAAO,MAAM,MAAM,+GAAgB,KAAK,gFAAE,sBAAqB,OAAO;;AAI1E,SAAgB,wBAId,QAA0C,kBAA6B;CACvE,MAAM,SAASA,iDAAgB,OAAO,OAAO,OAAO,OAAO,OAAO,GAAG;CACrE,MAAM,YAAY,oBAAoB,OAAO;AAE7C,SAAQ,UAAmB;;AACzB,MAAI,CAAC,UACH;AAGD,cAAC,MAAc,gEAAW;AAE3B,MAAI,kBAAkB,MAAM,EAE1B;OAAI,MAAM,QAAQ,SAAS,EACzB;;EAIJ,MAAM,YAAYC,iDAAe,OAAO;EAExC,MAAM,oBAA6C,OAChD,gBAAgB,CAChB,KAAK,eAAe,CACnB,WAAW,OAAO,IAClBC,iDAAe,WAAW,OAAO,CAClC,CAAC;EAEJ,MAAM,UAAU,kBAAkB,MAAM,GACpC,KAAK,MAAM,MAAM,QAAQ,GAAI,QAAQ,GACpC,MAAqB;EAE1B,MAAM,kBAAqC,EAAE;EAE7C,MAAM,gBAAgB,WAA2B,eAAwB;AACvE,OAAI,OAAO,eAAe,SACxB;AAGF,2BAAwB,OAAO,QAAQ,QAAQ;IAC7C,MAAM,iBACJ,OAAO,MAAM,QAAQ,0BAA0B,QAAQ,KAAK;IAC9D,MAAM,eACH,cAAc,IAAI,eAAe,MAAM;IAC1C,MAAM,YAAY,IAAI,aAAa;IACnC,MAAM,kBAAkB,KAAK,IAC3B,YAAY,IAAI,cAAc,YAAY,GAC1C,SACD;AAED,QAAI,kBAAkB,SAAS,CAAC,UAAU,gBAAgB;AACxD,qBAAgB,YACd,KAAK,MACH,KAAK,IACH,aAAa,IACT,aAAa,aAAa,kBAC1B,cAAc,IAAI,kBAAkB,QACxC,EACD,GAAG,IACL,GAAG;MACN;AAEF,WAAO;KACL,GAAG;KACH;KACA;KACD;KACD;AAEF,OACE,OAAO,MAAM,QAAQ,qBAAqB,cAC1C,cAAc,MAEd,yDAAsB,OAAO,QAAQ,SAAS;IAC5C,GAAG;IACH,GAAG;IACJ,EAAE;;EAIP,MAAM,UAAU,eAAwB,aAAa,QAAQ,WAAW;EAExE,MAAM,SAAS,eAAwB;AACrC,gBAAa,OAAO,WAAW;AAE/B,2BAAwB,OAAO,QAAQ,SAAS;IAC9C,GAAG;IACH,kBAAkB;IAClB,aAAa;IACb,WAAW;IACX,aAAa;IACb,iBAAiB;IACjB,mBAAmB,EAAE;IACtB,EAAE;;EAGL,MAAM,kBACJ,oBAAoB,OAAO,aAAa,cAAc,WAAW;EAEnE,MAAM,cAAc;GAClB,cAAc,MAAkB,OAAO,EAAE,QAAQ;GACjD,YAAY,MAAkB;AAC5B,8EAAiB,oBACf,aACA,YAAY,YACb;AACD,8EAAiB,oBAAoB,WAAW,YAAY,UAAU;AACtE,UAAM,EAAE,QAAQ;;GAEnB;EAED,MAAM,cAAc;GAClB,cAAc,eAA2B;AACvC,QAAI,WAAW,YAAY;AACzB,gBAAW,gBAAgB;AAC3B,gBAAW,iBAAiB;;AAE9B,WAAO,WAAW,QAAQ,GAAI,QAAQ;AACtC,WAAO;;GAET,YAAY,MAAkB;;AAC5B,8EAAiB,oBACf,aACA,YAAY,YACb;AACD,8EAAiB,oBAAoB,YAAY,YAAY,UAAU;AACvE,QAAI,EAAE,YAAY;AAChB,OAAE,gBAAgB;AAClB,OAAE,iBAAiB;;AAErB,yBAAM,EAAE,QAAQ,8DAAI,QAAQ;;GAE/B;EAED,MAAM,qBAAqB,uBAAuB,GAC9C,EAAE,SAAS,OAAO,GAClB;AAEJ,MAAI,kBAAkB,MAAM,EAAE;AAC5B,6EAAiB,iBACf,aACA,YAAY,aACZ,mBACD;AACD,6EAAiB,iBACf,YACA,YAAY,WACZ,mBACD;SACI;AACL,6EAAiB,iBACf,aACA,YAAY,aACZ,mBACD;AACD,6EAAiB,iBACf,WACA,YAAY,WACZ,mBACD;;AAGH,0BAAwB,OAAO,QAAQ,SAAS;GAC9C,GAAG;GACH,aAAa;GACb;GACA,aAAa;GACb,iBAAiB;GACjB;GACA,kBAAkB,OAAO;GAC1B,EAAE;;;AAIP,SAAgB,wBAId,OACA,SACA;;AACA,kDAAM,SAAQ,mHAAyB,QAAQ;;AAGjD,SAAgB,0BAGd,OAAyC,cAAwB;AACjE,yBACE,OACA,eACI,+BAA+B,GAC/BC,yBACE,MAAM,aAAa,kBAAkB,+BAA+B,CACrE,CACN;;AAGH,SAAgB,wBAAwB;CACtC,IAAI,mBAAmC;AAEvC,KAAI,OAAO,qBAAqB,UAAW,QAAO;CAElD,IAAI,YAAY;AAChB,KAAI;EACF,MAAM,UAAU,EACd,IAAI,UAAU;AACZ,eAAY;AACZ,UAAO;KAEV;EAED,MAAM,aAAa;AAEnB,SAAO,iBAAiB,QAAQ,MAAM,QAAQ;AAC9C,SAAO,oBAAoB,QAAQ,KAAK;UACjC,KAAK;AACZ,cAAY;;AAEd,oBAAmB;AACnB,QAAO;;AAGT,SAAgB,kBAAkB,GAA6B;AAC7D,QAAQ,EAAiB,SAAS"}
+{"version":3,"file":"columnResizingFeature.utils.cjs","names":["table_getColumn","header_getSize","column_getSize","cloneState"],"sources":["../../../src/features/column-resizing/columnResizingFeature.utils.ts"],"sourcesContent":["import {\n  column_getSize,\n  header_getSize,\n  table_setColumnSizing,\n} from '../column-sizing/columnSizingFeature.utils'\nimport { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'\nimport { cloneState } from '../../utils'\nimport type { CellData, RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Header } from '../../types/Header'\nimport type { Column_Internal } from '../../types/Column'\nimport type { ColumnSizingState } from '../column-sizing/columnSizingFeature.types'\nimport type { columnResizingState } from './columnResizingFeature.types'\n\n/**\n * Returns the default column resizing state.\n *\n * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.\n *\n * @example\n * ```ts\n * const initialValue = getDefaultColumnResizingState()\n * ```\n */\nexport function getDefaultColumnResizingState(): columnResizingState {\n  return {\n    startOffset: null,\n    startSize: null,\n    deltaOffset: null,\n    deltaPercentage: null,\n    isResizingColumn: false,\n    columnSizingStart: [],\n  }\n}\n\n/**\n * Returns whether a column can use resize.\n *\n * This combines column options, table options, and any required accessor or feature state for the capability.\n *\n * @example\n * ```ts\n * const value = column_getCanResize(column)\n * ```\n */\nexport function column_getCanResize<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    (column.columnDef.enableResizing ?? true) &&\n    (column.table.options.enableColumnResizing ?? true)\n  )\n}\n\n/**\n * Returns is resizing for a column.\n *\n * This derives the value from the column definition, table options, and the feature state atoms registered on the table.\n *\n * @example\n * ```ts\n * const value = column_getIsResizing(column)\n * ```\n */\nexport function column_getIsResizing<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(column: Column_Internal<TFeatures, TData, TValue>) {\n  return (\n    column.table.atoms.columnResizing?.get()?.isResizingColumn === column.id\n  )\n}\n\n/**\n * Returns resize handler for a header.\n *\n * This is the static implementation behind the matching header instance API and can account for nested header groups.\n *\n * @example\n * ```ts\n * const onMouseDown = header_getResizeHandler(header)\n * ```\n */\nexport function header_getResizeHandler<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n  TValue extends CellData = CellData,\n>(header: Header<TFeatures, TData, TValue>, _contextDocument?: Document) {\n  const column = table_getColumn(header.column.table, header.column.id)!\n  const canResize = column_getCanResize(column)\n\n  return (event: unknown) => {\n    if (!canResize) {\n      return\n    }\n\n    ;(event as any).persist?.()\n\n    if (isTouchStartEvent(event)) {\n      // lets not respond to multiple touches (e.g. 2 or 3 fingers)\n      if (event.touches.length > 1) {\n        return\n      }\n    }\n\n    const startSize = header_getSize(header)\n\n    const columnSizingStart: Array<[string, number]> = header\n      .getLeafHeaders()\n      .map((leafHeader) => [\n        leafHeader.column.id,\n        column_getSize(leafHeader.column),\n      ])\n\n    const clientX = isTouchStartEvent(event)\n      ? Math.round(event.touches[0]!.clientX)\n      : (event as MouseEvent).clientX\n\n    const newColumnSizing: ColumnSizingState = {}\n\n    const updateOffset = (eventType: 'move' | 'end', clientXPos?: number) => {\n      if (typeof clientXPos !== 'number') {\n        return\n      }\n\n      table_setColumnResizing(column.table, (old) => {\n        const deltaDirection =\n          column.table.options.columnResizeDirection === 'rtl' ? -1 : 1\n        const deltaOffset =\n          (clientXPos - (old.startOffset ?? 0)) * deltaDirection\n        const startSize = old.startSize ?? 0\n        const deltaPercentage = Math.max(\n          startSize > 0 ? deltaOffset / startSize : 0,\n          -0.999999,\n        )\n\n        old.columnSizingStart.forEach(([columnId, headerSize]) => {\n          newColumnSizing[columnId] =\n            Math.round(\n              Math.max(\n                headerSize > 0\n                  ? headerSize + headerSize * deltaPercentage\n                  : deltaOffset / old.columnSizingStart.length,\n                0,\n              ) * 100,\n            ) / 100\n        })\n\n        return {\n          ...old,\n          deltaOffset,\n          deltaPercentage,\n        }\n      })\n\n      if (\n        column.table.options.columnResizeMode === 'onChange' ||\n        eventType === 'end'\n      ) {\n        table_setColumnSizing(column.table, (old) => ({\n          ...old,\n          ...newColumnSizing,\n        }))\n      }\n    }\n\n    const onMove = (clientXPos?: number) => updateOffset('move', clientXPos)\n\n    const onEnd = (clientXPos?: number) => {\n      updateOffset('end', clientXPos)\n\n      table_setColumnResizing(column.table, (old) => ({\n        ...old,\n        isResizingColumn: false,\n        startOffset: null,\n        startSize: null,\n        deltaOffset: null,\n        deltaPercentage: null,\n        columnSizingStart: [],\n      }))\n    }\n\n    const contextDocument =\n      _contextDocument || typeof document !== 'undefined' ? document : null\n\n    const mouseEvents = {\n      moveHandler: (e: MouseEvent) => onMove(e.clientX),\n      upHandler: (e: MouseEvent) => {\n        contextDocument?.removeEventListener(\n          'mousemove',\n          mouseEvents.moveHandler,\n        )\n        contextDocument?.removeEventListener('mouseup', mouseEvents.upHandler)\n        onEnd(e.clientX)\n      },\n    }\n\n    const touchEvents = {\n      moveHandler: (touchEvent: TouchEvent) => {\n        if (touchEvent.cancelable) {\n          touchEvent.preventDefault()\n          touchEvent.stopPropagation()\n        }\n        onMove(touchEvent.touches[0]!.clientX)\n        return false\n      },\n      upHandler: (e: TouchEvent) => {\n        contextDocument?.removeEventListener(\n          'touchmove',\n          touchEvents.moveHandler,\n        )\n        contextDocument?.removeEventListener('touchend', touchEvents.upHandler)\n        if (e.cancelable) {\n          e.preventDefault()\n          e.stopPropagation()\n        }\n        onEnd(e.touches[0]?.clientX)\n      },\n    }\n\n    const passiveIfSupported = passiveEventSupported()\n      ? { passive: false }\n      : false\n\n    if (isTouchStartEvent(event)) {\n      contextDocument?.addEventListener(\n        'touchmove',\n        touchEvents.moveHandler,\n        passiveIfSupported,\n      )\n      contextDocument?.addEventListener(\n        'touchend',\n        touchEvents.upHandler,\n        passiveIfSupported,\n      )\n    } else {\n      contextDocument?.addEventListener(\n        'mousemove',\n        mouseEvents.moveHandler,\n        passiveIfSupported,\n      )\n      contextDocument?.addEventListener(\n        'mouseup',\n        mouseEvents.upHandler,\n        passiveIfSupported,\n      )\n    }\n\n    table_setColumnResizing(column.table, (old) => ({\n      ...old,\n      startOffset: clientX,\n      startSize,\n      deltaOffset: 0,\n      deltaPercentage: 0,\n      columnSizingStart,\n      isResizingColumn: column.id,\n    }))\n  }\n}\n\n/**\n * Updates the table's column resizing state slice.\n *\n * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.\n *\n * @example\n * ```ts\n * table_setColumnResizing(table, (old) => old)\n * ```\n */\nexport function table_setColumnResizing<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<columnResizingState>,\n) {\n  table.options.onColumnResizingChange?.(updater)\n}\n\n/**\n * Resets the table's header size info state slice.\n *\n * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.\n *\n * @example\n * ```ts\n * table_resetHeaderSizeInfo(table)\n * table_resetHeaderSizeInfo(table, true)\n * ```\n */\nexport function table_resetHeaderSizeInfo<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {\n  table_setColumnResizing(\n    table,\n    defaultState\n      ? getDefaultColumnResizingState()\n      : cloneState(\n          table.initialState.columnResizing ?? getDefaultColumnResizingState(),\n        ),\n  )\n}\n\n/**\n * Detects whether the current environment supports passive event listeners.\n *\n * Column resizing uses this to register pointer and touch listeners with the safest available options.\n *\n * @example\n * ```ts\n * const canUsePassiveListeners = passiveEventSupported()\n * ```\n */\nexport function passiveEventSupported() {\n  let passiveSupported: boolean | null = null\n\n  if (typeof passiveSupported === 'boolean') return passiveSupported\n\n  let supported = false\n  try {\n    const options = {\n      get passive() {\n        supported = true\n        return false\n      },\n    }\n\n    const noop = () => {}\n\n    window.addEventListener('test', noop, options)\n    window.removeEventListener('test', noop)\n  } catch (err) {\n    supported = false\n  }\n  passiveSupported = supported\n  return passiveSupported\n}\n\n/**\n * Returns whether an event is a touch-start event.\n *\n * Column resizing uses this to normalize mouse and touch resize interactions.\n *\n * @example\n * ```ts\n * const isTouch = isTouchStartEvent(event)\n * ```\n */\nexport function isTouchStartEvent(e: unknown): e is TouchEvent {\n  return (e as TouchEvent).type === 'touchstart'\n}\n"],"mappings":";;;;;;;;;;;;;;;AAyBA,SAAgB,gCAAqD;CACnE,OAAO;EACL,aAAa;EACb,WAAW;EACX,aAAa;EACb,iBAAiB;EACjB,kBAAkB;EAClB,mBAAmB,EAAE;EACtB;;;;;;;;;;;;AAaH,SAAgB,oBAId,QAAmD;CACnD,QACG,OAAO,UAAU,kBAAkB,UACnC,OAAO,MAAM,QAAQ,wBAAwB;;;;;;;;;;;;AAclD,SAAgB,qBAId,QAAmD;;CACnD,iCACE,OAAO,MAAM,MAAM,+GAAgB,KAAK,gFAAE,sBAAqB,OAAO;;;;;;;;;;;;AAc1E,SAAgB,wBAId,QAA0C,kBAA6B;CACvE,MAAM,SAASA,iDAAgB,OAAO,OAAO,OAAO,OAAO,OAAO,GAAG;CACrE,MAAM,YAAY,oBAAoB,OAAO;CAE7C,QAAQ,UAAmB;;EACzB,IAAI,CAAC,WACH;EAGD,YAAC,MAAc,gEAAW;EAE3B,IAAI,kBAAkB,MAAM,EAE1B;OAAI,MAAM,QAAQ,SAAS,GACzB;;EAIJ,MAAM,YAAYC,iDAAe,OAAO;EAExC,MAAM,oBAA6C,OAChD,gBAAgB,CAChB,KAAK,eAAe,CACnB,WAAW,OAAO,IAClBC,iDAAe,WAAW,OAAO,CAClC,CAAC;EAEJ,MAAM,UAAU,kBAAkB,MAAM,GACpC,KAAK,MAAM,MAAM,QAAQ,GAAI,QAAQ,GACpC,MAAqB;EAE1B,MAAM,kBAAqC,EAAE;EAE7C,MAAM,gBAAgB,WAA2B,eAAwB;GACvE,IAAI,OAAO,eAAe,UACxB;GAGF,wBAAwB,OAAO,QAAQ,QAAQ;IAC7C,MAAM,iBACJ,OAAO,MAAM,QAAQ,0BAA0B,QAAQ,KAAK;IAC9D,MAAM,eACH,cAAc,IAAI,eAAe,MAAM;IAC1C,MAAM,YAAY,IAAI,aAAa;IACnC,MAAM,kBAAkB,KAAK,IAC3B,YAAY,IAAI,cAAc,YAAY,GAC1C,SACD;IAED,IAAI,kBAAkB,SAAS,CAAC,UAAU,gBAAgB;KACxD,gBAAgB,YACd,KAAK,MACH,KAAK,IACH,aAAa,IACT,aAAa,aAAa,kBAC1B,cAAc,IAAI,kBAAkB,QACxC,EACD,GAAG,IACL,GAAG;MACN;IAEF,OAAO;KACL,GAAG;KACH;KACA;KACD;KACD;GAEF,IACE,OAAO,MAAM,QAAQ,qBAAqB,cAC1C,cAAc,OAEd,wDAAsB,OAAO,QAAQ,SAAS;IAC5C,GAAG;IACH,GAAG;IACJ,EAAE;;EAIP,MAAM,UAAU,eAAwB,aAAa,QAAQ,WAAW;EAExE,MAAM,SAAS,eAAwB;GACrC,aAAa,OAAO,WAAW;GAE/B,wBAAwB,OAAO,QAAQ,SAAS;IAC9C,GAAG;IACH,kBAAkB;IAClB,aAAa;IACb,WAAW;IACX,aAAa;IACb,iBAAiB;IACjB,mBAAmB,EAAE;IACtB,EAAE;;EAGL,MAAM,kBACJ,oBAAoB,OAAO,aAAa,cAAc,WAAW;EAEnE,MAAM,cAAc;GAClB,cAAc,MAAkB,OAAO,EAAE,QAAQ;GACjD,YAAY,MAAkB;IAC5B,0EAAiB,oBACf,aACA,YAAY,YACb;IACD,0EAAiB,oBAAoB,WAAW,YAAY,UAAU;IACtE,MAAM,EAAE,QAAQ;;GAEnB;EAED,MAAM,cAAc;GAClB,cAAc,eAA2B;IACvC,IAAI,WAAW,YAAY;KACzB,WAAW,gBAAgB;KAC3B,WAAW,iBAAiB;;IAE9B,OAAO,WAAW,QAAQ,GAAI,QAAQ;IACtC,OAAO;;GAET,YAAY,MAAkB;;IAC5B,0EAAiB,oBACf,aACA,YAAY,YACb;IACD,0EAAiB,oBAAoB,YAAY,YAAY,UAAU;IACvE,IAAI,EAAE,YAAY;KAChB,EAAE,gBAAgB;KAClB,EAAE,iBAAiB;;IAErB,qBAAM,EAAE,QAAQ,8DAAI,QAAQ;;GAE/B;EAED,MAAM,qBAAqB,uBAAuB,GAC9C,EAAE,SAAS,OAAO,GAClB;EAEJ,IAAI,kBAAkB,MAAM,EAAE;GAC5B,0EAAiB,iBACf,aACA,YAAY,aACZ,mBACD;GACD,0EAAiB,iBACf,YACA,YAAY,WACZ,mBACD;SACI;GACL,0EAAiB,iBACf,aACA,YAAY,aACZ,mBACD;GACD,0EAAiB,iBACf,WACA,YAAY,WACZ,mBACD;;EAGH,wBAAwB,OAAO,QAAQ,SAAS;GAC9C,GAAG;GACH,aAAa;GACb;GACA,aAAa;GACb,iBAAiB;GACjB;GACA,kBAAkB,OAAO;GAC1B,EAAE;;;;;;;;;;;;;AAcP,SAAgB,wBAId,OACA,SACA;;CACA,iDAAM,SAAQ,mHAAyB,QAAQ;;;;;;;;;;;;;AAcjD,SAAgB,0BAGd,OAAyC,cAAwB;CACjE,wBACE,OACA,eACI,+BAA+B,GAC/BC,yBACE,MAAM,aAAa,kBAAkB,+BAA+B,CACrE,CACN;;;;;;;;;;;;AAaH,SAAgB,wBAAwB;CACtC,IAAI,mBAAmC;CAEvC,IAAI,OAAO,qBAAqB,WAAW,OAAO;CAElD,IAAI,YAAY;CAChB,IAAI;EACF,MAAM,UAAU,EACd,IAAI,UAAU;GACZ,YAAY;GACZ,OAAO;KAEV;EAED,MAAM,aAAa;EAEnB,OAAO,iBAAiB,QAAQ,MAAM,QAAQ;EAC9C,OAAO,oBAAoB,QAAQ,KAAK;UACjC,KAAK;EACZ,YAAY;;CAEd,mBAAmB;CACnB,OAAO;;;;;;;;;;;;AAaT,SAAgB,kBAAkB,GAA6B;CAC7D,OAAQ,EAAiB,SAAS"}

package/dist/features/column-resizing/columnResizingFeature.utils.d.cts

@@ -6,13 +6,94 @@ import { TableFeatures } from "../../types/TableFeatures.cjs";
 import { Table_Internal } from "../../types/Table.cjs";
 
 //#region src/features/column-resizing/columnResizingFeature.utils.d.ts
+/**
+ * Returns the default column resizing state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultColumnResizingState()
+ * ```
+ */
 declare function getDefaultColumnResizingState(): columnResizingState;
+/**
+ * Returns whether a column can use resize.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanResize(column)
+ * ```
+ */
 declare function column_getCanResize<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns is resizing for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getIsResizing(column)
+ * ```
+ */
 declare function column_getIsResizing<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns resize handler for a header.
+ *
+ * This is the static implementation behind the matching header instance API and can account for nested header groups.
+ *
+ * @example
+ * ```ts
+ * const onMouseDown = header_getResizeHandler(header)
+ * ```
+ */
 declare function header_getResizeHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(header: Header<TFeatures, TData, TValue>, _contextDocument?: Document): (event: unknown) => void;
+/**
+ * Updates the table's column resizing state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setColumnResizing(table, (old) => old)
+ * ```
+ */
 declare function table_setColumnResizing<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<columnResizingState>): void;
+/**
+ * Resets the table's header size info state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetHeaderSizeInfo(table)
+ * table_resetHeaderSizeInfo(table, true)
+ * ```
+ */
 declare function table_resetHeaderSizeInfo<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Detects whether the current environment supports passive event listeners.
+ *
+ * Column resizing uses this to register pointer and touch listeners with the safest available options.
+ *
+ * @example
+ * ```ts
+ * const canUsePassiveListeners = passiveEventSupported()
+ * ```
+ */
 declare function passiveEventSupported(): boolean;
+/**
+ * Returns whether an event is a touch-start event.
+ *
+ * Column resizing uses this to normalize mouse and touch resize interactions.
+ *
+ * @example
+ * ```ts
+ * const isTouch = isTouchStartEvent(event)
+ * ```
+ */
 declare function isTouchStartEvent(e: unknown): e is TouchEvent;
 //#endregion
 export { column_getCanResize, column_getIsResizing, getDefaultColumnResizingState, header_getResizeHandler, isTouchStartEvent, passiveEventSupported, table_resetHeaderSizeInfo, table_setColumnResizing };

package/dist/features/column-resizing/columnResizingFeature.utils.d.ts

@@ -6,13 +6,94 @@ import { TableFeatures } from "../../types/TableFeatures.js";
 import { Table_Internal } from "../../types/Table.js";
 
 //#region src/features/column-resizing/columnResizingFeature.utils.d.ts
+/**
+ * Returns the default column resizing state.
+ *
+ * Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+ *
+ * @example
+ * ```ts
+ * const initialValue = getDefaultColumnResizingState()
+ * ```
+ */
 declare function getDefaultColumnResizingState(): columnResizingState;
+/**
+ * Returns whether a column can use resize.
+ *
+ * This combines column options, table options, and any required accessor or feature state for the capability.
+ *
+ * @example
+ * ```ts
+ * const value = column_getCanResize(column)
+ * ```
+ */
 declare function column_getCanResize<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns is resizing for a column.
+ *
+ * This derives the value from the column definition, table options, and the feature state atoms registered on the table.
+ *
+ * @example
+ * ```ts
+ * const value = column_getIsResizing(column)
+ * ```
+ */
 declare function column_getIsResizing<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(column: Column_Internal<TFeatures, TData, TValue>): boolean;
+/**
+ * Returns resize handler for a header.
+ *
+ * This is the static implementation behind the matching header instance API and can account for nested header groups.
+ *
+ * @example
+ * ```ts
+ * const onMouseDown = header_getResizeHandler(header)
+ * ```
+ */
 declare function header_getResizeHandler<TFeatures extends TableFeatures, TData extends RowData, TValue extends CellData = CellData>(header: Header<TFeatures, TData, TValue>, _contextDocument?: Document): (event: unknown) => void;
+/**
+ * Updates the table's column resizing state slice.
+ *
+ * The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+ *
+ * @example
+ * ```ts
+ * table_setColumnResizing(table, (old) => old)
+ * ```
+ */
 declare function table_setColumnResizing<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<columnResizingState>): void;
+/**
+ * Resets the table's header size info state slice.
+ *
+ * By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+ *
+ * @example
+ * ```ts
+ * table_resetHeaderSizeInfo(table)
+ * table_resetHeaderSizeInfo(table, true)
+ * ```
+ */
 declare function table_resetHeaderSizeInfo<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * Detects whether the current environment supports passive event listeners.
+ *
+ * Column resizing uses this to register pointer and touch listeners with the safest available options.
+ *
+ * @example
+ * ```ts
+ * const canUsePassiveListeners = passiveEventSupported()
+ * ```
+ */
 declare function passiveEventSupported(): boolean;
+/**
+ * Returns whether an event is a touch-start event.
+ *
+ * Column resizing uses this to normalize mouse and touch resize interactions.
+ *
+ * @example
+ * ```ts
+ * const isTouch = isTouchStartEvent(event)
+ * ```
+ */
 declare function isTouchStartEvent(e: unknown): e is TouchEvent;
 //#endregion
 export { column_getCanResize, column_getIsResizing, getDefaultColumnResizingState, header_getResizeHandler, isTouchStartEvent, passiveEventSupported, table_resetHeaderSizeInfo, table_setColumnResizing };