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

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

@@ -6,33 +6,292 @@ import { Table_Internal } from "../../types/Table.js";
 import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
 
 //#region src/features/row-selection/rowSelectionFeature.utils.d.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()
+ * ```
+ */
 declare function getDefaultRowSelectionState(): RowSelectionState;
+/**
+ * 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)
+ * ```
+ */
 declare function table_setRowSelection<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowSelectionState>): void;
+/**
+ * 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)
+ * ```
+ */
 declare function table_resetRowSelection<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+/**
+ * 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)
+ * ```
+ */
 declare function table_toggleAllRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
+/**
+ * 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)
+ * ```
+ */
 declare function table_toggleAllPageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getPreSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getFilteredSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getGroupedSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getIsAllRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getIsAllPageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getIsSomeRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getIsSomePageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getToggleAllRowsSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+/**
+ * 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)
+ * ```
+ */
 declare function table_getToggleAllPageRowsSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+/**
+ * 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)
+ * ```
+ */
 declare function row_toggleSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, value?: boolean, opts?: {
   selectChildren?: boolean;
 }): void;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getIsSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getIsSomeSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getIsAllSubRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getCanSelect<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getCanSelectSubRows<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getCanMultiSelect<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function row_getToggleSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): (e: unknown) => void;
+/**
+ * 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)
+ * ```
+ */
 declare function selectRowsFn<TFeatures extends TableFeatures, TData extends RowData>(rowModel: RowModel<TFeatures, TData>): RowModel<TFeatures, TData>;
+/**
+ * Returns whether a row id is selected in the current row selection state.
+ *
+ * @example
+ * ```ts
+ * const selected = isRowSelected(row, selection)
+ * ```
+ */
 declare function isRowSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+/**
+ * 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)
+ * ```
+ */
 declare function isSubRowSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean | 'some' | 'all';
 //#endregion
 export { getDefaultRowSelectionState, isRowSelected, isSubRowSelected, row_getCanMultiSelect, row_getCanSelect, row_getCanSelectSubRows, row_getIsAllSubRowsSelected, row_getIsSelected, row_getIsSomeSelected, row_getToggleSelectedHandler, row_toggleSelected, selectRowsFn, 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 };

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

@@ -1,16 +1,57 @@
 import { cloneState } from "../../utils.js";
 
 //#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 ? {} : 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;