@tanstack/table-core 9.0.0-beta.5 → 9.0.0-beta.51

package/src/features/row-selection/rowSelectionFeature.ts

@@ -20,6 +20,7 @@ import {
   table_getIsSomePageRowsSelected,
   table_getIsSomeRowsSelected,
   table_getPreSelectedRowModel,
+  table_getSelectedRowIds,
   table_getSelectedRowModel,
   table_getToggleAllPageRowsSelectedHandler,
   table_getToggleAllRowsSelectedHandler,
@@ -34,6 +35,16 @@ import type { TableFeature } from '../../types/TableFeatures'
  * Feature that adds row selection state and APIs for row and page selection.
  */
 export const rowSelectionFeature: TableFeature = {
+  initTableInstanceData: (table) => {
+    // @ts-ignore - _lastSelectedRowId is row selection table instance data
+    table._lastSelectedRowId = null
+  },
+
+  resetTableInstanceData: (table) => {
+    // @ts-ignore - _lastSelectedRowId is row selection table instance data
+    table._lastSelectedRowId = null
+  },
+
   getInitialState: (initialState) => {
     return {
       rowSelection: getDefaultRowSelectionState(),
@@ -46,7 +57,15 @@ export const rowSelectionFeature: TableFeature = {
       onRowSelectionChange: makeStateUpdater('rowSelection', table),
       enableRowSelection: true,
       enableMultiRowSelection: true,
+      enableRowRangeSelection: true,
       enableSubRowSelection: true,
+      isRowRangeSelectionEvent: (event) => {
+        const rangeEvent = event as {
+          shiftKey?: boolean
+          nativeEvent?: { shiftKey?: boolean }
+        }
+        return Boolean(rangeEvent.shiftKey || rangeEvent.nativeEvent?.shiftKey)
+      },
     }
   },
 
@@ -60,9 +79,19 @@ export const rowSelectionFeature: TableFeature = {
       },
       row_getIsSomeSelected: {
         fn: (row) => row_getIsSomeSelected(row),
+        memoDeps: (row) => [
+          row.subRows,
+          row.table.atoms.rowSelection?.get(),
+          row.table.options.enableRowSelection,
+        ],
       },
       row_getIsAllSubRowsSelected: {
         fn: (row) => row_getIsAllSubRowsSelected(row),
+        memoDeps: (row) => [
+          row.subRows,
+          row.table.atoms.rowSelection?.get(),
+          row.table.options.enableRowSelection,
+        ],
       },
       row_getCanSelect: {
         fn: (row) => row_getCanSelect(row),
@@ -74,7 +103,7 @@ export const rowSelectionFeature: TableFeature = {
         fn: (row) => row_getCanMultiSelect(row),
       },
       row_getToggleSelectedHandler: {
-        fn: (row) => row_getToggleSelectedHandler(row),
+        fn: (row, opts) => row_getToggleSelectedHandler(row, opts),
       },
     })
   },
@@ -88,10 +117,11 @@ export const rowSelectionFeature: TableFeature = {
         fn: (defaultState) => table_resetRowSelection(table, defaultState),
       },
       table_toggleAllRowsSelected: {
-        fn: (value) => table_toggleAllRowsSelected(table, value),
+        fn: (value, opts) => table_toggleAllRowsSelected(table, value, opts),
       },
       table_toggleAllPageRowsSelected: {
-        fn: (value) => table_toggleAllPageRowsSelected(table, value),
+        fn: (value, opts) =>
+          table_toggleAllPageRowsSelected(table, value, opts),
       },
       table_getPreSelectedRowModel: {
         fn: () => table_getPreSelectedRowModel(table),
@@ -117,17 +147,37 @@ export const rowSelectionFeature: TableFeature = {
           table.getSortedRowModel(),
         ],
       },
+      table_getSelectedRowIds: {
+        fn: () => table_getSelectedRowIds(table),
+        memoDeps: () => [table.atoms.rowSelection?.get()],
+      },
       table_getIsAllRowsSelected: {
         fn: () => table_getIsAllRowsSelected(table),
+        memoDeps: () => [
+          table.atoms.rowSelection?.get(),
+          table.getFilteredRowModel(),
+          table.options.enableRowSelection,
+        ],
       },
       table_getIsAllPageRowsSelected: {
         fn: () => table_getIsAllPageRowsSelected(table),
+        memoDeps: () => [
+          table.atoms.rowSelection?.get(),
+          table.getPaginatedRowModel(),
+          table.options.enableRowSelection,
+        ],
       },
       table_getIsSomeRowsSelected: {
         fn: () => table_getIsSomeRowsSelected(table),
+        memoDeps: () => [table.atoms.rowSelection?.get()],
       },
       table_getIsSomePageRowsSelected: {
         fn: () => table_getIsSomePageRowsSelected(table),
+        memoDeps: () => [
+          table.atoms.rowSelection?.get(),
+          table.getPaginatedRowModel(),
+          table.options.enableRowSelection,
+        ],
       },
       table_getToggleAllRowsSelectedHandler: {
         fn: () => table_getToggleAllRowsSelectedHandler(table),

package/src/features/row-selection/rowSelectionFeature.types.ts

@@ -3,16 +3,32 @@ import type { TableFeatures } from '../../types/TableFeatures'
 import type { RowModel } from '../../core/row-models/coreRowModelsFeature.types'
 import type { Row } from '../../types/Row'
 
-export type RowSelectionState = Record<string, boolean | undefined>
+export type RowSelectionState = Record<string, true>
+
+/**
+ * Controls how toggling a row affects its descendants.
+ */
+export interface ToggleSelectedOptions {
+  /**
+   * Whether selectable child rows should be toggled recursively. Defaults to
+   * `true`.
+   */
+  selectChildren?: boolean
+}
 
 export interface TableState_RowSelection {
   rowSelection: RowSelectionState
 }
 
 export interface TableOptions_RowSelection<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
+  /**
+   * Enables inclusive row range selection through
+   * `row.getToggleSelectedHandler()`. Defaults to `true`.
+   */
+  enableRowRangeSelection?: boolean
   /**
    * Allows rows to be selected alongside other rows.
    *
@@ -32,6 +48,14 @@ export interface TableOptions_RowSelection<
    * grouping features and defaults to `true`.
    */
   enableSubRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean)
+  /**
+   * Determines whether a row-selection handler event should select or
+   * deselect the inclusive range from the most recent handler interaction.
+   *
+   * By default, events with `shiftKey` directly on the event or on
+   * `event.nativeEvent` are treated as range-selection events.
+   */
+  isRowRangeSelectionEvent?: (event: unknown) => boolean
   /**
    * Called with an updater when row selection state changes. Pair this with
    * `state.rowSelection` when using external state; external atoms can own the
@@ -44,7 +68,6 @@ export interface TableOptions_RowSelection<
   //       row: Row<TFeatures, TData>
   //     ) => boolean)
   // isAdditiveSelectEvent?: (e: unknown) => boolean
-  // isInclusiveSelectEvent?: (e: unknown) => boolean
   // selectRowsFn?: (
   //   table: Table<TFeatures, TData>,
   //   rowModel: RowModel<TFeatures, TData>
@@ -78,18 +101,29 @@ export interface Row_RowSelection {
   getIsSomeSelected: () => boolean
   /**
    * Creates a checkbox-style handler that toggles this row's selected state.
+   * Pass the original checkbox click event, or a framework event whose
+   * `nativeEvent` is that click, so Shift range selection can detect the
+   * modifier key.
    */
-  getToggleSelectedHandler: () => (event: unknown) => void
+  getToggleSelectedHandler: (
+    opts?: ToggleSelectedOptions,
+  ) => (event: unknown) => void
   /**
    * Selects/deselects the row.
    */
-  toggleSelected: (value?: boolean, opts?: { selectChildren?: boolean }) => void
+  toggleSelected: (value?: boolean, opts?: ToggleSelectedOptions) => void
 }
 
 export interface Table_RowSelection<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
+  /**
+   * The most recent row interacted with through the row selection handler.
+   *
+   * @internal
+   */
+  _lastSelectedRowId: string | null
   /**
    * Builds a selected-row model from rows after filtering.
    */
@@ -98,6 +132,10 @@ export interface Table_RowSelection<
    * Builds a selected-row model from rows after grouping.
    */
   getGroupedSelectedRowModel: () => RowModel<TFeatures, TData>
+  /**
+   * Returns the ids of all selected rows.
+   */
+  getSelectedRowIds: () => Array<string>
   /**
    * Checks whether every selectable row on the current page is selected.
    */
@@ -143,9 +181,15 @@ export interface Table_RowSelection<
   /**
    * Selects/deselects all rows on the current page.
    */
-  toggleAllPageRowsSelected: (value?: boolean) => void
+  toggleAllPageRowsSelected: (
+    value?: boolean,
+    opts?: { deselectAll?: boolean },
+  ) => void
   /**
    * Selects/deselects all rows in the table.
    */
-  toggleAllRowsSelected: (value?: boolean) => void
+  toggleAllRowsSelected: (
+    value?: boolean,
+    opts?: { deselectAll?: boolean },
+  ) => void
 }