@tanstack/table-core 9.0.0-beta.2 → 9.0.0-beta.20

package/src/features/row-pinning/rowPinningFeature.ts

@@ -16,114 +16,82 @@ import {
   table_resetRowPinning,
   table_setRowPinning,
 } from './rowPinningFeature.utils'
-import type { RowData } from '../../types/type-utils'
-import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
-// import type {
-//   Row_RowPinning,
-//   TableOptions_RowPinning,
-//   TableState_RowPinning,
-//   Table_RowPinning,
-// } from './rowPinningFeature.types'
-
-export interface RowPinningFeatureConstructors<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  // Row: Row_RowPinning
-  // Table: Table_RowPinning<TFeatures, RowData>
-  // TableOptions: TableOptions_RowPinning<TFeatures, RowData>
-  // TableState: TableState_RowPinning
-}
+import type { TableFeature } from '../../types/TableFeatures'
 
 /**
- * Creates the stock row pinning feature.
- *
- * The returned feature registers its state defaults, option defaults, and instance APIs so it can be included in a `tableFeatures({ ... })` call.
+ * Feature that adds row pinning state and APIs for top, center, and bottom rows.
  */
-export function constructRowPinningFeature<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(): TableFeature<RowPinningFeatureConstructors<TFeatures, TData>> {
-  return {
-    getInitialState: (initialState) => {
-      return {
-        ...initialState,
-        rowPinning: {
-          ...getDefaultRowPinningState(),
-          ...initialState.rowPinning,
-        },
-      }
-    },
+export const rowPinningFeature: TableFeature = {
+  getInitialState: (initialState) => {
+    return {
+      ...initialState,
+      rowPinning: {
+        ...getDefaultRowPinningState(),
+        ...initialState.rowPinning,
+      },
+    }
+  },
 
-    getDefaultTableOptions: (table) => {
-      return {
-        onRowPinningChange: makeStateUpdater('rowPinning', table),
-      }
-    },
+  getDefaultTableOptions: (table) => {
+    return {
+      onRowPinningChange: makeStateUpdater('rowPinning', table),
+    }
+  },
 
-    assignRowPrototype: (prototype, table) => {
-      assignPrototypeAPIs('rowPinningFeature', prototype, table, {
-        row_getCanPin: {
-          fn: (row) => row_getCanPin(row),
-        },
-        row_getIsPinned: {
-          fn: (row) => row_getIsPinned(row),
-        },
-        row_getPinnedIndex: {
-          fn: (row) => row_getPinnedIndex(row),
-          memoDeps: (row) => [
-            row.table.getRowModel().rows,
-            row.table.atoms.rowPinning?.get(),
-          ],
-        },
-        row_pin: {
-          fn: (row, position, includeLeafRows, includeParentRows) =>
-            row_pin(row, position, includeLeafRows, includeParentRows),
-        },
-      })
-    },
+  assignRowPrototype: (prototype, table) => {
+    assignPrototypeAPIs('rowPinningFeature', prototype, table, {
+      row_getCanPin: {
+        fn: (row) => row_getCanPin(row),
+      },
+      row_getIsPinned: {
+        fn: (row) => row_getIsPinned(row),
+      },
+      row_getPinnedIndex: {
+        fn: (row) => row_getPinnedIndex(row),
+        memoDeps: (row) => [
+          row.table.getRowModel().rows,
+          row.table.atoms.rowPinning?.get(),
+        ],
+      },
+      row_pin: {
+        fn: (row, position, includeLeafRows, includeParentRows) =>
+          row_pin(row, position, includeLeafRows, includeParentRows),
+      },
+    })
+  },
 
-    constructTableAPIs: (table) => {
-      assignTableAPIs('rowPinningFeature', table, {
-        table_setRowPinning: {
-          fn: (updater) => table_setRowPinning(table, updater),
-        },
-        table_resetRowPinning: {
-          fn: (defaultState) => table_resetRowPinning(table, defaultState),
-        },
-        table_getIsSomeRowsPinned: {
-          fn: (position) => table_getIsSomeRowsPinned(table, position),
-        },
-        table_getTopRows: {
-          fn: () => table_getTopRows(table),
-          memoDeps: () => [
-            table.getRowModel().rows,
-            table.atoms.rowPinning?.get()?.top,
-          ],
-        },
-        table_getBottomRows: {
-          fn: () => table_getBottomRows(table),
-          memoDeps: () => [
-            table.getRowModel().rows,
-            table.atoms.rowPinning?.get()?.bottom,
-          ],
-        },
-        table_getCenterRows: {
-          fn: () => table_getCenterRows(table),
-          memoDeps: () => [
-            table.getRowModel().rows,
-            table.atoms.rowPinning?.get(),
-          ],
-        },
-      })
-    },
-  }
+  constructTableAPIs: (table) => {
+    assignTableAPIs('rowPinningFeature', table, {
+      table_setRowPinning: {
+        fn: (updater) => table_setRowPinning(table, updater),
+      },
+      table_resetRowPinning: {
+        fn: (defaultState) => table_resetRowPinning(table, defaultState),
+      },
+      table_getIsSomeRowsPinned: {
+        fn: (position) => table_getIsSomeRowsPinned(table, position),
+      },
+      table_getTopRows: {
+        fn: () => table_getTopRows(table),
+        memoDeps: () => [
+          table.getRowModel().rows,
+          table.atoms.rowPinning?.get()?.top,
+        ],
+      },
+      table_getBottomRows: {
+        fn: () => table_getBottomRows(table),
+        memoDeps: () => [
+          table.getRowModel().rows,
+          table.atoms.rowPinning?.get()?.bottom,
+        ],
+      },
+      table_getCenterRows: {
+        fn: () => table_getCenterRows(table),
+        memoDeps: () => [
+          table.getRowModel().rows,
+          table.atoms.rowPinning?.get(),
+        ],
+      },
+    })
+  },
 }
-
-/**
- * The stock row pinning feature.
- *
- * Register this feature to add row pinning state and APIs for deriving top,
- * center, and bottom row regions.
- */
-export const rowPinningFeature = constructRowPinningFeature()

package/src/features/row-pinning/rowPinningFeature.types.ts

@@ -14,8 +14,8 @@ export interface TableState_RowPinning {
 }
 
 export interface TableOptions_RowPinning<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Allows rows to be pinned to top or bottom regions.
@@ -63,8 +63,8 @@ export interface Row_RowPinning {
 }
 
 export interface Table_RowPinning<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Gets rows pinned to the bottom region.

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,
@@ -28,145 +29,134 @@ import {
   table_toggleAllPageRowsSelected,
   table_toggleAllRowsSelected,
 } from './rowSelectionFeature.utils'
-import type { RowData } from '../../types/type-utils'
-import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
-// import type {
-//   Row_RowSelection,
-//   TableOptions_RowSelection,
-//   TableState_RowSelection,
-//   Table_RowSelection,
-// } from './rowSelectionFeature.types'
-
-export interface RowSelectionFeatureConstructors<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
-> {
-  // Row: Row_RowSelection
-  // Table: Table_RowSelection<TFeatures, TData>
-  // TableOptions: TableOptions_RowSelection<TFeatures, TData>
-  // TableState: TableState_RowSelection
-}
+import type { TableFeature } from '../../types/TableFeatures'
 
 /**
- * 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.
+ * Feature that adds row selection state and APIs for row and page selection.
  */
-export function constructRowSelectionFeature<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
->(): TableFeature<RowSelectionFeatureConstructors<TFeatures, TData>> {
-  return {
-    getInitialState: (initialState) => {
-      return {
-        rowSelection: getDefaultRowSelectionState(),
-        ...initialState,
-      }
-    },
+export const rowSelectionFeature: TableFeature = {
+  getInitialState: (initialState) => {
+    return {
+      rowSelection: getDefaultRowSelectionState(),
+      ...initialState,
+    }
+  },
 
-    getDefaultTableOptions: (table) => {
-      return {
-        onRowSelectionChange: makeStateUpdater('rowSelection', table),
-        enableRowSelection: true,
-        enableMultiRowSelection: true,
-        enableSubRowSelection: true,
-      }
-    },
+  getDefaultTableOptions: (table) => {
+    return {
+      onRowSelectionChange: makeStateUpdater('rowSelection', table),
+      enableRowSelection: true,
+      enableMultiRowSelection: true,
+      enableSubRowSelection: true,
+    }
+  },
 
-    assignRowPrototype: (prototype, table) => {
-      assignPrototypeAPIs('rowSelectionFeature', prototype, table, {
-        row_toggleSelected: {
-          fn: (row, value, opts) => row_toggleSelected(row, value, opts),
-        },
-        row_getIsSelected: {
-          fn: (row) => row_getIsSelected(row),
-        },
-        row_getIsSomeSelected: {
-          fn: (row) => row_getIsSomeSelected(row),
-        },
-        row_getIsAllSubRowsSelected: {
-          fn: (row) => row_getIsAllSubRowsSelected(row),
-        },
-        row_getCanSelect: {
-          fn: (row) => row_getCanSelect(row),
-        },
-        row_getCanSelectSubRows: {
-          fn: (row) => row_getCanSelectSubRows(row),
-        },
-        row_getCanMultiSelect: {
-          fn: (row) => row_getCanMultiSelect(row),
-        },
-        row_getToggleSelectedHandler: {
-          fn: (row) => row_getToggleSelectedHandler(row),
-        },
-      })
-    },
+  assignRowPrototype: (prototype, table) => {
+    assignPrototypeAPIs('rowSelectionFeature', prototype, table, {
+      row_toggleSelected: {
+        fn: (row, value, opts) => row_toggleSelected(row, value, opts),
+      },
+      row_getIsSelected: {
+        fn: (row) => row_getIsSelected(row),
+      },
+      row_getIsSomeSelected: {
+        fn: (row) => row_getIsSomeSelected(row),
+      },
+      row_getIsAllSubRowsSelected: {
+        fn: (row) => row_getIsAllSubRowsSelected(row),
+      },
+      row_getCanSelect: {
+        fn: (row) => row_getCanSelect(row),
+      },
+      row_getCanSelectSubRows: {
+        fn: (row) => row_getCanSelectSubRows(row),
+      },
+      row_getCanMultiSelect: {
+        fn: (row) => row_getCanMultiSelect(row),
+      },
+      row_getToggleSelectedHandler: {
+        fn: (row) => row_getToggleSelectedHandler(row),
+      },
+    })
+  },
 
-    constructTableAPIs: (table) => {
-      assignTableAPIs('rowSelectionFeature', table, {
-        table_setRowSelection: {
-          fn: (updater) => table_setRowSelection(table, updater),
-        },
-        table_resetRowSelection: {
-          fn: (defaultState) => table_resetRowSelection(table, defaultState),
-        },
-        table_toggleAllRowsSelected: {
-          fn: (value) => table_toggleAllRowsSelected(table, value),
-        },
-        table_toggleAllPageRowsSelected: {
-          fn: (value) => table_toggleAllPageRowsSelected(table, value),
-        },
-        table_getPreSelectedRowModel: {
-          fn: () => table_getPreSelectedRowModel(table),
-        },
-        table_getSelectedRowModel: {
-          fn: () => table_getSelectedRowModel(table),
-          memoDeps: () => [
-            table.atoms.rowSelection?.get(),
-            table.getCoreRowModel(),
-          ],
-        },
-        table_getFilteredSelectedRowModel: {
-          fn: () => table_getFilteredSelectedRowModel(table),
-          memoDeps: () => [
-            table.atoms.rowSelection?.get(),
-            table.getFilteredRowModel(),
-          ],
-        },
-        table_getGroupedSelectedRowModel: {
-          fn: () => table_getGroupedSelectedRowModel(table),
-          memoDeps: () => [
-            table.atoms.rowSelection?.get(),
-            table.getSortedRowModel(),
-          ],
-        },
-        table_getIsAllRowsSelected: {
-          fn: () => table_getIsAllRowsSelected(table),
-        },
-        table_getIsAllPageRowsSelected: {
-          fn: () => table_getIsAllPageRowsSelected(table),
-        },
-        table_getIsSomeRowsSelected: {
-          fn: () => table_getIsSomeRowsSelected(table),
-        },
-        table_getIsSomePageRowsSelected: {
-          fn: () => table_getIsSomePageRowsSelected(table),
-        },
-        table_getToggleAllRowsSelectedHandler: {
-          fn: () => table_getToggleAllRowsSelectedHandler(table),
-        },
-        table_getToggleAllPageRowsSelectedHandler: {
-          fn: () => table_getToggleAllPageRowsSelectedHandler(table),
-        },
-      })
-    },
-  }
+  constructTableAPIs: (table) => {
+    assignTableAPIs('rowSelectionFeature', table, {
+      table_setRowSelection: {
+        fn: (updater) => table_setRowSelection(table, updater),
+      },
+      table_resetRowSelection: {
+        fn: (defaultState) => table_resetRowSelection(table, defaultState),
+      },
+      table_toggleAllRowsSelected: {
+        fn: (value, opts) => table_toggleAllRowsSelected(table, value, opts),
+      },
+      table_toggleAllPageRowsSelected: {
+        fn: (value, opts) =>
+          table_toggleAllPageRowsSelected(table, value, opts),
+      },
+      table_getPreSelectedRowModel: {
+        fn: () => table_getPreSelectedRowModel(table),
+      },
+      table_getSelectedRowModel: {
+        fn: () => table_getSelectedRowModel(table),
+        memoDeps: () => [
+          table.atoms.rowSelection?.get(),
+          table.getCoreRowModel(),
+        ],
+      },
+      table_getFilteredSelectedRowModel: {
+        fn: () => table_getFilteredSelectedRowModel(table),
+        memoDeps: () => [
+          table.atoms.rowSelection?.get(),
+          table.getFilteredRowModel(),
+        ],
+      },
+      table_getGroupedSelectedRowModel: {
+        fn: () => table_getGroupedSelectedRowModel(table),
+        memoDeps: () => [
+          table.atoms.rowSelection?.get(),
+          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),
+      },
+      table_getToggleAllPageRowsSelectedHandler: {
+        fn: () => table_getToggleAllPageRowsSelectedHandler(table),
+      },
+    })
+  },
 }
-
-/**
- * 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.
- */
-export const rowSelectionFeature = constructRowSelectionFeature()

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

@@ -3,15 +3,15 @@ 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>
 
 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,
 > {
   /**
    * Allows rows to be selected alongside other rows.
@@ -87,8 +87,8 @@ export interface Row_RowSelection {
 }
 
 export interface Table_RowSelection<
-  TFeatures extends TableFeatures,
-  TData extends RowData,
+  in out TFeatures extends TableFeatures,
+  in out TData extends RowData,
 > {
   /**
    * Builds a selected-row model from rows after filtering.
@@ -98,6 +98,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 +147,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
 }