@tanstack/table-core 9.0.0-beta.9 → 9.0.1

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

@@ -1,10 +1,9 @@
 import { RowData, Updater } from "../../types/type-utils.js";
-import { RowSelectionState } from "./rowSelectionFeature.types.js";
+import { RowSelectionState, ToggleSelectedOptions } from "./rowSelectionFeature.types.js";
 import { Row } from "../../types/Row.js";
-import { TableFeatures } from "../../types/TableFeatures.js";
-import { Table_Internal } from "../../types/Table.js";
 import { RowModel } from "../../core/row-models/coreRowModelsFeature.types.js";
-
+import { Table } from "../../types/Table.js";
+import { TableFeatures } from "../../types/TableFeatures.js";
 //#region src/features/row-selection/rowSelectionFeature.utils.d.ts
 /**
  * Creates the default row selection state.
@@ -29,7 +28,7 @@ declare function getDefaultRowSelectionState(): RowSelectionState;
  * table_setRowSelection(table, (old) => ({ ...old, [rowId]: true }))
  * ```
  */
-declare function table_setRowSelection<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, updater: Updater<RowSelectionState>): void;
+declare function table_setRowSelection<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, updater: Updater<RowSelectionState>): void;
 /**
  * Resets `rowSelection` to the configured initial state or feature default.
  *
@@ -42,19 +41,24 @@ declare function table_setRowSelection<TFeatures extends TableFeatures, TData ex
  * table_resetRowSelection(table, true)
  * ```
  */
-declare function table_resetRowSelection<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean): void;
+declare function table_resetRowSelection<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, defaultState?: boolean): void;
 /**
  * Selects or deselects every selectable row before grouping.
  *
  * Omitting `value` toggles based on `table_getIsAllRowsSelected(table)`.
- * Deselecting removes matching ids from the existing selection map.
+ * Selecting skips sub-rows whose ancestors block descent via
+ * `enableSubRowSelection`. Deselecting removes matching selectable ids from the
+ * existing selection map; rows that cannot be selected keep their selection
+ * unless `opts.deselectAll` is `true`.
  *
  * @example
  * ```ts
  * table_toggleAllRowsSelected(table)
  * ```
  */
-declare function table_toggleAllRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
+declare function table_toggleAllRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, value?: boolean, opts?: {
+  deselectAll?: boolean;
+}): void;
 /**
  * Selects or deselects every selectable row on the current page.
  *
@@ -66,7 +70,9 @@ declare function table_toggleAllRowsSelected<TFeatures extends TableFeatures, TD
  * table_toggleAllPageRowsSelected(table)
  * ```
  */
-declare function table_toggleAllPageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>, value?: boolean): void;
+declare function table_toggleAllPageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>, value?: boolean, opts?: {
+  deselectAll?: boolean;
+}): void;
 /**
  * Reads the row model before row selection is projected into selected rows.
  *
@@ -78,7 +84,7 @@ declare function table_toggleAllPageRowsSelected<TFeatures extends TableFeatures
  * const rowsBeforeSelection = table_getPreSelectedRowModel(table)
  * ```
  */
-declare function table_getPreSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+declare function table_getPreSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): RowModel<TFeatures, TData>;
 /**
  * Builds a row model containing selected rows from the core row model.
  *
@@ -90,7 +96,11 @@ declare function table_getPreSelectedRowModel<TFeatures extends TableFeatures, T
  * const selectedRows = table_getSelectedRowModel(table)
  * ```
  */
-declare function table_getSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+declare function table_getSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): RowModel<TFeatures, TData> | {
+  rows: never[];
+  flatRows: never[];
+  rowsById: Record<string, unknown>;
+};
 /**
  * Builds a row model containing selected rows from the filtered row model.
  *
@@ -102,7 +112,11 @@ declare function table_getSelectedRowModel<TFeatures extends TableFeatures, TDat
  * const selectedRows = table_getFilteredSelectedRowModel(table)
  * ```
  */
-declare function table_getFilteredSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+declare function table_getFilteredSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): RowModel<TFeatures, TData> | {
+  rows: never[];
+  flatRows: never[];
+  rowsById: Record<string, unknown>;
+};
 /**
  * Builds a row model containing selected rows from the grouped row model.
  *
@@ -114,54 +128,65 @@ declare function table_getFilteredSelectedRowModel<TFeatures extends TableFeatur
  * const selectedRows = table_getGroupedSelectedRowModel(table)
  * ```
  */
-declare function table_getGroupedSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): RowModel<TFeatures, TData>;
+declare function table_getGroupedSelectedRowModel<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): RowModel<TFeatures, TData> | {
+  rows: never[];
+  flatRows: never[];
+  rowsById: Record<string, unknown>;
+};
+/**
+ * Returns the ids of all selected rows.
+ *
+ * @example
+ * ```ts
+ * const selectedRowIds = table_getSelectedRowIds(table)
+ * ```
+ */
+declare function table_getSelectedRowIds<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): Array<string>;
 /**
  * Checks whether every selectable filtered row is selected.
  *
  * The result is false when there are no filtered rows or when selection state is
- * empty.
+ * empty. Sub-rows whose ancestors block descent via `enableSubRowSelection` are
+ * ignored, matching the rows that `table_toggleAllRowsSelected` selects.
  *
  * @example
  * ```ts
  * const allSelected = table_getIsAllRowsSelected(table)
  * ```
  */
-declare function table_getIsAllRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getIsAllRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): boolean;
 /**
  * Checks whether every selectable row on the current page is selected.
  *
- * Non-selectable rows are ignored for this calculation.
+ * Non-selectable rows are ignored for this calculation, as are sub-rows whose
+ * ancestors block descent via `enableSubRowSelection`.
  *
  * @example
  * ```ts
  * const allPageRowsSelected = table_getIsAllPageRowsSelected(table)
  * ```
  */
