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

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\nexport function getDefaultRowPinningState(): RowPinningState {\n  return {\n    top: [],\n    bottom: [],\n  }\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\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\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\n  const rows =\n    (table.options.keepPinnedRows ?? true)\n      ? // get all rows that are pinned even if they would not be otherwise visible\n        // account for expanded parent rows, but not pagination or filtering\n        pinnedRowIds.map((rowId) => {\n          const row = table.getRow(rowId, true)\n          return row_getIsAllParentsExpanded(row) ? row : null\n        })\n      : // else get only visible rows that are pinned\n        pinnedRowIds.map(\n          (rowId) => visibleRows.find((row) => row.id === rowId)!,\n        )\n\n  const filteredRows = rows.filter((r) => !!r)\n  // Assign position property directly to preserve prototype chain\n  filteredRows.forEach((row) => {\n    ;(row as any).position = position\n  })\n  return filteredRows\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\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\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\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\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\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\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":";;;;AAaA,SAAgB,4BAA6C;AAC3D,QAAO;EACL,KAAK,EAAE;EACP,QAAQ,EAAE;EACX;;AAGH,SAAgB,oBAId,OACA,SACM;;AACN,kDAAM,SAAQ,+GAAqB,QAAQ;;AAG7C,SAAgB,sBAGd,OAAyC,cAA8B;AACvE,qBACE,OACA,eACI,2BAA2B,GAC3B,WACE,MAAM,aAAa,cAAc,2BAA2B,CAC7D,CACN;;AAKH,SAAgB,0BAId,OACA,UACS;;CACT,MAAM,sCAAa,MAAM,MAAM,0FAAY,KAAK;AAEhD,KAAI,CAAC,SACH,QAAO,iEAAQ,WAAY,IAAI,oEAAU,WAAY,OAAO,QAAO;AAErE,QAAO,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;CAepE,MAAM,gBAZH,MAAM,QAAQ,kBAAkB,OAG7B,aAAa,KAAK,UAAU;EAC1B,MAAM,MAAM,MAAM,OAAO,OAAO,KAAK;AACrC,SAAO,4BAA4B,IAAI,GAAG,MAAM;GAChD,GAEF,aAAa,KACV,UAAU,YAAY,MAAM,QAAQ,IAAI,OAAO,MAAM,CACvD,EAEmB,QAAQ,MAAM,CAAC,CAAC,EAAE;AAE5C,cAAa,SAAS,QAAQ;AAC3B,EAAC,IAAY,WAAW;GACzB;AACF,QAAO;;AAGT,SAAgB,iBAGd,OAAuE;AACvE,QAAO,oBAAoB,OAAO,MAAM;;AAG1C,SAAgB,oBAGd,OAAuE;AACvE,QAAO,oBAAoB,OAAO,SAAS;;AAG7C,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;AACjD,QAAO,QAAQ,QAAQ,MAAM,CAAC,aAAa,IAAI,EAAE,GAAG,CAAC;;AAKvD,SAAgB,cAGd,KAAqC;CACrC,MAAM,EAAE,qBAAqB,IAAI,MAAM;AACvC,KAAI,OAAO,qBAAqB,WAC9B,QAAO,iBAAiB,IAAI;AAE9B,QAAO,oBAAoB;;AAG7B,SAAgB,gBAGd,KAAgD;;CAChD,MAAM,EAAE,KAAK,qCACX,IAAI,MAAM,MAAM,0FAAY,KAAK,KAAI,2BAA2B;AAElE,QAAO,IAAI,SAAS,IAAI,GAAG,GACvB,QACA,OAAO,SAAS,IAAI,GAAG,GACrB,WACA;;AAGR,SAAgB,mBAGd,KAAoC;CACpC,MAAM,WAAW,gBAAgB,IAAI;AACrC,KAAI,CAAC,SAAU,QAAO;AAQtB,SALE,aAAa,QACT,mBAAmB,IAAI,OAAO,cAAc,iBAAiB,GAC7D,mBAAmB,IAAI,OAAO,iBAAiB,oBAAoB,EACvE,KAAK,EAAE,SAAS,GAEQ,CAAC,QAAQ,IAAI,GAAG;;AAG5C,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;AAE7E,qBAAoB,IAAI,QAAQ,QAAQ;AACtC,MAAI,aAAa,SACf,QAAO;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;AAGH,MAAI,aAAa,MACf,QAAO;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;AAGH,SAAO;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 * 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\n  const rows =\n    (table.options.keepPinnedRows ?? true)\n      ? // get all rows that are pinned even if they would not be otherwise visible\n        // account for expanded parent rows, but not pagination or filtering\n        pinnedRowIds.map((rowId) => {\n          const row = table.getRow(rowId, true)\n          return row_getIsAllParentsExpanded(row) ? row : null\n        })\n      : // else get only visible rows that are pinned\n        pinnedRowIds.map(\n          (rowId) => visibleRows.find((row) => row.id === rowId)!,\n        )\n\n  const filteredRows = rows.filter((r) => !!r)\n  // Assign position property directly to preserve prototype chain\n  filteredRows.forEach((row) => {\n    ;(row as any).position = position\n  })\n  return filteredRows\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;CAepE,MAAM,gBAZH,MAAM,QAAQ,kBAAkB,OAG7B,aAAa,KAAK,UAAU;EAC1B,MAAM,MAAM,MAAM,OAAO,OAAO,KAAK;EACrC,OAAO,4BAA4B,IAAI,GAAG,MAAM;GAChD,GAEF,aAAa,KACV,UAAU,YAAY,MAAM,QAAQ,IAAI,OAAO,MAAM,CACvD,EAEmB,QAAQ,MAAM,CAAC,CAAC,EAAE;CAE5C,aAAa,SAAS,QAAQ;EAC3B,AAAC,IAAY,WAAW;GACzB;CACF,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"}

package/dist/features/row-selection/rowSelectionFeature.cjs

@@ -2,6 +2,11 @@ const require_utils = require('../../utils.cjs');
 const require_rowSelectionFeature_utils = require('./rowSelectionFeature.utils.cjs');
 
 //#region src/features/row-selection/rowSelectionFeature.ts
+/**
+* Creates the stock row selection feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructRowSelectionFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -69,7 +74,10 @@ function constructRowSelectionFeature() {
 	};
 }
 /**
-* The Row Selection feature adds row selection state and APIs to the table and row objects.
+* The stock row selection feature.
+*
+* Register this feature to add row selection state, selected row-model helpers,
+* and table/row APIs for checkbox and bulk-selection UI.
 */
 const rowSelectionFeature = constructRowSelectionFeature();
 

package/dist/features/row-selection/rowSelectionFeature.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"rowSelectionFeature.cjs","names":["getDefaultRowSelectionState","makeStateUpdater","row_toggleSelected","row_getIsSelected","row_getIsSomeSelected","row_getIsAllSubRowsSelected","row_getCanSelect","row_getCanSelectSubRows","row_getCanMultiSelect","row_getToggleSelectedHandler","table_setRowSelection","table_resetRowSelection","table_toggleAllRowsSelected","table_toggleAllPageRowsSelected","table_getPreSelectedRowModel","table_getSelectedRowModel","table_getFilteredSelectedRowModel","table_getGroupedSelectedRowModel","table_getIsAllRowsSelected","table_getIsAllPageRowsSelected","table_getIsSomeRowsSelected","table_getIsSomePageRowsSelected","table_getToggleAllRowsSelectedHandler","table_getToggleAllPageRowsSelectedHandler"],"sources":["../../../src/features/row-selection/rowSelectionFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  getDefaultRowSelectionState,\n  row_getCanMultiSelect,\n  row_getCanSelect,\n  row_getCanSelectSubRows,\n  row_getIsAllSubRowsSelected,\n  row_getIsSelected,\n  row_getIsSomeSelected,\n  row_getToggleSelectedHandler,\n  row_toggleSelected,\n  table_getFilteredSelectedRowModel,\n  table_getGroupedSelectedRowModel,\n  table_getIsAllPageRowsSelected,\n  table_getIsAllRowsSelected,\n  table_getIsSomePageRowsSelected,\n  table_getIsSomeRowsSelected,\n  table_getPreSelectedRowModel,\n  table_getSelectedRowModel,\n  table_getToggleAllPageRowsSelectedHandler,\n  table_getToggleAllRowsSelectedHandler,\n  table_resetRowSelection,\n  table_setRowSelection,\n  table_toggleAllPageRowsSelected,\n  table_toggleAllRowsSelected,\n} from './rowSelectionFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Row_RowSelection,\n//   TableOptions_RowSelection,\n//   TableState_RowSelection,\n//   Table_RowSelection,\n// } from './rowSelectionFeature.types'\n\nexport interface RowSelectionFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Row: Row_RowSelection\n  // Table: Table_RowSelection<TFeatures, TData>\n  // TableOptions: TableOptions_RowSelection<TFeatures, TData>\n  // TableState: TableState_RowSelection\n}\n\nexport function constructRowSelectionFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        rowSelection: getDefaultRowSelectionState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onRowSelectionChange: makeStateUpdater('rowSelection', table),\n        enableRowSelection: true,\n        enableMultiRowSelection: true,\n        enableSubRowSelection: true,\n      }\n    },\n\n    assignRowPrototype: (prototype, table) => {\n      assignPrototypeAPIs('rowSelectionFeature', prototype, table, {\n        row_toggleSelected: {\n          fn: (row, value, opts) => row_toggleSelected(row, value, opts),\n        },\n        row_getIsSelected: {\n          fn: (row) => row_getIsSelected(row),\n        },\n        row_getIsSomeSelected: {\n          fn: (row) => row_getIsSomeSelected(row),\n        },\n        row_getIsAllSubRowsSelected: {\n          fn: (row) => row_getIsAllSubRowsSelected(row),\n        },\n        row_getCanSelect: {\n          fn: (row) => row_getCanSelect(row),\n        },\n        row_getCanSelectSubRows: {\n          fn: (row) => row_getCanSelectSubRows(row),\n        },\n        row_getCanMultiSelect: {\n          fn: (row) => row_getCanMultiSelect(row),\n        },\n        row_getToggleSelectedHandler: {\n          fn: (row) => row_getToggleSelectedHandler(row),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('rowSelectionFeature', table, {\n        table_setRowSelection: {\n          fn: (updater) => table_setRowSelection(table, updater),\n        },\n        table_resetRowSelection: {\n          fn: (defaultState) => table_resetRowSelection(table, defaultState),\n        },\n        table_toggleAllRowsSelected: {\n          fn: (value) => table_toggleAllRowsSelected(table, value),\n        },\n        table_toggleAllPageRowsSelected: {\n          fn: (value) => table_toggleAllPageRowsSelected(table, value),\n        },\n        table_getPreSelectedRowModel: {\n          fn: () => table_getPreSelectedRowModel(table),\n        },\n        table_getSelectedRowModel: {\n          fn: () => table_getSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getCoreRowModel(),\n          ],\n        },\n        table_getFilteredSelectedRowModel: {\n          fn: () => table_getFilteredSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getFilteredRowModel(),\n          ],\n        },\n        table_getGroupedSelectedRowModel: {\n          fn: () => table_getGroupedSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getSortedRowModel(),\n          ],\n        },\n        table_getIsAllRowsSelected: {\n          fn: () => table_getIsAllRowsSelected(table),\n        },\n        table_getIsAllPageRowsSelected: {\n          fn: () => table_getIsAllPageRowsSelected(table),\n        },\n        table_getIsSomeRowsSelected: {\n          fn: () => table_getIsSomeRowsSelected(table),\n        },\n        table_getIsSomePageRowsSelected: {\n          fn: () => table_getIsSomePageRowsSelected(table),\n        },\n        table_getToggleAllRowsSelectedHandler: {\n          fn: () => table_getToggleAllRowsSelectedHandler(table),\n        },\n        table_getToggleAllPageRowsSelectedHandler: {\n          fn: () => table_getToggleAllPageRowsSelectedHandler(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Row Selection feature adds row selection state and APIs to the table and row objects.\n */\nexport const rowSelectionFeature = constructRowSelectionFeature()\n"],"mappings":";;;;AAiDA,SAAgB,+BAGqD;AACnE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,cAAcA,+DAA6B;IAC3C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO;IACL,sBAAsBC,+BAAiB,gBAAgB,MAAM;IAC7D,oBAAoB;IACpB,yBAAyB;IACzB,uBAAuB;IACxB;;EAGH,qBAAqB,WAAW,UAAU;AACxC,qCAAoB,uBAAuB,WAAW,OAAO;IAC3D,oBAAoB,EAClB,KAAK,KAAK,OAAO,SAASC,qDAAmB,KAAK,OAAO,KAAK,EAC/D;IACD,mBAAmB,EACjB,KAAK,QAAQC,oDAAkB,IAAI,EACpC;IACD,uBAAuB,EACrB,KAAK,QAAQC,wDAAsB,IAAI,EACxC;IACD,6BAA6B,EAC3B,KAAK,QAAQC,8DAA4B,IAAI,EAC9C;IACD,kBAAkB,EAChB,KAAK,QAAQC,mDAAiB,IAAI,EACnC;IACD,yBAAyB,EACvB,KAAK,QAAQC,0DAAwB,IAAI,EAC1C;IACD,uBAAuB,EACrB,KAAK,QAAQC,wDAAsB,IAAI,EACxC;IACD,8BAA8B,EAC5B,KAAK,QAAQC,+DAA6B,IAAI,EAC/C;IACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,iCAAgB,uBAAuB,OAAO;IAC5C,uBAAuB,EACrB,KAAK,YAAYC,wDAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiBC,0DAAwB,OAAO,aAAa,EACnE;IACD,6BAA6B,EAC3B,KAAK,UAAUC,8DAA4B,OAAO,MAAM,EACzD;IACD,iCAAiC,EAC/B,KAAK,UAAUC,kEAAgC,OAAO,MAAM,EAC7D;IACD,8BAA8B,EAC5B,UAAUC,+DAA6B,MAAM,EAC9C;IACD,2BAA2B;KACzB,UAAUC,4DAA0B,MAAM;KAC1C,gBAAgB;;uCACd,MAAM,MAAM,4FAAc,KAAK,EAC/B,MAAM,iBAAiB,CACxB;;KACF;IACD,mCAAmC;KACjC,UAAUC,oEAAkC,MAAM;KAClD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,qBAAqB,CAC5B;;KACF;IACD,kCAAkC;KAChC,UAAUC,mEAAiC,MAAM;KACjD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,mBAAmB,CAC1B;;KACF;IACD,4BAA4B,EAC1B,UAAUC,6DAA2B,MAAM,EAC5C;IACD,gCAAgC,EAC9B,UAAUC,iEAA+B,MAAM,EAChD;IACD,6BAA6B,EAC3B,UAAUC,8DAA4B,MAAM,EAC7C;IACD,iCAAiC,EAC/B,UAAUC,kEAAgC,MAAM,EACjD;IACD,uCAAuC,EACrC,UAAUC,wEAAsC,MAAM,EACvD;IACD,2CAA2C,EACzC,UAAUC,4EAA0C,MAAM,EAC3D;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,sBAAsB,8BAA8B"}
+{"version":3,"file":"rowSelectionFeature.cjs","names":["getDefaultRowSelectionState","makeStateUpdater","row_toggleSelected","row_getIsSelected","row_getIsSomeSelected","row_getIsAllSubRowsSelected","row_getCanSelect","row_getCanSelectSubRows","row_getCanMultiSelect","row_getToggleSelectedHandler","table_setRowSelection","table_resetRowSelection","table_toggleAllRowsSelected","table_toggleAllPageRowsSelected","table_getPreSelectedRowModel","table_getSelectedRowModel","table_getFilteredSelectedRowModel","table_getGroupedSelectedRowModel","table_getIsAllRowsSelected","table_getIsAllPageRowsSelected","table_getIsSomeRowsSelected","table_getIsSomePageRowsSelected","table_getToggleAllRowsSelectedHandler","table_getToggleAllPageRowsSelectedHandler"],"sources":["../../../src/features/row-selection/rowSelectionFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  getDefaultRowSelectionState,\n  row_getCanMultiSelect,\n  row_getCanSelect,\n  row_getCanSelectSubRows,\n  row_getIsAllSubRowsSelected,\n  row_getIsSelected,\n  row_getIsSomeSelected,\n  row_getToggleSelectedHandler,\n  row_toggleSelected,\n  table_getFilteredSelectedRowModel,\n  table_getGroupedSelectedRowModel,\n  table_getIsAllPageRowsSelected,\n  table_getIsAllRowsSelected,\n  table_getIsSomePageRowsSelected,\n  table_getIsSomeRowsSelected,\n  table_getPreSelectedRowModel,\n  table_getSelectedRowModel,\n  table_getToggleAllPageRowsSelectedHandler,\n  table_getToggleAllRowsSelectedHandler,\n  table_resetRowSelection,\n  table_setRowSelection,\n  table_toggleAllPageRowsSelected,\n  table_toggleAllRowsSelected,\n} from './rowSelectionFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Row_RowSelection,\n//   TableOptions_RowSelection,\n//   TableState_RowSelection,\n//   Table_RowSelection,\n// } from './rowSelectionFeature.types'\n\nexport interface RowSelectionFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Row: Row_RowSelection\n  // Table: Table_RowSelection<TFeatures, TData>\n  // TableOptions: TableOptions_RowSelection<TFeatures, TData>\n  // TableState: TableState_RowSelection\n}\n\n/**\n * Creates the stock row selection 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 constructRowSelectionFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        rowSelection: getDefaultRowSelectionState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onRowSelectionChange: makeStateUpdater('rowSelection', table),\n        enableRowSelection: true,\n        enableMultiRowSelection: true,\n        enableSubRowSelection: true,\n      }\n    },\n\n    assignRowPrototype: (prototype, table) => {\n      assignPrototypeAPIs('rowSelectionFeature', prototype, table, {\n        row_toggleSelected: {\n          fn: (row, value, opts) => row_toggleSelected(row, value, opts),\n        },\n        row_getIsSelected: {\n          fn: (row) => row_getIsSelected(row),\n        },\n        row_getIsSomeSelected: {\n          fn: (row) => row_getIsSomeSelected(row),\n        },\n        row_getIsAllSubRowsSelected: {\n          fn: (row) => row_getIsAllSubRowsSelected(row),\n        },\n        row_getCanSelect: {\n          fn: (row) => row_getCanSelect(row),\n        },\n        row_getCanSelectSubRows: {\n          fn: (row) => row_getCanSelectSubRows(row),\n        },\n        row_getCanMultiSelect: {\n          fn: (row) => row_getCanMultiSelect(row),\n        },\n        row_getToggleSelectedHandler: {\n          fn: (row) => row_getToggleSelectedHandler(row),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('rowSelectionFeature', table, {\n        table_setRowSelection: {\n          fn: (updater) => table_setRowSelection(table, updater),\n        },\n        table_resetRowSelection: {\n          fn: (defaultState) => table_resetRowSelection(table, defaultState),\n        },\n        table_toggleAllRowsSelected: {\n          fn: (value) => table_toggleAllRowsSelected(table, value),\n        },\n        table_toggleAllPageRowsSelected: {\n          fn: (value) => table_toggleAllPageRowsSelected(table, value),\n        },\n        table_getPreSelectedRowModel: {\n          fn: () => table_getPreSelectedRowModel(table),\n        },\n        table_getSelectedRowModel: {\n          fn: () => table_getSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getCoreRowModel(),\n          ],\n        },\n        table_getFilteredSelectedRowModel: {\n          fn: () => table_getFilteredSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getFilteredRowModel(),\n          ],\n        },\n        table_getGroupedSelectedRowModel: {\n          fn: () => table_getGroupedSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getSortedRowModel(),\n          ],\n        },\n        table_getIsAllRowsSelected: {\n          fn: () => table_getIsAllRowsSelected(table),\n        },\n        table_getIsAllPageRowsSelected: {\n          fn: () => table_getIsAllPageRowsSelected(table),\n        },\n        table_getIsSomeRowsSelected: {\n          fn: () => table_getIsSomeRowsSelected(table),\n        },\n        table_getIsSomePageRowsSelected: {\n          fn: () => table_getIsSomePageRowsSelected(table),\n        },\n        table_getToggleAllRowsSelectedHandler: {\n          fn: () => table_getToggleAllRowsSelectedHandler(table),\n        },\n        table_getToggleAllPageRowsSelectedHandler: {\n          fn: () => table_getToggleAllPageRowsSelectedHandler(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock row selection feature.\n *\n * Register this feature to add row selection state, selected row-model helpers,\n * and table/row APIs for checkbox and bulk-selection UI.\n */\nexport const rowSelectionFeature = constructRowSelectionFeature()\n"],"mappings":";;;;;;;;;AAsDA,SAAgB,+BAGqD;CACnE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,cAAcA,+DAA6B;IAC3C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO;IACL,sBAAsBC,+BAAiB,gBAAgB,MAAM;IAC7D,oBAAoB;IACpB,yBAAyB;IACzB,uBAAuB;IACxB;;EAGH,qBAAqB,WAAW,UAAU;GACxC,kCAAoB,uBAAuB,WAAW,OAAO;IAC3D,oBAAoB,EAClB,KAAK,KAAK,OAAO,SAASC,qDAAmB,KAAK,OAAO,KAAK,EAC/D;IACD,mBAAmB,EACjB,KAAK,QAAQC,oDAAkB,IAAI,EACpC;IACD,uBAAuB,EACrB,KAAK,QAAQC,wDAAsB,IAAI,EACxC;IACD,6BAA6B,EAC3B,KAAK,QAAQC,8DAA4B,IAAI,EAC9C;IACD,kBAAkB,EAChB,KAAK,QAAQC,mDAAiB,IAAI,EACnC;IACD,yBAAyB,EACvB,KAAK,QAAQC,0DAAwB,IAAI,EAC1C;IACD,uBAAuB,EACrB,KAAK,QAAQC,wDAAsB,IAAI,EACxC;IACD,8BAA8B,EAC5B,KAAK,QAAQC,+DAA6B,IAAI,EAC/C;IACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,8BAAgB,uBAAuB,OAAO;IAC5C,uBAAuB,EACrB,KAAK,YAAYC,wDAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiBC,0DAAwB,OAAO,aAAa,EACnE;IACD,6BAA6B,EAC3B,KAAK,UAAUC,8DAA4B,OAAO,MAAM,EACzD;IACD,iCAAiC,EAC/B,KAAK,UAAUC,kEAAgC,OAAO,MAAM,EAC7D;IACD,8BAA8B,EAC5B,UAAUC,+DAA6B,MAAM,EAC9C;IACD,2BAA2B;KACzB,UAAUC,4DAA0B,MAAM;KAC1C,gBAAgB;;uCACd,MAAM,MAAM,4FAAc,KAAK,EAC/B,MAAM,iBAAiB,CACxB;;KACF;IACD,mCAAmC;KACjC,UAAUC,oEAAkC,MAAM;KAClD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,qBAAqB,CAC5B;;KACF;IACD,kCAAkC;KAChC,UAAUC,mEAAiC,MAAM;KACjD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,mBAAmB,CAC1B;;KACF;IACD,4BAA4B,EAC1B,UAAUC,6DAA2B,MAAM,EAC5C;IACD,gCAAgC,EAC9B,UAAUC,iEAA+B,MAAM,EAChD;IACD,6BAA6B,EAC3B,UAAUC,8DAA4B,MAAM,EAC7C;IACD,iCAAiC,EAC/B,UAAUC,kEAAgC,MAAM,EACjD;IACD,uCAAuC,EACrC,UAAUC,wEAAsC,MAAM,EACvD;IACD,2CAA2C,EACzC,UAAUC,4EAA0C,MAAM,EAC3D;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,sBAAsB,8BAA8B"}

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

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.cjs";
 
 //#region src/features/row-selection/rowSelectionFeature.d.ts
 interface RowSelectionFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock row selection feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructRowSelectionFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>>;
 /**
- * The Row Selection feature adds row selection state and APIs to the table and row objects.
+ * The stock row selection feature.
+ *
+ * Register this feature to add row selection state, selected row-model helpers,
+ * and table/row APIs for checkbox and bulk-selection UI.
  */
 declare const rowSelectionFeature: TableFeature<RowSelectionFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

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

