@tanstack/table-core 9.0.0-alpha.47 → 9.0.0-alpha.48

package/dist/features/row-pinning/rowPinningFeature.utils.js

@@ -3,13 +3,14 @@ import { row_getIsAllParentsExpanded } from "../row-expanding/rowExpandingFeatur
 
 //#region src/features/row-pinning/rowPinningFeature.utils.ts
 /**
-* Returns the default row pinning state.
+* Creates the default row pinning state.
 *
-* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+* Both pinning regions start empty. Reset APIs use this value when
+* `defaultState` is `true`.
 *
 * @example
 * ```ts
-* const initialValue = getDefaultRowPinningState()
+* const pinning = getDefaultRowPinningState()
 * ```
 */
 function getDefaultRowPinningState() {
@@ -19,13 +20,14 @@ function getDefaultRowPinningState() {
 	};
 }
 /**
-* Updates the table's row pinning state slice.
+* Routes a row pinning updater through the table's row-pinning change handler.
 *
-* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+* The updater may be a next `{ top, bottom }` state or a function of the
+* previous state, matching the instance `table.setRowPinning` behavior.
 *
 * @example
 * ```ts
-* table_setRowPinning(table, (old) => old)
+* table_setRowPinning(table, (old) => ({ ...old, top: [rowId] }))
 * ```
 */
 function table_setRowPinning(table, updater) {
@@ -33,9 +35,11 @@ function table_setRowPinning(table, updater) {
 	(_table$options$onRowP = (_table$options = table.options).onRowPinningChange) === null || _table$options$onRowP === void 0 || _table$options$onRowP.call(_table$options, updater);
 }
 /**
-* Resets the table's row pinning state slice.
+* Resets `rowPinning` to the configured initial state or feature default.
 *
-* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+* With no argument, the reset clones `table.initialState.rowPinning` when it
+* exists. Passing `true` ignores initial state and resets to empty top/bottom
+* arrays.
 *
 * @example
 * ```ts
@@ -47,13 +51,14 @@ function table_resetRowPinning(table, defaultState) {
 	table_setRowPinning(table, defaultState ? getDefaultRowPinningState() : cloneState(table.initialState.rowPinning ?? getDefaultRowPinningState()));
 }
 /**
-* Returns is some rows pinned for the table.
+* Checks whether any rows are pinned.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* Omit `position` to check both regions, or pass `'top'`/`'bottom'` to inspect
+* one region.
 *
 * @example
 * ```ts
-* const value = table_getIsSomeRowsPinned(table)
+* const hasPinnedRows = table_getIsSomeRowsPinned(table)
 * ```
 */
 function table_getIsSomeRowsPinned(table, position) {
@@ -82,39 +87,42 @@ function table_getPinnedRows(table, position) {
 	return result;
 }
 /**
-* Returns top rows for the table.
+* Resolves the visible rows pinned to the top region.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* The result follows `state.rowPinning.top` order and marks each row with
+* `position = 'top'`.
 *
 * @example
 * ```ts
-* const value = table_getTopRows(table)
+* const rows = table_getTopRows(table)
 * ```
 */
 function table_getTopRows(table) {
 	return table_getPinnedRows(table, "top");
 }
 /**
-* Returns bottom rows for the table.
+* Resolves the visible rows pinned to the bottom region.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* The result follows `state.rowPinning.bottom` order and marks each row with
+* `position = 'bottom'`.
 *
 * @example
 * ```ts
-* const value = table_getBottomRows(table)
+* const rows = table_getBottomRows(table)
 * ```
 */
 function table_getBottomRows(table) {
 	return table_getPinnedRows(table, "bottom");
 }
 /**
-* Returns center rows for the table.
+* Resolves rows that are not pinned to top or bottom.
 *
-* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+* The current row model is filtered by `state.rowPinning.top` and
+* `state.rowPinning.bottom`.
 *
 * @example
 * ```ts
-* const value = table_getCenterRows(table)
+* const rows = table_getCenterRows(table)
 * ```
 */
 function table_getCenterRows(table) {
@@ -125,13 +133,14 @@ function table_getCenterRows(table) {
 	return allRows.filter((d) => !topAndBottom.has(d.id));
 }
 /**
-* Returns whether a row can use pin.
+* Checks whether this row can be pinned.
 *
-* This evaluates row data, table options, and feature-specific enablement rules.
+* `options.enableRowPinning` may be a boolean or a row predicate; it defaults
+* to `true`.
 *
 * @example
 * ```ts
-* const value = row_getCanPin(row)
+* const canPin = row_getCanPin(row)
 * ```
 */
 function row_getCanPin(row) {
@@ -140,13 +149,14 @@ function row_getCanPin(row) {
 	return enableRowPinning ?? true;
 }
 /**
-* Returns is pinned for a row.
+* Reads this row's current pinning region.
 *
-* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+* Rows listed in `state.rowPinning.top` return `'top'`, rows listed in
+* `bottom` return `'bottom'`, and unpinned rows return `false`.
 *
 * @example
 * ```ts
-* const value = row_getIsPinned(row)
+* const position = row_getIsPinned(row)
 * ```
 */
 function row_getIsPinned(row) {
@@ -155,13 +165,13 @@ function row_getIsPinned(row) {
 	return top.includes(row.id) ? "top" : bottom.includes(row.id) ? "bottom" : false;
 }
 /**
-* Returns pinned index for a row.
+* Finds this row's visible index within its pinned region.
 *
-* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+* Unpinned rows return `-1`.
 *
 * @example
 * ```ts
-* const value = row_getPinnedIndex(row)
+* const index = row_getPinnedIndex(row)
 * ```
 */
 function row_getPinnedIndex(row) {

package/dist/features/row-pinning/rowPinningFeature.utils.js.map

@@ -1 +1 @@
-{"version":3,"file":"rowPinningFeature.utils.js","names":[],"sources":["../../../src/features/row-pinning/rowPinningFeature.utils.ts"],"sourcesContent":["import { row_getIsAllParentsExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { callMemoOrStaticFn, cloneState } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type {\n  RowPinningPosition,\n  RowPinningState,\n} from './rowPinningFeature.types'\n\n// State Utils\n\n/**\n * Returns the default row pinning 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 = getDefaultRowPinningState()\n * ```\n */\nexport function getDefaultRowPinningState(): RowPinningState {\n  return {\n    top: [],\n    bottom: [],\n  }\n}\n\n/**\n * Updates the table's row pinning 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_setRowPinning(table, (old) => old)\n * ```\n */\nexport function table_setRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<RowPinningState>,\n): void {\n  table.options.onRowPinningChange?.(updater)\n}\n\n/**\n * Resets the table's row pinning 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_resetRowPinning(table)\n * table_resetRowPinning(table, true)\n * ```\n */\nexport function table_resetRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void {\n  table_setRowPinning(\n    table,\n    defaultState\n      ? getDefaultRowPinningState()\n      : cloneState(\n          table.initialState.rowPinning ?? getDefaultRowPinningState(),\n        ),\n  )\n}\n\n// Table Utils\n\n/**\n * Returns is some rows pinned for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getIsSomeRowsPinned(table)\n * ```\n */\nexport function table_getIsSomeRowsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position?: RowPinningPosition,\n): boolean {\n  const rowPinning = table.atoms.rowPinning?.get()\n\n  if (!position) {\n    return Boolean(rowPinning?.top.length || rowPinning?.bottom.length)\n  }\n  return Boolean(rowPinning?.[position].length)\n}\n\nfunction table_getPinnedRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position: 'top' | 'bottom',\n): Array<Row<TFeatures, TData>> {\n  const visibleRows = table.getRowModel().rows\n  const pinnedRowIds = table.atoms.rowPinning?.get()?.[position] ?? []\n  const keepPinnedRows = table.options.keepPinnedRows ?? true\n\n  const result: Array<Row<TFeatures, TData>> = []\n  for (let i = 0; i < pinnedRowIds.length; i++) {\n    const rowId = pinnedRowIds[i]!\n    let row: Row<TFeatures, TData> | undefined\n    if (keepPinnedRows) {\n      // get all rows that are pinned even if they would not be otherwise\n      // visible; account for expanded parent rows, but not pagination/filtering\n      const fullRow = table.getRow(rowId, true)\n      if (row_getIsAllParentsExpanded(fullRow)) row = fullRow\n    } else {\n      // else get only visible rows that are pinned\n      row = visibleRows.find((r) => r.id === rowId)\n    }\n    if (!row)\n      continue\n      // Assign position property directly to preserve prototype chain\n    ;(row as any).position = position\n    result.push(row)\n  }\n  return result\n}\n\n/**\n * Returns top rows for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getTopRows(table)\n * ```\n */\nexport function table_getTopRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'top')\n}\n\n/**\n * Returns bottom rows for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getBottomRows(table)\n * ```\n */\nexport function table_getBottomRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'bottom')\n}\n\n/**\n * Returns center rows for the table.\n *\n * This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.\n *\n * @example\n * ```ts\n * const value = table_getCenterRows(table)\n * ```\n */\nexport function table_getCenterRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  const { top, bottom } =\n    table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n  const allRows = table.getRowModel().rows\n\n  const topAndBottom = new Set([...top, ...bottom])\n  return allRows.filter((d) => !topAndBottom.has(d.id))\n}\n\n// Row Utils\n\n/**\n * Returns whether a row can use pin.\n *\n * This evaluates row data, table options, and feature-specific enablement rules.\n *\n * @example\n * ```ts\n * const value = row_getCanPin(row)\n * ```\n */\nexport function row_getCanPin<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): boolean {\n  const { enableRowPinning } = row.table.options\n  if (typeof enableRowPinning === 'function') {\n    return enableRowPinning(row)\n  }\n  return enableRowPinning ?? true\n}\n\n/**\n * Returns is pinned for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getIsPinned(row)\n * ```\n */\nexport function row_getIsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): RowPinningPosition {\n  const { top, bottom } =\n    row.table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n\n  return top.includes(row.id)\n    ? 'top'\n    : bottom.includes(row.id)\n      ? 'bottom'\n      : false\n}\n\n/**\n * Returns pinned index for a row.\n *\n * This is the static implementation behind the matching row instance API and may read row caches or table state atoms.\n *\n * @example\n * ```ts\n * const value = row_getPinnedIndex(row)\n * ```\n */\nexport function row_getPinnedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): number {\n  const position = row_getIsPinned(row)\n  if (!position) return -1\n\n  const visiblePinnedRowIds = (\n    position === 'top'\n      ? callMemoOrStaticFn(row.table, 'getTopRows', table_getTopRows)\n      : callMemoOrStaticFn(row.table, 'getBottomRows', table_getBottomRows)\n  ).map(({ id }) => id)\n\n  return visiblePinnedRowIds.indexOf(row.id)\n}\n\n/**\n * Pins or unpins a row.\n *\n * Optional flags let callers include parent rows or leaf rows when updating\n * the row pinning state.\n *\n * @example\n * ```ts\n * row_pin(row, 'top')\n * ```\n */\nexport function row_pin<TFeatures extends TableFeatures, TData extends RowData>(\n  row: Row<TFeatures, TData>,\n  position: RowPinningPosition,\n  includeLeafRows?: boolean,\n  includeParentRows?: boolean,\n): void {\n  const leafRowIds = includeLeafRows\n    ? row.getLeafRows().map(({ id }) => id)\n    : []\n  const parentRowIds = includeParentRows\n    ? row.getParentRows().map(({ id }) => id)\n    : []\n  const rowIds: Set<string> = new Set([...parentRowIds, row.id, ...leafRowIds])\n\n  table_setRowPinning(row.table, (old) => {\n    if (position === 'bottom') {\n      return {\n        top: old.top.filter((d) => !rowIds.has(d)),\n        bottom: [\n          ...old.bottom.filter((d) => !rowIds.has(d)),\n          ...Array.from(rowIds),\n        ],\n      }\n    }\n\n    if (position === 'top') {\n      return {\n        top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],\n        bottom: old.bottom.filter((d) => !rowIds.has(d)),\n      }\n    }\n\n    return {\n      top: old.top.filter((d) => !rowIds.has(d)),\n      bottom: old.bottom.filter((d) => !rowIds.has(d)),\n    }\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;AAuBA,SAAgB,4BAA6C;CAC3D,OAAO;EACL,KAAK,EAAE;EACP,QAAQ,EAAE;EACX;;;;;;;;;;;;AAaH,SAAgB,oBAId,OACA,SACM;;CACN,iDAAM,SAAQ,+GAAqB,QAAQ;;;;;;;;;;;;;AAc7C,SAAgB,sBAGd,OAAyC,cAA8B;CACvE,oBACE,OACA,eACI,2BAA2B,GAC3B,WACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;;;;;;;;;;;AAeH,SAAgB,0BAId,OACA,UACS;;CACT,MAAM,sCAAa,MAAM,MAAM,0FAAY,KAAK;CAEhD,IAAI,CAAC,UACH,OAAO,iEAAQ,WAAY,IAAI,oEAAU,WAAY,OAAO,QAAO;CAErE,OAAO,gEAAQ,WAAa,UAAU,OAAO;;AAG/C,SAAS,oBAIP,OACA,UAC8B;;CAC9B,MAAM,cAAc,MAAM,aAAa,CAAC;CACxC,MAAM,0CAAe,MAAM,MAAM,8GAAY,KAAK,kFAAG,cAAa,EAAE;CACpE,MAAM,iBAAiB,MAAM,QAAQ,kBAAkB;CAEvD,MAAM,SAAuC,EAAE;CAC/C,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;EAC5C,MAAM,QAAQ,aAAa;EAC3B,IAAI;EACJ,IAAI,gBAAgB;GAGlB,MAAM,UAAU,MAAM,OAAO,OAAO,KAAK;GACzC,IAAI,4BAA4B,QAAQ,EAAE,MAAM;SAGhD,MAAM,YAAY,MAAM,MAAM,EAAE,OAAO,MAAM;EAE/C,IAAI,CAAC,KACH;EAED,AAAC,IAAY,WAAW;EACzB,OAAO,KAAK,IAAI;;CAElB,OAAO;;;;;;;;;;;;AAaT,SAAgB,iBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,MAAM;;;;;;;;;;;;AAa1C,SAAgB,oBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,SAAS;;;;;;;;;;;;AAa7C,SAAgB,oBAGd,OAAuE;;CACvE,MAAM,EAAE,KAAK,sCACX,MAAM,MAAM,4FAAY,KAAK,KAAI,2BAA2B;CAC9D,MAAM,UAAU,MAAM,aAAa,CAAC;CAEpC,MAAM,eAAe,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC;CACjD,OAAO,QAAQ,QAAQ,MAAM,CAAC,aAAa,IAAI,EAAE,GAAG,CAAC;;;;;;;;;;;;AAevD,SAAgB,cAGd,KAAqC;CACrC,MAAM,EAAE,qBAAqB,IAAI,MAAM;CACvC,IAAI,OAAO,qBAAqB,YAC9B,OAAO,iBAAiB,IAAI;CAE9B,OAAO,oBAAoB;;;;;;;;;;;;AAa7B,SAAgB,gBAGd,KAAgD;;CAChD,MAAM,EAAE,KAAK,qCACX,IAAI,MAAM,MAAM,0FAAY,KAAK,KAAI,2BAA2B;CAElE,OAAO,IAAI,SAAS,IAAI,GAAG,GACvB,QACA,OAAO,SAAS,IAAI,GAAG,GACrB,WACA;;;;;;;;;;;;AAaR,SAAgB,mBAGd,KAAoC;CACpC,MAAM,WAAW,gBAAgB,IAAI;CACrC,IAAI,CAAC,UAAU,OAAO;CAQtB,QALE,aAAa,QACT,mBAAmB,IAAI,OAAO,cAAc,iBAAiB,GAC7D,mBAAmB,IAAI,OAAO,iBAAiB,oBAAoB,EACvE,KAAK,EAAE,SAAS,GAEQ,CAAC,QAAQ,IAAI,GAAG;;;;;;;;;;;;;AAc5C,SAAgB,QACd,KACA,UACA,iBACA,mBACM;CACN,MAAM,aAAa,kBACf,IAAI,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,GACrC,EAAE;CACN,MAAM,eAAe,oBACjB,IAAI,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,GACvC,EAAE;CACN,MAAM,SAAsB,IAAI,IAAI;EAAC,GAAG;EAAc,IAAI;EAAI,GAAG;EAAW,CAAC;CAE7E,oBAAoB,IAAI,QAAQ,QAAQ;EACtC,IAAI,aAAa,UACf,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,CACN,GAAG,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAC3C,GAAG,MAAM,KAAK,OAAO,CACtB;GACF;EAGH,IAAI,aAAa,OACf,OAAO;GACL,KAAK,CAAC,GAAG,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,KAAK,OAAO,CAAC;GACtE,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;EAGH,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;GACD"}
+{"version":3,"file":"rowPinningFeature.utils.js","names":[],"sources":["../../../src/features/row-pinning/rowPinningFeature.utils.ts"],"sourcesContent":["import { row_getIsAllParentsExpanded } from '../row-expanding/rowExpandingFeature.utils'\nimport { callMemoOrStaticFn, cloneState } from '../../utils'\nimport type { RowData, Updater } from '../../types/type-utils'\nimport type { TableFeatures } from '../../types/TableFeatures'\nimport type { Table_Internal } from '../../types/Table'\nimport type { Row } from '../../types/Row'\nimport type {\n  RowPinningPosition,\n  RowPinningState,\n} from './rowPinningFeature.types'\n\n// State Utils\n\n/**\n * Creates the default row pinning state.\n *\n * Both pinning regions start empty. Reset APIs use this value when\n * `defaultState` is `true`.\n *\n * @example\n * ```ts\n * const pinning = getDefaultRowPinningState()\n * ```\n */\nexport function getDefaultRowPinningState(): RowPinningState {\n  return {\n    top: [],\n    bottom: [],\n  }\n}\n\n/**\n * Routes a row pinning updater through the table's row-pinning change handler.\n *\n * The updater may be a next `{ top, bottom }` state or a function of the\n * previous state, matching the instance `table.setRowPinning` behavior.\n *\n * @example\n * ```ts\n * table_setRowPinning(table, (old) => ({ ...old, top: [rowId] }))\n * ```\n */\nexport function table_setRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  updater: Updater<RowPinningState>,\n): void {\n  table.options.onRowPinningChange?.(updater)\n}\n\n/**\n * Resets `rowPinning` to the configured initial state or feature default.\n *\n * With no argument, the reset clones `table.initialState.rowPinning` when it\n * exists. Passing `true` ignores initial state and resets to empty top/bottom\n * arrays.\n *\n * @example\n * ```ts\n * table_resetRowPinning(table)\n * table_resetRowPinning(table, true)\n * ```\n */\nexport function table_resetRowPinning<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void {\n  table_setRowPinning(\n    table,\n    defaultState\n      ? getDefaultRowPinningState()\n      : cloneState(\n          table.initialState.rowPinning ?? getDefaultRowPinningState(),\n        ),\n  )\n}\n\n// Table Utils\n\n/**\n * Checks whether any rows are pinned.\n *\n * Omit `position` to check both regions, or pass `'top'`/`'bottom'` to inspect\n * one region.\n *\n * @example\n * ```ts\n * const hasPinnedRows = table_getIsSomeRowsPinned(table)\n * ```\n */\nexport function table_getIsSomeRowsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position?: RowPinningPosition,\n): boolean {\n  const rowPinning = table.atoms.rowPinning?.get()\n\n  if (!position) {\n    return Boolean(rowPinning?.top.length || rowPinning?.bottom.length)\n  }\n  return Boolean(rowPinning?.[position].length)\n}\n\nfunction table_getPinnedRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(\n  table: Table_Internal<TFeatures, TData>,\n  position: 'top' | 'bottom',\n): Array<Row<TFeatures, TData>> {\n  const visibleRows = table.getRowModel().rows\n  const pinnedRowIds = table.atoms.rowPinning?.get()?.[position] ?? []\n  const keepPinnedRows = table.options.keepPinnedRows ?? true\n\n  const result: Array<Row<TFeatures, TData>> = []\n  for (let i = 0; i < pinnedRowIds.length; i++) {\n    const rowId = pinnedRowIds[i]!\n    let row: Row<TFeatures, TData> | undefined\n    if (keepPinnedRows) {\n      // get all rows that are pinned even if they would not be otherwise\n      // visible; account for expanded parent rows, but not pagination/filtering\n      const fullRow = table.getRow(rowId, true)\n      if (row_getIsAllParentsExpanded(fullRow)) row = fullRow\n    } else {\n      // else get only visible rows that are pinned\n      row = visibleRows.find((r) => r.id === rowId)\n    }\n    if (!row)\n      continue\n      // Assign position property directly to preserve prototype chain\n    ;(row as any).position = position\n    result.push(row)\n  }\n  return result\n}\n\n/**\n * Resolves the visible rows pinned to the top region.\n *\n * The result follows `state.rowPinning.top` order and marks each row with\n * `position = 'top'`.\n *\n * @example\n * ```ts\n * const rows = table_getTopRows(table)\n * ```\n */\nexport function table_getTopRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'top')\n}\n\n/**\n * Resolves the visible rows pinned to the bottom region.\n *\n * The result follows `state.rowPinning.bottom` order and marks each row with\n * `position = 'bottom'`.\n *\n * @example\n * ```ts\n * const rows = table_getBottomRows(table)\n * ```\n */\nexport function table_getBottomRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  return table_getPinnedRows(table, 'bottom')\n}\n\n/**\n * Resolves rows that are not pinned to top or bottom.\n *\n * The current row model is filtered by `state.rowPinning.top` and\n * `state.rowPinning.bottom`.\n *\n * @example\n * ```ts\n * const rows = table_getCenterRows(table)\n * ```\n */\nexport function table_getCenterRows<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(table: Table_Internal<TFeatures, TData>): Array<Row<TFeatures, TData>> {\n  const { top, bottom } =\n    table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n  const allRows = table.getRowModel().rows\n\n  const topAndBottom = new Set([...top, ...bottom])\n  return allRows.filter((d) => !topAndBottom.has(d.id))\n}\n\n// Row Utils\n\n/**\n * Checks whether this row can be pinned.\n *\n * `options.enableRowPinning` may be a boolean or a row predicate; it defaults\n * to `true`.\n *\n * @example\n * ```ts\n * const canPin = row_getCanPin(row)\n * ```\n */\nexport function row_getCanPin<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): boolean {\n  const { enableRowPinning } = row.table.options\n  if (typeof enableRowPinning === 'function') {\n    return enableRowPinning(row)\n  }\n  return enableRowPinning ?? true\n}\n\n/**\n * Reads this row's current pinning region.\n *\n * Rows listed in `state.rowPinning.top` return `'top'`, rows listed in\n * `bottom` return `'bottom'`, and unpinned rows return `false`.\n *\n * @example\n * ```ts\n * const position = row_getIsPinned(row)\n * ```\n */\nexport function row_getIsPinned<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): RowPinningPosition {\n  const { top, bottom } =\n    row.table.atoms.rowPinning?.get() ?? getDefaultRowPinningState()\n\n  return top.includes(row.id)\n    ? 'top'\n    : bottom.includes(row.id)\n      ? 'bottom'\n      : false\n}\n\n/**\n * Finds this row's visible index within its pinned region.\n *\n * Unpinned rows return `-1`.\n *\n * @example\n * ```ts\n * const index = row_getPinnedIndex(row)\n * ```\n */\nexport function row_getPinnedIndex<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(row: Row<TFeatures, TData>): number {\n  const position = row_getIsPinned(row)\n  if (!position) return -1\n\n  const visiblePinnedRowIds = (\n    position === 'top'\n      ? callMemoOrStaticFn(row.table, 'getTopRows', table_getTopRows)\n      : callMemoOrStaticFn(row.table, 'getBottomRows', table_getBottomRows)\n  ).map(({ id }) => id)\n\n  return visiblePinnedRowIds.indexOf(row.id)\n}\n\n/**\n * Pins or unpins a row.\n *\n * Optional flags let callers include parent rows or leaf rows when updating\n * the row pinning state.\n *\n * @example\n * ```ts\n * row_pin(row, 'top')\n * ```\n */\nexport function row_pin<TFeatures extends TableFeatures, TData extends RowData>(\n  row: Row<TFeatures, TData>,\n  position: RowPinningPosition,\n  includeLeafRows?: boolean,\n  includeParentRows?: boolean,\n): void {\n  const leafRowIds = includeLeafRows\n    ? row.getLeafRows().map(({ id }) => id)\n    : []\n  const parentRowIds = includeParentRows\n    ? row.getParentRows().map(({ id }) => id)\n    : []\n  const rowIds: Set<string> = new Set([...parentRowIds, row.id, ...leafRowIds])\n\n  table_setRowPinning(row.table, (old) => {\n    if (position === 'bottom') {\n      return {\n        top: old.top.filter((d) => !rowIds.has(d)),\n        bottom: [\n          ...old.bottom.filter((d) => !rowIds.has(d)),\n          ...Array.from(rowIds),\n        ],\n      }\n    }\n\n    if (position === 'top') {\n      return {\n        top: [...old.top.filter((d) => !rowIds.has(d)), ...Array.from(rowIds)],\n        bottom: old.bottom.filter((d) => !rowIds.has(d)),\n      }\n    }\n\n    return {\n      top: old.top.filter((d) => !rowIds.has(d)),\n      bottom: old.bottom.filter((d) => !rowIds.has(d)),\n    }\n  })\n}\n"],"mappings":";;;;;;;;;;;;;;;AAwBA,SAAgB,4BAA6C;CAC3D,OAAO;EACL,KAAK,EAAE;EACP,QAAQ,EAAE;EACX;;;;;;;;;;;;;AAcH,SAAgB,oBAId,OACA,SACM;;CACN,iDAAM,SAAQ,+GAAqB,QAAQ;;;;;;;;;;;;;;;AAgB7C,SAAgB,sBAGd,OAAyC,cAA8B;CACvE,oBACE,OACA,eACI,2BAA2B,GAC3B,WACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;;;;;;;;;;;;AAgBH,SAAgB,0BAId,OACA,UACS;;CACT,MAAM,sCAAa,MAAM,MAAM,0FAAY,KAAK;CAEhD,IAAI,CAAC,UACH,OAAO,iEAAQ,WAAY,IAAI,oEAAU,WAAY,OAAO,QAAO;CAErE,OAAO,gEAAQ,WAAa,UAAU,OAAO;;AAG/C,SAAS,oBAIP,OACA,UAC8B;;CAC9B,MAAM,cAAc,MAAM,aAAa,CAAC;CACxC,MAAM,0CAAe,MAAM,MAAM,8GAAY,KAAK,kFAAG,cAAa,EAAE;CACpE,MAAM,iBAAiB,MAAM,QAAQ,kBAAkB;CAEvD,MAAM,SAAuC,EAAE;CAC/C,KAAK,IAAI,IAAI,GAAG,IAAI,aAAa,QAAQ,KAAK;EAC5C,MAAM,QAAQ,aAAa;EAC3B,IAAI;EACJ,IAAI,gBAAgB;GAGlB,MAAM,UAAU,MAAM,OAAO,OAAO,KAAK;GACzC,IAAI,4BAA4B,QAAQ,EAAE,MAAM;SAGhD,MAAM,YAAY,MAAM,MAAM,EAAE,OAAO,MAAM;EAE/C,IAAI,CAAC,KACH;EAED,AAAC,IAAY,WAAW;EACzB,OAAO,KAAK,IAAI;;CAElB,OAAO;;;;;;;;;;;;;AAcT,SAAgB,iBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,MAAM;;;;;;;;;;;;;AAc1C,SAAgB,oBAGd,OAAuE;CACvE,OAAO,oBAAoB,OAAO,SAAS;;;;;;;;;;;;;AAc7C,SAAgB,oBAGd,OAAuE;;CACvE,MAAM,EAAE,KAAK,sCACX,MAAM,MAAM,4FAAY,KAAK,KAAI,2BAA2B;CAC9D,MAAM,UAAU,MAAM,aAAa,CAAC;CAEpC,MAAM,eAAe,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,OAAO,CAAC;CACjD,OAAO,QAAQ,QAAQ,MAAM,CAAC,aAAa,IAAI,EAAE,GAAG,CAAC;;;;;;;;;;;;;AAgBvD,SAAgB,cAGd,KAAqC;CACrC,MAAM,EAAE,qBAAqB,IAAI,MAAM;CACvC,IAAI,OAAO,qBAAqB,YAC9B,OAAO,iBAAiB,IAAI;CAE9B,OAAO,oBAAoB;;;;;;;;;;;;;AAc7B,SAAgB,gBAGd,KAAgD;;CAChD,MAAM,EAAE,KAAK,qCACX,IAAI,MAAM,MAAM,0FAAY,KAAK,KAAI,2BAA2B;CAElE,OAAO,IAAI,SAAS,IAAI,GAAG,GACvB,QACA,OAAO,SAAS,IAAI,GAAG,GACrB,WACA;;;;;;;;;;;;AAaR,SAAgB,mBAGd,KAAoC;CACpC,MAAM,WAAW,gBAAgB,IAAI;CACrC,IAAI,CAAC,UAAU,OAAO;CAQtB,QALE,aAAa,QACT,mBAAmB,IAAI,OAAO,cAAc,iBAAiB,GAC7D,mBAAmB,IAAI,OAAO,iBAAiB,oBAAoB,EACvE,KAAK,EAAE,SAAS,GAEQ,CAAC,QAAQ,IAAI,GAAG;;;;;;;;;;;;;AAc5C,SAAgB,QACd,KACA,UACA,iBACA,mBACM;CACN,MAAM,aAAa,kBACf,IAAI,aAAa,CAAC,KAAK,EAAE,SAAS,GAAG,GACrC,EAAE;CACN,MAAM,eAAe,oBACjB,IAAI,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,GACvC,EAAE;CACN,MAAM,SAAsB,IAAI,IAAI;EAAC,GAAG;EAAc,IAAI;EAAI,GAAG;EAAW,CAAC;CAE7E,oBAAoB,IAAI,QAAQ,QAAQ;EACtC,IAAI,aAAa,UACf,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,CACN,GAAG,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAC3C,GAAG,MAAM,KAAK,OAAO,CACtB;GACF;EAGH,IAAI,aAAa,OACf,OAAO;GACL,KAAK,CAAC,GAAG,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,MAAM,KAAK,OAAO,CAAC;GACtE,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;EAGH,OAAO;GACL,KAAK,IAAI,IAAI,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GAC1C,QAAQ,IAAI,OAAO,QAAQ,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC;GACjD;GACD"}

package/dist/features/row-selection/rowSelectionFeature.types.d.cts

@@ -10,18 +10,22 @@ interface TableState_RowSelection {
 }
 interface TableOptions_RowSelection<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * - Enables/disables multiple row selection for all rows in the table OR
-   * - A function that given a row, returns whether to enable/disable multiple row selection for that row's children/grandchildren
+   * Allows rows to be selected alongside other rows.
+   *
+   * Provide a predicate to decide per row. Defaults to `true`.
    */
   enableMultiRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
-   * - Enables/disables row selection for all rows in the table OR
-   * - A function that given a row, returns whether to enable/disable row selection for that row
+   * Allows rows to be selected.
+   *
+   * Provide a predicate to decide per row. Defaults to `true`.
    */
   enableRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
-   * Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row.
-   * (Use in combination with expanding or grouping features)
+   * Controls whether selecting a parent row also selects its subRows.
+   *
+   * Provide a predicate to decide per row. This is most useful with expanding or
+   * grouping features and defaults to `true`.
    */
   enableSubRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
@@ -33,31 +37,31 @@ interface TableOptions_RowSelection<TFeatures extends TableFeatures, TData exten
 }
 interface Row_RowSelection {
   /**
-   * Returns whether or not the row can multi-select.
+   * Checks whether this row can be selected alongside other rows.
    */
   getCanMultiSelect: () => boolean;
   /**
-   * Returns whether or not the row can be selected.
+   * Checks whether this row can currently be selected.
    */
   getCanSelect: () => boolean;
   /**
-   * Returns whether or not the row can select sub rows automatically when the parent row is selected.
+   * Checks whether selecting this row should also select its subRows.
    */
   getCanSelectSubRows: () => boolean;
   /**
-   * Returns whether or not all of the row's sub rows are selected.
+   * Checks whether all selectable descendants are selected.
    */
   getIsAllSubRowsSelected: () => boolean;
   /**
-   * Returns whether or not the row is selected.
+   * Checks whether this row id is selected.
    */
   getIsSelected: () => boolean;
   /**
-   * Returns whether or not some of the row's sub rows are selected.
+   * Checks whether some selectable descendants are selected.
    */
   getIsSomeSelected: () => boolean;
   /**
-   * Returns a handler that can be used to toggle the row.
+   * Creates a checkbox-style handler that toggles this row's selected state.
    */
   getToggleSelectedHandler: () => (event: unknown) => void;
   /**
@@ -69,27 +73,27 @@ interface Row_RowSelection {
 }
 interface Table_RowSelection<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model of all rows that are selected after filtering has been applied.
+   * Builds a selected-row model from rows after filtering.
    */
   getFilteredSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model of all rows that are selected after grouping has been applied.
+   * Builds a selected-row model from rows after grouping.
    */
   getGroupedSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns whether or not all rows on the current page are selected.
+   * Checks whether every selectable row on the current page is selected.
    */
   getIsAllPageRowsSelected: () => boolean;
   /**
-   * Returns whether or not all rows in the table are selected.
+   * Checks whether every selectable filtered row is selected.
    */
   getIsAllRowsSelected: () => boolean;
   /**
-   * Returns whether or not any rows on the current page are selected.
+   * Checks whether the current page has a partial row selection.
    */
   getIsSomePageRowsSelected: () => boolean;
   /**
-   * Returns whether or not any rows in the table are selected.
+   * Checks whether filtered rows have a partial row selection.
    */
   getIsSomeRowsSelected: () => boolean;
   /**
@@ -97,23 +101,25 @@ interface Table_RowSelection<TFeatures extends TableFeatures, TData extends RowD
    */
   getPreSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model of all rows that are selected.
+   * Builds a selected-row model from the core row model.
    */
   getSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns a handler that can be used to toggle all rows on the current page.
+   * Creates a checkbox-style handler that toggles all current-page rows.
    */
   getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void;
   /**
-   * Returns a handler that can be used to toggle all rows in the table.
+   * Creates a checkbox-style handler that toggles all selectable rows.
    */
   getToggleAllRowsSelectedHandler: () => (event: unknown) => void;
   /**
-   * Resets the **rowSelection** state to the `initialState.rowSelection`, or `true` can be passed to force a default blank state reset to `{}`.
+   * Resets `rowSelection` to `initialState.rowSelection`.
+   *
+   * Pass `true` to ignore initial state and reset to `{}`.
    */
   resetRowSelection: (defaultState?: boolean) => void;
   /**
-   * Sets row selection state using a value or updater.
+   * Updates row selection state with a next map or updater function.
    */
   setRowSelection: (updater: Updater<RowSelectionState>) => void;
   /**

package/dist/features/row-selection/rowSelectionFeature.types.d.ts

@@ -10,18 +10,22 @@ interface TableState_RowSelection {
 }
 interface TableOptions_RowSelection<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * - Enables/disables multiple row selection for all rows in the table OR
-   * - A function that given a row, returns whether to enable/disable multiple row selection for that row's children/grandchildren
+   * Allows rows to be selected alongside other rows.
+   *
+   * Provide a predicate to decide per row. Defaults to `true`.
    */
   enableMultiRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
-   * - Enables/disables row selection for all rows in the table OR
-   * - A function that given a row, returns whether to enable/disable row selection for that row
+   * Allows rows to be selected.
+   *
+   * Provide a predicate to decide per row. Defaults to `true`.
    */
   enableRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
-   * Enables/disables automatic sub-row selection when a parent row is selected, or a function that enables/disables automatic sub-row selection for each row.
-   * (Use in combination with expanding or grouping features)
+   * Controls whether selecting a parent row also selects its subRows.
+   *
+   * Provide a predicate to decide per row. This is most useful with expanding or
+   * grouping features and defaults to `true`.
    */
   enableSubRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
@@ -33,31 +37,31 @@ interface TableOptions_RowSelection<TFeatures extends TableFeatures, TData exten
 }
 interface Row_RowSelection {
   /**
-   * Returns whether or not the row can multi-select.
+   * Checks whether this row can be selected alongside other rows.
    */
   getCanMultiSelect: () => boolean;
   /**
-   * Returns whether or not the row can be selected.
+   * Checks whether this row can currently be selected.
    */
   getCanSelect: () => boolean;
   /**
-   * Returns whether or not the row can select sub rows automatically when the parent row is selected.
+   * Checks whether selecting this row should also select its subRows.
    */
   getCanSelectSubRows: () => boolean;
   /**
-   * Returns whether or not all of the row's sub rows are selected.
+   * Checks whether all selectable descendants are selected.
    */
   getIsAllSubRowsSelected: () => boolean;
   /**
-   * Returns whether or not the row is selected.
+   * Checks whether this row id is selected.
    */
   getIsSelected: () => boolean;
   /**
-   * Returns whether or not some of the row's sub rows are selected.
+   * Checks whether some selectable descendants are selected.
    */
   getIsSomeSelected: () => boolean;
   /**
-   * Returns a handler that can be used to toggle the row.
+   * Creates a checkbox-style handler that toggles this row's selected state.
    */
   getToggleSelectedHandler: () => (event: unknown) => void;
   /**
@@ -69,27 +73,27 @@ interface Row_RowSelection {
 }
 interface Table_RowSelection<TFeatures extends TableFeatures, TData extends RowData> {
   /**
-   * Returns the row model of all rows that are selected after filtering has been applied.
+   * Builds a selected-row model from rows after filtering.
    */
   getFilteredSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model of all rows that are selected after grouping has been applied.
+   * Builds a selected-row model from rows after grouping.
    */
   getGroupedSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns whether or not all rows on the current page are selected.
+   * Checks whether every selectable row on the current page is selected.
    */
   getIsAllPageRowsSelected: () => boolean;
   /**
-   * Returns whether or not all rows in the table are selected.
+   * Checks whether every selectable filtered row is selected.
    */
   getIsAllRowsSelected: () => boolean;
   /**
-   * Returns whether or not any rows on the current page are selected.
+   * Checks whether the current page has a partial row selection.
    */
   getIsSomePageRowsSelected: () => boolean;
   /**
-   * Returns whether or not any rows in the table are selected.
+   * Checks whether filtered rows have a partial row selection.
    */
   getIsSomeRowsSelected: () => boolean;
   /**
@@ -97,23 +101,25 @@ interface Table_RowSelection<TFeatures extends TableFeatures, TData extends RowD
    */
   getPreSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns the row model of all rows that are selected.
+   * Builds a selected-row model from the core row model.
    */
   getSelectedRowModel: () => RowModel<TFeatures, TData>;
   /**
-   * Returns a handler that can be used to toggle all rows on the current page.
+   * Creates a checkbox-style handler that toggles all current-page rows.
    */
   getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void;
   /**
-   * Returns a handler that can be used to toggle all rows in the table.
+   * Creates a checkbox-style handler that toggles all selectable rows.
    */
   getToggleAllRowsSelectedHandler: () => (event: unknown) => void;
   /**
-   * Resets the **rowSelection** state to the `initialState.rowSelection`, or `true` can be passed to force a default blank state reset to `{}`.
+   * Resets `rowSelection` to `initialState.rowSelection`.
+   *
+   * Pass `true` to ignore initial state and reset to `{}`.
    */
   resetRowSelection: (defaultState?: boolean) => void;
   /**
-   * Sets row selection state using a value or updater.
+   * Updates row selection state with a next map or updater function.
    */
   setRowSelection: (updater: Updater<RowSelectionState>) => void;
   /**