-declare function table_getIsAllPageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getIsAllPageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): boolean;
 /**
- * Checks whether selection is partially applied across filtered rows.
+ * Checks whether at least one row id is selected.
  *
- * The result is true when at least one row id is selected but fewer ids are
- * selected than the current filtered flat row count.
+ * The result stays true when every row is selected.
  *
  * @example
  * ```ts
  * const someRowsSelected = table_getIsSomeRowsSelected(table)
  * ```
  */
-declare function table_getIsSomeRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getIsSomeRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): boolean;
 /**
- * Checks whether the current page has a partial selection.
- *
- * This is false when all selectable page rows are selected. Otherwise it is true
- * if any selectable page row or descendant is selected.
+ * Checks whether at least one selectable row on the current page is selected.
  *
  * @example
  * ```ts
  * const somePageRowsSelected = table_getIsSomePageRowsSelected(table)
  * ```
  */
-declare function table_getIsSomePageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): boolean;
+declare function table_getIsSomePageRowsSelected<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): boolean;
 /**
  * Creates a checkbox-style handler that selects or deselects all rows.
  *
@@ -173,7 +198,7 @@ declare function table_getIsSomePageRowsSelected<TFeatures extends TableFeatures
  * const onChange = table_getToggleAllRowsSelectedHandler(table)
  * ```
  */
-declare function table_getToggleAllRowsSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+declare function table_getToggleAllRowsSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): (e: unknown) => void;
 /**
  * Creates a checkbox-style handler that selects or deselects current page rows.
  *
@@ -185,21 +210,25 @@ declare function table_getToggleAllRowsSelectedHandler<TFeatures extends TableFe
  * const onChange = table_getToggleAllPageRowsSelectedHandler(table)
  * ```
  */
-declare function table_getToggleAllPageRowsSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table_Internal<TFeatures, TData>): (e: unknown) => void;
+declare function table_getToggleAllPageRowsSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(table: Table<TFeatures, TData>): (e: unknown) => void;
 /**
  * Selects or deselects this row.
  *
  * Omitting `value` toggles the row. Child rows are selected recursively unless
- * `opts.selectChildren` is `false` or sub-row selection is disabled.
+ * `opts.selectChildren` is `false`, sub-row selection is disabled, or the row
+ * only supports single selection. Pass `deselectParents: true` to also remove
+ * ancestor row ids from the selection when this row is deselected.
  *
  * @example
  * ```ts
  * row_toggleSelected(row)
+ * row_toggleSelected(row, true)
+ * row_toggleSelected(row, false)
+ * row_toggleSelected(row, true, { selectChildren: false })
+ * row_toggleSelected(row, false, { deselectParents: true })
  * ```
  */
-declare function row_toggleSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, value?: boolean, opts?: {
-  selectChildren?: boolean;
-}): void;
+declare function row_toggleSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, value?: boolean, opts?: ToggleSelectedOptions): void;
 /**
  * Checks whether this row id is selected in `state.rowSelection`.
  *
@@ -273,14 +302,18 @@ declare function row_getCanMultiSelect<TFeatures extends TableFeatures, TData ex
  * Creates a checkbox-style handler that selects or deselects this row.
  *
  * The handler is a no-op when the row cannot be selected and reads
- * `event.target.checked`.
+ * `event.target.checked`. Shift events select or deselect the inclusive range
+ * from the most recent selectable row handled by this table. Pass
+ * `selectChildren: false` to limit changes to rows explicitly present in the
+ * display-order interval, and `deselectParents: true` to remove ancestor row
+ * ids from the selection when rows are deselected.
  *
  * @example
  * ```ts
  * const onChange = row_getToggleSelectedHandler(row)
  * ```
  */
-declare function row_getToggleSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): (e: unknown) => void;
+declare function row_getToggleSelectedHandler<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, opts?: ToggleSelectedOptions): (e: unknown) => void;
 /**
  * Builds a row model containing rows selected by the current row selection state.
  *
@@ -292,7 +325,7 @@ declare function row_getToggleSelectedHandler<TFeatures extends TableFeatures, T
  * const selectedRows = selectRowsFn(rowModel)
  * ```
  */
-declare function selectRowsFn<TFeatures extends TableFeatures, TData extends RowData>(rowModel: RowModel<TFeatures, TData>): RowModel<TFeatures, TData>;
+declare function selectRowsFn<TFeatures extends TableFeatures, TData extends RowData>(rowModel: RowModel<TFeatures, TData>, table: Table<TFeatures, TData>): RowModel<TFeatures, TData>;
 /**
  * Returns whether a row id is selected in the current row selection state.
  *
@@ -301,7 +334,7 @@ declare function selectRowsFn<TFeatures extends TableFeatures, TData extends Row
  * const selected = isRowSelected(row)
  * ```
  */
-declare function isRowSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>): boolean;
+declare function isRowSelected<TFeatures extends TableFeatures, TData extends RowData>(row: Row<TFeatures, TData>, rowSelection: RowSelectionState): boolean;
 /**
  * Returns whether all, some, or none of a row's selectable descendants are selected.
  *
@@ -314,5 +347,4 @@ declare function isRowSelected<TFeatures extends TableFeatures, TData extends Ro
  */
 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 };
-//# sourceMappingURL=rowSelectionFeature.utils.d.ts.map
+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_getSelectedRowIds, table_getSelectedRowModel, table_getToggleAllPageRowsSelectedHandler, table_getToggleAllRowsSelectedHandler, table_resetRowSelection, table_setRowSelection, table_toggleAllPageRowsSelected, table_toggleAllRowsSelected };