@@ -3,9 +3,17 @@ import { TableFeature, TableFeatures } from "../../types/TableFeatures.js";
 
 //#region src/features/row-selection/rowSelectionFeature.d.ts
 interface RowSelectionFeatureConstructors<TFeatures extends TableFeatures, TData extends RowData> {}
+/**
+ * Creates the stock row selection feature.
+ *
+ * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ */
 declare function constructRowSelectionFeature<TFeatures extends TableFeatures, TData extends RowData>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>>;
 /**
- * The Row Selection feature adds row selection state and APIs to the table and row objects.
+ * The stock row selection feature.
+ *
+ * Register this feature to add row selection state, selected row-model helpers,
+ * and table/row APIs for checkbox and bulk-selection UI.
  */
 declare const rowSelectionFeature: TableFeature<RowSelectionFeatureConstructors<TableFeatures, RowData>>;
 //#endregion

package/dist/features/row-selection/rowSelectionFeature.js

@@ -2,6 +2,11 @@ import { assignPrototypeAPIs, assignTableAPIs, makeStateUpdater } from "../../ut
 import { getDefaultRowSelectionState, row_getCanMultiSelect, row_getCanSelect, row_getCanSelectSubRows, row_getIsAllSubRowsSelected, row_getIsSelected, row_getIsSomeSelected, row_getToggleSelectedHandler, row_toggleSelected, table_getFilteredSelectedRowModel, table_getGroupedSelectedRowModel, table_getIsAllPageRowsSelected, table_getIsAllRowsSelected, table_getIsSomePageRowsSelected, table_getIsSomeRowsSelected, table_getPreSelectedRowModel, table_getSelectedRowModel, table_getToggleAllPageRowsSelectedHandler, table_getToggleAllRowsSelectedHandler, table_resetRowSelection, table_setRowSelection, table_toggleAllPageRowsSelected, table_toggleAllRowsSelected } from "./rowSelectionFeature.utils.js";
 
 //#region src/features/row-selection/rowSelectionFeature.ts
