@tanstack/table-core 9.0.0-beta.52 → 9.0.0-beta.53

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

@@ -1,195 +0,0 @@
-import type { OnChangeFn, RowData, Updater } from '../../types/type-utils'
-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, 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<
-  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.
-   *
-   * Provide a predicate to decide per row. Defaults to `true`.
-   */
-  enableMultiRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean)
-  /**
-   * Allows rows to be selected.
-   *
-   * Provide a predicate to decide per row. Defaults to `true`.
-   */
-  enableRowSelection?: boolean | ((row: Row<TFeatures, TData>) => boolean)
-  /**
-   * Controls whether selecting a parent row also selects its subRows.
-   *
-   * Provide a predicate to decide per row. This is most useful with expanding or
-   * 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
-   * slice without this callback.
-   */
-  onRowSelectionChange?: OnChangeFn<RowSelectionState>
-  // enableGroupingRowSelection?:
-  //   | boolean
-  //   | ((
-  //       row: Row<TFeatures, TData>
-  //     ) => boolean)
-  // isAdditiveSelectEvent?: (e: unknown) => boolean
-  // selectRowsFn?: (
-  //   table: Table<TFeatures, TData>,
-  //   rowModel: RowModel<TFeatures, TData>
-  // ) => RowModel<TFeatures, TData>
-}
-
-export interface Row_RowSelection {
-  /**
-   * Checks whether this row can be selected alongside other rows.
-   */
-  getCanMultiSelect: () => boolean
-  /**
-   * Checks whether this row can currently be selected.
-   */
-  getCanSelect: () => boolean
-  /**
-   * Checks whether selecting this row should also select its subRows.
-   */
-  getCanSelectSubRows: () => boolean
-  /**
-   * Checks whether all selectable descendants are selected.
-   */
-  getIsAllSubRowsSelected: () => boolean
-  /**
-   * Checks whether this row id is selected.
-   */
-  getIsSelected: () => boolean
-  /**
-   * Checks whether some selectable descendants are selected.
-   */
-  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: (
-    opts?: ToggleSelectedOptions,
-  ) => (event: unknown) => void
-  /**
-   * Selects/deselects the row.
-   */
-  toggleSelected: (value?: boolean, opts?: ToggleSelectedOptions) => void
-}
-
-export interface Table_RowSelection<
-  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.
-   */
-  getFilteredSelectedRowModel: () => RowModel<TFeatures, TData>
-  /**
-   * 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.
-   */
-  getIsAllPageRowsSelected: () => boolean
-  /**
-   * Checks whether every selectable filtered row is selected.
-   */
-  getIsAllRowsSelected: () => boolean
-  /**
-   * Checks whether the current page has a partial row selection.
-   */
-  getIsSomePageRowsSelected: () => boolean
-  /**
-   * Checks whether filtered rows have a partial row selection.
-   */
-  getIsSomeRowsSelected: () => boolean
-  /**
-   * Returns the core row model of all rows before row selection has been applied.
-   */
-  getPreSelectedRowModel: () => RowModel<TFeatures, TData>
-  /**
-   * Builds a selected-row model from the core row model.
-   */
-  getSelectedRowModel: () => RowModel<TFeatures, TData>
-  /**
-   * Creates a checkbox-style handler that toggles all current-page rows.
-   */
-  getToggleAllPageRowsSelectedHandler: () => (event: unknown) => void
-  /**
-   * Creates a checkbox-style handler that toggles all selectable rows.
-   */
-  getToggleAllRowsSelectedHandler: () => (event: unknown) => void
-  /**
-   * Resets `rowSelection` to `initialState.rowSelection`.
-   *
-   * Pass `true` to ignore initial state and reset to `{}`.
-   */
-  resetRowSelection: (defaultState?: boolean) => void
-  /**
-   * Updates row selection state with a next map or updater function.
-   */
-  setRowSelection: (updater: Updater<RowSelectionState>) => void
-  /**
-   * Selects/deselects all rows on the current page.
-   */
-  toggleAllPageRowsSelected: (
-    value?: boolean,
-    opts?: { deselectAll?: boolean },
-  ) => void
-  /**
-   * Selects/deselects all rows in the table.
-   */
-  toggleAllRowsSelected: (
-    value?: boolean,
-    opts?: { deselectAll?: boolean },
-  ) => void
-}