+/**
+* Creates the stock row selection feature.
+*
+* The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+*/
 function constructRowSelectionFeature() {
 	return {
 		getInitialState: (initialState) => {
@@ -69,7 +74,10 @@ function constructRowSelectionFeature() {
 	};
 }
 /**
-* The Row Selection feature adds row selection state and APIs to the table and row objects.
+* The stock row selection feature.
+*
+* Register this feature to add row selection state, selected row-model helpers,
+* and table/row APIs for checkbox and bulk-selection UI.
 */
 const rowSelectionFeature = constructRowSelectionFeature();
 

package/dist/features/row-selection/rowSelectionFeature.js.map

@@ -1 +1 @@
-{"version":3,"file":"rowSelectionFeature.js","names":[],"sources":["../../../src/features/row-selection/rowSelectionFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  getDefaultRowSelectionState,\n  row_getCanMultiSelect,\n  row_getCanSelect,\n  row_getCanSelectSubRows,\n  row_getIsAllSubRowsSelected,\n  row_getIsSelected,\n  row_getIsSomeSelected,\n  row_getToggleSelectedHandler,\n  row_toggleSelected,\n  table_getFilteredSelectedRowModel,\n  table_getGroupedSelectedRowModel,\n  table_getIsAllPageRowsSelected,\n  table_getIsAllRowsSelected,\n  table_getIsSomePageRowsSelected,\n  table_getIsSomeRowsSelected,\n  table_getPreSelectedRowModel,\n  table_getSelectedRowModel,\n  table_getToggleAllPageRowsSelectedHandler,\n  table_getToggleAllRowsSelectedHandler,\n  table_resetRowSelection,\n  table_setRowSelection,\n  table_toggleAllPageRowsSelected,\n  table_toggleAllRowsSelected,\n} from './rowSelectionFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Row_RowSelection,\n//   TableOptions_RowSelection,\n//   TableState_RowSelection,\n//   Table_RowSelection,\n// } from './rowSelectionFeature.types'\n\nexport interface RowSelectionFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Row: Row_RowSelection\n  // Table: Table_RowSelection<TFeatures, TData>\n  // TableOptions: TableOptions_RowSelection<TFeatures, TData>\n  // TableState: TableState_RowSelection\n}\n\nexport function constructRowSelectionFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        rowSelection: getDefaultRowSelectionState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onRowSelectionChange: makeStateUpdater('rowSelection', table),\n        enableRowSelection: true,\n        enableMultiRowSelection: true,\n        enableSubRowSelection: true,\n      }\n    },\n\n    assignRowPrototype: (prototype, table) => {\n      assignPrototypeAPIs('rowSelectionFeature', prototype, table, {\n        row_toggleSelected: {\n          fn: (row, value, opts) => row_toggleSelected(row, value, opts),\n        },\n        row_getIsSelected: {\n          fn: (row) => row_getIsSelected(row),\n        },\n        row_getIsSomeSelected: {\n          fn: (row) => row_getIsSomeSelected(row),\n        },\n        row_getIsAllSubRowsSelected: {\n          fn: (row) => row_getIsAllSubRowsSelected(row),\n        },\n        row_getCanSelect: {\n          fn: (row) => row_getCanSelect(row),\n        },\n        row_getCanSelectSubRows: {\n          fn: (row) => row_getCanSelectSubRows(row),\n        },\n        row_getCanMultiSelect: {\n          fn: (row) => row_getCanMultiSelect(row),\n        },\n        row_getToggleSelectedHandler: {\n          fn: (row) => row_getToggleSelectedHandler(row),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('rowSelectionFeature', table, {\n        table_setRowSelection: {\n          fn: (updater) => table_setRowSelection(table, updater),\n        },\n        table_resetRowSelection: {\n          fn: (defaultState) => table_resetRowSelection(table, defaultState),\n        },\n        table_toggleAllRowsSelected: {\n          fn: (value) => table_toggleAllRowsSelected(table, value),\n        },\n        table_toggleAllPageRowsSelected: {\n          fn: (value) => table_toggleAllPageRowsSelected(table, value),\n        },\n        table_getPreSelectedRowModel: {\n          fn: () => table_getPreSelectedRowModel(table),\n        },\n        table_getSelectedRowModel: {\n          fn: () => table_getSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getCoreRowModel(),\n          ],\n        },\n        table_getFilteredSelectedRowModel: {\n          fn: () => table_getFilteredSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getFilteredRowModel(),\n          ],\n        },\n        table_getGroupedSelectedRowModel: {\n          fn: () => table_getGroupedSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getSortedRowModel(),\n          ],\n        },\n        table_getIsAllRowsSelected: {\n          fn: () => table_getIsAllRowsSelected(table),\n        },\n        table_getIsAllPageRowsSelected: {\n          fn: () => table_getIsAllPageRowsSelected(table),\n        },\n        table_getIsSomeRowsSelected: {\n          fn: () => table_getIsSomeRowsSelected(table),\n        },\n        table_getIsSomePageRowsSelected: {\n          fn: () => table_getIsSomePageRowsSelected(table),\n        },\n        table_getToggleAllRowsSelectedHandler: {\n          fn: () => table_getToggleAllRowsSelectedHandler(table),\n        },\n        table_getToggleAllPageRowsSelectedHandler: {\n          fn: () => table_getToggleAllPageRowsSelectedHandler(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The Row Selection feature adds row selection state and APIs to the table and row objects.\n */\nexport const rowSelectionFeature = constructRowSelectionFeature()\n"],"mappings":";;;;AAiDA,SAAgB,+BAGqD;AACnE,QAAO;EACL,kBAAkB,iBAAiB;AACjC,UAAO;IACL,cAAc,6BAA6B;IAC3C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;AACjC,UAAO;IACL,sBAAsB,iBAAiB,gBAAgB,MAAM;IAC7D,oBAAoB;IACpB,yBAAyB;IACzB,uBAAuB;IACxB;;EAGH,qBAAqB,WAAW,UAAU;AACxC,uBAAoB,uBAAuB,WAAW,OAAO;IAC3D,oBAAoB,EAClB,KAAK,KAAK,OAAO,SAAS,mBAAmB,KAAK,OAAO,KAAK,EAC/D;IACD,mBAAmB,EACjB,KAAK,QAAQ,kBAAkB,IAAI,EACpC;IACD,uBAAuB,EACrB,KAAK,QAAQ,sBAAsB,IAAI,EACxC;IACD,6BAA6B,EAC3B,KAAK,QAAQ,4BAA4B,IAAI,EAC9C;IACD,kBAAkB,EAChB,KAAK,QAAQ,iBAAiB,IAAI,EACnC;IACD,yBAAyB,EACvB,KAAK,QAAQ,wBAAwB,IAAI,EAC1C;IACD,uBAAuB,EACrB,KAAK,QAAQ,sBAAsB,IAAI,EACxC;IACD,8BAA8B,EAC5B,KAAK,QAAQ,6BAA6B,IAAI,EAC/C;IACF,CAAC;;EAGJ,qBAAqB,UAAU;AAC7B,mBAAgB,uBAAuB,OAAO;IAC5C,uBAAuB,EACrB,KAAK,YAAY,sBAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiB,wBAAwB,OAAO,aAAa,EACnE;IACD,6BAA6B,EAC3B,KAAK,UAAU,4BAA4B,OAAO,MAAM,EACzD;IACD,iCAAiC,EAC/B,KAAK,UAAU,gCAAgC,OAAO,MAAM,EAC7D;IACD,8BAA8B,EAC5B,UAAU,6BAA6B,MAAM,EAC9C;IACD,2BAA2B;KACzB,UAAU,0BAA0B,MAAM;KAC1C,gBAAgB;;uCACd,MAAM,MAAM,4FAAc,KAAK,EAC/B,MAAM,iBAAiB,CACxB;;KACF;IACD,mCAAmC;KACjC,UAAU,kCAAkC,MAAM;KAClD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,qBAAqB,CAC5B;;KACF;IACD,kCAAkC;KAChC,UAAU,iCAAiC,MAAM;KACjD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,mBAAmB,CAC1B;;KACF;IACD,4BAA4B,EAC1B,UAAU,2BAA2B,MAAM,EAC5C;IACD,gCAAgC,EAC9B,UAAU,+BAA+B,MAAM,EAChD;IACD,6BAA6B,EAC3B,UAAU,4BAA4B,MAAM,EAC7C;IACD,iCAAiC,EAC/B,UAAU,gCAAgC,MAAM,EACjD;IACD,uCAAuC,EACrC,UAAU,sCAAsC,MAAM,EACvD;IACD,2CAA2C,EACzC,UAAU,0CAA0C,MAAM,EAC3D;IACF,CAAC;;EAEL;;;;;AAMH,MAAa,sBAAsB,8BAA8B"}
+{"version":3,"file":"rowSelectionFeature.js","names":[],"sources":["../../../src/features/row-selection/rowSelectionFeature.ts"],"sourcesContent":["import {\n  assignPrototypeAPIs,\n  assignTableAPIs,\n  makeStateUpdater,\n} from '../../utils'\nimport {\n  getDefaultRowSelectionState,\n  row_getCanMultiSelect,\n  row_getCanSelect,\n  row_getCanSelectSubRows,\n  row_getIsAllSubRowsSelected,\n  row_getIsSelected,\n  row_getIsSomeSelected,\n  row_getToggleSelectedHandler,\n  row_toggleSelected,\n  table_getFilteredSelectedRowModel,\n  table_getGroupedSelectedRowModel,\n  table_getIsAllPageRowsSelected,\n  table_getIsAllRowsSelected,\n  table_getIsSomePageRowsSelected,\n  table_getIsSomeRowsSelected,\n  table_getPreSelectedRowModel,\n  table_getSelectedRowModel,\n  table_getToggleAllPageRowsSelectedHandler,\n  table_getToggleAllRowsSelectedHandler,\n  table_resetRowSelection,\n  table_setRowSelection,\n  table_toggleAllPageRowsSelected,\n  table_toggleAllRowsSelected,\n} from './rowSelectionFeature.utils'\nimport type { RowData } from '../../types/type-utils'\nimport type { TableFeature, TableFeatures } from '../../types/TableFeatures'\n// import type {\n//   Row_RowSelection,\n//   TableOptions_RowSelection,\n//   TableState_RowSelection,\n//   Table_RowSelection,\n// } from './rowSelectionFeature.types'\n\nexport interface RowSelectionFeatureConstructors<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n> {\n  // Row: Row_RowSelection\n  // Table: Table_RowSelection<TFeatures, TData>\n  // TableOptions: TableOptions_RowSelection<TFeatures, TData>\n  // TableState: TableState_RowSelection\n}\n\n/**\n * Creates the stock row selection 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 constructRowSelectionFeature<\n  TFeatures extends TableFeatures,\n  TData extends RowData,\n>(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>> {\n  return {\n    getInitialState: (initialState) => {\n      return {\n        rowSelection: getDefaultRowSelectionState(),\n        ...initialState,\n      }\n    },\n\n    getDefaultTableOptions: (table) => {\n      return {\n        onRowSelectionChange: makeStateUpdater('rowSelection', table),\n        enableRowSelection: true,\n        enableMultiRowSelection: true,\n        enableSubRowSelection: true,\n      }\n    },\n\n    assignRowPrototype: (prototype, table) => {\n      assignPrototypeAPIs('rowSelectionFeature', prototype, table, {\n        row_toggleSelected: {\n          fn: (row, value, opts) => row_toggleSelected(row, value, opts),\n        },\n        row_getIsSelected: {\n          fn: (row) => row_getIsSelected(row),\n        },\n        row_getIsSomeSelected: {\n          fn: (row) => row_getIsSomeSelected(row),\n        },\n        row_getIsAllSubRowsSelected: {\n          fn: (row) => row_getIsAllSubRowsSelected(row),\n        },\n        row_getCanSelect: {\n          fn: (row) => row_getCanSelect(row),\n        },\n        row_getCanSelectSubRows: {\n          fn: (row) => row_getCanSelectSubRows(row),\n        },\n        row_getCanMultiSelect: {\n          fn: (row) => row_getCanMultiSelect(row),\n        },\n        row_getToggleSelectedHandler: {\n          fn: (row) => row_getToggleSelectedHandler(row),\n        },\n      })\n    },\n\n    constructTableAPIs: (table) => {\n      assignTableAPIs('rowSelectionFeature', table, {\n        table_setRowSelection: {\n          fn: (updater) => table_setRowSelection(table, updater),\n        },\n        table_resetRowSelection: {\n          fn: (defaultState) => table_resetRowSelection(table, defaultState),\n        },\n        table_toggleAllRowsSelected: {\n          fn: (value) => table_toggleAllRowsSelected(table, value),\n        },\n        table_toggleAllPageRowsSelected: {\n          fn: (value) => table_toggleAllPageRowsSelected(table, value),\n        },\n        table_getPreSelectedRowModel: {\n          fn: () => table_getPreSelectedRowModel(table),\n        },\n        table_getSelectedRowModel: {\n          fn: () => table_getSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getCoreRowModel(),\n          ],\n        },\n        table_getFilteredSelectedRowModel: {\n          fn: () => table_getFilteredSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getFilteredRowModel(),\n          ],\n        },\n        table_getGroupedSelectedRowModel: {\n          fn: () => table_getGroupedSelectedRowModel(table),\n          memoDeps: () => [\n            table.atoms.rowSelection?.get(),\n            table.getSortedRowModel(),\n          ],\n        },\n        table_getIsAllRowsSelected: {\n          fn: () => table_getIsAllRowsSelected(table),\n        },\n        table_getIsAllPageRowsSelected: {\n          fn: () => table_getIsAllPageRowsSelected(table),\n        },\n        table_getIsSomeRowsSelected: {\n          fn: () => table_getIsSomeRowsSelected(table),\n        },\n        table_getIsSomePageRowsSelected: {\n          fn: () => table_getIsSomePageRowsSelected(table),\n        },\n        table_getToggleAllRowsSelectedHandler: {\n          fn: () => table_getToggleAllRowsSelectedHandler(table),\n        },\n        table_getToggleAllPageRowsSelectedHandler: {\n          fn: () => table_getToggleAllPageRowsSelectedHandler(table),\n        },\n      })\n    },\n  }\n}\n\n/**\n * The stock row selection feature.\n *\n * Register this feature to add row selection state, selected row-model helpers,\n * and table/row APIs for checkbox and bulk-selection UI.\n */\nexport const rowSelectionFeature = constructRowSelectionFeature()\n"],"mappings":";;;;;;;;;AAsDA,SAAgB,+BAGqD;CACnE,OAAO;EACL,kBAAkB,iBAAiB;GACjC,OAAO;IACL,cAAc,6BAA6B;IAC3C,GAAG;IACJ;;EAGH,yBAAyB,UAAU;GACjC,OAAO;IACL,sBAAsB,iBAAiB,gBAAgB,MAAM;IAC7D,oBAAoB;IACpB,yBAAyB;IACzB,uBAAuB;IACxB;;EAGH,qBAAqB,WAAW,UAAU;GACxC,oBAAoB,uBAAuB,WAAW,OAAO;IAC3D,oBAAoB,EAClB,KAAK,KAAK,OAAO,SAAS,mBAAmB,KAAK,OAAO,KAAK,EAC/D;IACD,mBAAmB,EACjB,KAAK,QAAQ,kBAAkB,IAAI,EACpC;IACD,uBAAuB,EACrB,KAAK,QAAQ,sBAAsB,IAAI,EACxC;IACD,6BAA6B,EAC3B,KAAK,QAAQ,4BAA4B,IAAI,EAC9C;IACD,kBAAkB,EAChB,KAAK,QAAQ,iBAAiB,IAAI,EACnC;IACD,yBAAyB,EACvB,KAAK,QAAQ,wBAAwB,IAAI,EAC1C;IACD,uBAAuB,EACrB,KAAK,QAAQ,sBAAsB,IAAI,EACxC;IACD,8BAA8B,EAC5B,KAAK,QAAQ,6BAA6B,IAAI,EAC/C;IACF,CAAC;;EAGJ,qBAAqB,UAAU;GAC7B,gBAAgB,uBAAuB,OAAO;IAC5C,uBAAuB,EACrB,KAAK,YAAY,sBAAsB,OAAO,QAAQ,EACvD;IACD,yBAAyB,EACvB,KAAK,iBAAiB,wBAAwB,OAAO,aAAa,EACnE;IACD,6BAA6B,EAC3B,KAAK,UAAU,4BAA4B,OAAO,MAAM,EACzD;IACD,iCAAiC,EAC/B,KAAK,UAAU,gCAAgC,OAAO,MAAM,EAC7D;IACD,8BAA8B,EAC5B,UAAU,6BAA6B,MAAM,EAC9C;IACD,2BAA2B;KACzB,UAAU,0BAA0B,MAAM;KAC1C,gBAAgB;;uCACd,MAAM,MAAM,4FAAc,KAAK,EAC/B,MAAM,iBAAiB,CACxB;;KACF;IACD,mCAAmC;KACjC,UAAU,kCAAkC,MAAM;KAClD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,qBAAqB,CAC5B;;KACF;IACD,kCAAkC;KAChC,UAAU,iCAAiC,MAAM;KACjD,gBAAgB;;wCACd,MAAM,MAAM,8FAAc,KAAK,EAC/B,MAAM,mBAAmB,CAC1B;;KACF;IACD,4BAA4B,EAC1B,UAAU,2BAA2B,MAAM,EAC5C;IACD,gCAAgC,EAC9B,UAAU,+BAA+B,MAAM,EAChD;IACD,6BAA6B,EAC3B,UAAU,4BAA4B,MAAM,EAC7C;IACD,iCAAiC,EAC/B,UAAU,gCAAgC,MAAM,EACjD;IACD,uCAAuC,EACrC,UAAU,sCAAsC,MAAM,EACvD;IACD,2CAA2C,EACzC,UAAU,0CAA0C,MAAM,EAC3D;IACF,CAAC;;EAEL;;;;;;;;AASH,MAAa,sBAAsB,8BAA8B"}

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

@@ -25,7 +25,9 @@ interface TableOptions_RowSelection<TFeatures extends TableFeatures, TData exten
    */
   enableSubRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.rowSelection` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
+   * Called with an updater when row selection state changes. Pair this with
+   * `state.rowSelection` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onRowSelectionChange?: OnChangeFn<RowSelectionState>;
 }
@@ -111,7 +113,7 @@ interface Table_RowSelection<TFeatures extends TableFeatures, TData extends RowD
    */
   resetRowSelection: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.rowSelection` state.
+   * Sets row selection state using a value or updater.
    */
   setRowSelection: (updater: Updater<RowSelectionState>) => void;
   /**

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

@@ -25,7 +25,9 @@ interface TableOptions_RowSelection<TFeatures extends TableFeatures, TData exten
    */
   enableSubRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean);
   /**
-   * If provided, this function will be called with an `updaterFn` when `state.rowSelection` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
+   * Called with an updater when row selection state changes. Pair this with
+   * `state.rowSelection` when using external state; external atoms can own the
+   * slice without this callback.
    */
   onRowSelectionChange?: OnChangeFn<RowSelectionState>;
 }
@@ -111,7 +113,7 @@ interface Table_RowSelection<TFeatures extends TableFeatures, TData extends RowD
    */
   resetRowSelection: (defaultState?: boolean) => void;
   /**
-   * Sets or updates the `state.rowSelection` state.
+   * Sets row selection state using a value or updater.
    */
   setRowSelection: (updater: Updater<RowSelectionState>) => void;
   /**

package/dist/features/row-selection/rowSelectionFeature.utils.cjs

@@ -1,16 +1,57 @@
 const require_utils = require('../../utils.cjs');
 
 //#region src/features/row-selection/rowSelectionFeature.utils.ts
+/**
+* Returns the default row selection state.
+*
+* Feature constructors use this value to initialize the table state or option defaults when no user value is provided.
+*
+* @example
+* ```ts
+* const initialValue = getDefaultRowSelectionState()
+* ```
+*/
 function getDefaultRowSelectionState() {
 	return {};
 }
+/**
+* Updates the table's row selection state slice.
+*
+* The updater follows TanStack Table updater semantics and is routed through the corresponding `on*Change` option or backing atom.
+*
+* @example
+* ```ts
+* table_setRowSelection(table, (old) => old)
+* ```
+*/
 function table_setRowSelection(table, updater) {
 	var _table$options$onRowS, _table$options;
 	(_table$options$onRowS = (_table$options = table.options).onRowSelectionChange) === null || _table$options$onRowS === void 0 || _table$options$onRowS.call(_table$options, updater);
 }
+/**
+* Resets the table's row selection state slice.
+*
+* By default the reset uses `table.initialState`; when supported, a blank/default reset bypasses the saved initial value.
+*
+* @example
+* ```ts
+* table_resetRowSelection(table)
+* table_resetRowSelection(table, true)
+* ```
+*/
 function table_resetRowSelection(table, defaultState) {
 	table_setRowSelection(table, defaultState ? {} : require_utils.cloneState(table.initialState.rowSelection ?? {}));
 }
+/**
+* Toggles all rows selected for the table.
+*
+* This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+*
+* @example
+* ```ts
+* table_toggleAllRowsSelected(table)
+* ```
+*/
 function table_toggleAllRowsSelected(table, value) {
 	table_setRowSelection(table, (old) => {
 		value = typeof value !== "undefined" ? value : !table_getIsAllRowsSelected(table);
@@ -26,6 +67,16 @@ function table_toggleAllRowsSelected(table, value) {
 		return rowSelection;
 	});
 }
+/**
+* Toggles all page rows selected for the table.
+*
+* This is the table-level convenience API used by UI controls that affect many columns or rows at once.
+*
+* @example
+* ```ts
+* table_toggleAllPageRowsSelected(table)
+* ```
+*/
 function table_toggleAllPageRowsSelected(table, value) {
 	table_setRowSelection(table, (old) => {
 		const resolvedValue = typeof value !== "undefined" ? value : !table_getIsAllPageRowsSelected(table);
@@ -36,9 +87,29 @@ function table_toggleAllPageRowsSelected(table, value) {
 		return rowSelection;
 	});
 }
+/**
+* Returns pre selected row model for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getPreSelectedRowModel(table)
+* ```
+*/
 function table_getPreSelectedRowModel(table) {
 	return table.getCoreRowModel();
 }
+/**
+* Returns selected row model for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getSelectedRowModel(table)
+* ```
+*/
 function table_getSelectedRowModel(table) {
 	var _table$atoms$rowSelec;
 	const rowModel = table.getCoreRowModel();
@@ -49,6 +120,16 @@ function table_getSelectedRowModel(table) {
 	};
 	return selectRowsFn(rowModel);
 }
+/**
+* Returns filtered selected row model for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getFilteredSelectedRowModel(table)
+* ```
+*/
 function table_getFilteredSelectedRowModel(table) {
 	var _table$atoms$rowSelec2;
 	const rowModel = table.getCoreRowModel();
@@ -59,6 +140,16 @@ function table_getFilteredSelectedRowModel(table) {
 	};
 	return selectRowsFn(rowModel);
 }
+/**
+* Returns grouped selected row model for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getGroupedSelectedRowModel(table)
+* ```
+*/
 function table_getGroupedSelectedRowModel(table) {
 	var _table$atoms$rowSelec3;
 	const rowModel = table.getCoreRowModel();
@@ -69,6 +160,16 @@ function table_getGroupedSelectedRowModel(table) {
 	};
 	return selectRowsFn(rowModel);
 }
+/**
+* Returns is all rows selected for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsAllRowsSelected(table)
+* ```
+*/
 function table_getIsAllRowsSelected(table) {
 	var _table$atoms$rowSelec4;
 	const preGroupedFlatRows = table.getFilteredRowModel().flatRows;
@@ -79,6 +180,16 @@ function table_getIsAllRowsSelected(table) {
 	}
 	return isAllRowsSelected;
 }
+/**
+* Returns is all page rows selected for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsAllPageRowsSelected(table)
+* ```
+*/
 function table_getIsAllPageRowsSelected(table) {
 	var _table$atoms$rowSelec5;
 	const paginationFlatRows = table.getPaginatedRowModel().flatRows.filter((row) => row_getCanSelect(row));
@@ -87,25 +198,75 @@ function table_getIsAllPageRowsSelected(table) {
 	if (isAllPageRowsSelected && paginationFlatRows.some((row) => !rowSelection[row.id])) isAllPageRowsSelected = false;
 	return isAllPageRowsSelected;
 }
+/**
+* Returns is some rows selected for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsSomeRowsSelected(table)
+* ```
+*/
 function table_getIsSomeRowsSelected(table) {
 	var _table$atoms$rowSelec6;
 	const totalSelected = Object.keys(((_table$atoms$rowSelec6 = table.atoms.rowSelection) === null || _table$atoms$rowSelec6 === void 0 ? void 0 : _table$atoms$rowSelec6.get()) ?? {}).length;
 	return totalSelected > 0 && totalSelected < table.getFilteredRowModel().flatRows.length;
 }
+/**
+* Returns is some page rows selected for the table.
+*
+* This reads the relevant table atoms, options, and row-model cache to derive the current table-level value.
+*
+* @example
+* ```ts
+* const value = table_getIsSomePageRowsSelected(table)
+* ```
+*/
 function table_getIsSomePageRowsSelected(table) {
 	const paginationFlatRows = table.getPaginatedRowModel().flatRows;
 	return table_getIsAllPageRowsSelected(table) ? false : paginationFlatRows.filter((row) => row_getCanSelect(row)).some((row) => row_getIsSelected(row) || row_getIsSomeSelected(row));
 }
+/**
+* Returns an event handler for all rows selected handler.
+*
+* The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+*
+* @example
+* ```ts
+* const value = table_getToggleAllRowsSelectedHandler(table)
+* ```
+*/
 function table_getToggleAllRowsSelectedHandler(table) {
 	return (e) => {
 		table_toggleAllRowsSelected(table, e.target.checked);
 	};
 }
+/**
+* Returns an event handler for all page rows selected handler.
+*
+* The handler calls the matching table toggle API and can be attached directly to checkbox or button UI.
+*
+* @example
+* ```ts
+* const value = table_getToggleAllPageRowsSelectedHandler(table)
+* ```
+*/
 function table_getToggleAllPageRowsSelectedHandler(table) {
 	return (e) => {
 		table_toggleAllPageRowsSelected(table, e.target.checked);
 	};
 }
+/**
+* Toggles selected for a row.
+*
+* The update is routed through the table state updater for the owning feature state slice.
+*
+* @example
+* ```ts
+* row_toggleSelected(row)
+* ```
+*/
 function row_toggleSelected(row, value, opts) {
 	const isSelected = row_getIsSelected(row);
 	table_setRowSelection(row.table, (old) => {
@@ -116,30 +277,100 @@ function row_toggleSelected(row, value, opts) {
 		return selectedRowIds;
 	});
 }
+/**
+* Returns is selected for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsSelected(row)
+* ```
+*/
 function row_getIsSelected(row) {
 	return isRowSelected(row);
 }
+/**
+* Returns is some selected for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsSomeSelected(row)
+* ```
+*/
 function row_getIsSomeSelected(row) {
 	return isSubRowSelected(row) === "some";
 }
+/**
+* Returns is all sub rows selected for a row.
+*
+* This is the static implementation behind the matching row instance API and may read row caches or table state atoms.
+*
+* @example
+* ```ts
+* const value = row_getIsAllSubRowsSelected(row)
+* ```
+*/
 function row_getIsAllSubRowsSelected(row) {
 	return isSubRowSelected(row) === "all";
 }
+/**
+* Returns whether a row can use select.
+*
+* This evaluates row data, table options, and feature-specific enablement rules.
+*
+* @example
+* ```ts
+* const value = row_getCanSelect(row)
+* ```
+*/
 function row_getCanSelect(row) {
 	const options = row.table.options;
 	if (typeof options.enableRowSelection === "function") return options.enableRowSelection(row);
 	return options.enableRowSelection ?? true;
 }
+/**
+* Returns whether a row can use select sub rows.
+*
+* This evaluates row data, table options, and feature-specific enablement rules.
+*
+* @example
+* ```ts
+* const value = row_getCanSelectSubRows(row)
+* ```
+*/
 function row_getCanSelectSubRows(row) {
 	const options = row.table.options;
 	if (typeof options.enableSubRowSelection === "function") return options.enableSubRowSelection(row);
 	return options.enableSubRowSelection ?? true;
 }
+/**
+* Returns whether a row can use multi select.
+*
+* This evaluates row data, table options, and feature-specific enablement rules.
+*
+* @example
+* ```ts
+* const value = row_getCanMultiSelect(row)
+* ```
+*/
 function row_getCanMultiSelect(row) {
 	const options = row.table.options;
 	if (typeof options.enableMultiRowSelection === "function") return options.enableMultiRowSelection(row);
 	return options.enableMultiRowSelection ?? true;
 }
+/**
+* Returns an event handler for toggling selected handler.
+*
+* The handler is intended for direct use in row-level controls such as expansion or selection buttons.
+*
+* @example
+* ```ts
+* const value = row_getToggleSelectedHandler(row)
+* ```
+*/
 function row_getToggleSelectedHandler(row) {
 	const canSelect = row_getCanSelect(row);
 	return (e) => {
@@ -155,6 +386,16 @@ const mutateRowIsSelected = (selectedRowIds, rowId, value, includeChildren, tabl
 	} else delete selectedRowIds[rowId];
 	if (includeChildren && row.subRows.length && row_getCanSelectSubRows(row)) row.subRows.forEach((r) => mutateRowIsSelected(selectedRowIds, r.id, value, includeChildren, table));
 };
+/**
+* Builds a row model containing rows selected by the current row selection state.
+*
+* The result is derived from the supplied row model, so selected ids absent from the current data are not materialized as rows.
+*
+* @example
+* ```ts
+* const selectedRows = selectRowsFn(table, rowModel)
+* ```
+*/
 function selectRowsFn(rowModel) {
 	const newSelectedFlatRows = [];
 	const newSelectedRowsById = {};
@@ -178,10 +419,28 @@ function selectRowsFn(rowModel) {
 		rowsById: newSelectedRowsById
 	};
 }
+/**
+* Returns whether a row id is selected in the current row selection state.
+*
+* @example
+* ```ts
+* const selected = isRowSelected(row, selection)
+* ```
+*/
 function isRowSelected(row) {
 	var _row$table$atoms$rowS;
 	return (((_row$table$atoms$rowS = row.table.atoms.rowSelection) === null || _row$table$atoms$rowS === void 0 ? void 0 : _row$table$atoms$rowS.get()) ?? {})[row.id] ?? false;
 }
+/**
+* Returns whether all, some, or none of a row's selectable descendants are selected.
+*
+* The result is used to drive indeterminate row selection UI.
+*
+* @example
+* ```ts
+* const selectedState = isSubRowSelected(row, selection, table)
+* ```
+*/
 function isSubRowSelected(row) {
 	if (!row.subRows.length) return false;
 	let allChildrenSelected = true;