@tanstack/react-table 8.0.0-alpha.9 → 8.0.0-beta.0

package/src/features/RowSelection.ts

@@ -1,651 +0,0 @@
-import React, { MouseEvent, TouchEvent } from 'react'
-import {
-  Getter,
-  OnChangeFn,
-  PartialGenerics,
-  PropGetterValue,
-  TableInstance,
-  Row,
-  RowModel,
-  Updater,
-} from '../types'
-import { functionalUpdate, makeStateUpdater, memo, propGetter } from '../utils'
-
-export type RowSelectionState = Record<string, boolean>
-
-export type RowSelectionTableState = {
-  rowSelection: RowSelectionState
-}
-
-export type RowSelectionOptions<TGenerics extends PartialGenerics> = {
-  onRowSelectionChange?: OnChangeFn<RowSelectionState>
-  autoResetRowSelection?: boolean
-  enableRowSelection?: boolean | ((row: Row<TGenerics>) => boolean)
-  enableMultiRowSelection?: boolean | ((row: Row<TGenerics>) => boolean)
-  enableSubRowSelection?: boolean | ((row: Row<TGenerics>) => boolean)
-  // enableGroupingRowSelection?:
-  //   | boolean
-  //   | ((
-  //       row: Row<TGenerics>
-  //     ) => boolean)
-  // isAdditiveSelectEvent?: (e: MouseEvent | TouchEvent) => boolean
-  // isInclusiveSelectEvent?: (e: MouseEvent | TouchEvent) => boolean
-  // selectRowsFn?: (
-  //   instance: TableInstance<
-  //     TData,
-  //     TValue,
-  //     TFilterFns,
-  //     TSortingFns,
-  //     TAggregationFns
-  //   >,
-  //   rowModel: RowModel<TGenerics>
-  // ) => RowModel<TGenerics>
-}
-
-type ToggleRowSelectedProps = {
-  onChange?: (e: MouseEvent | TouchEvent) => void
-  checked?: boolean
-  title?: string
-  indeterminate?: boolean
-}
-
-export type RowSelectionRow = {
-  getIsSelected: () => boolean
-  getIsSomeSelected: () => boolean
-  getCanSelect: () => boolean
-  getCanMultiSelect: () => boolean
-  toggleSelected: (value?: boolean) => void
-  getToggleSelectedProps: <TGetter extends Getter<ToggleRowSelectedProps>>(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleRowSelectedProps, TGetter>
-}
-
-export type RowSelectionInstance<TGenerics extends PartialGenerics> = {
-  _notifyRowSelectionReset: () => void
-  getToggleRowSelectedProps: <TGetter extends Getter<ToggleRowSelectedProps>>(
-    rowId: string,
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleRowSelectedProps, TGetter>
-  getToggleAllRowsSelectedProps: <
-    TGetter extends Getter<ToggleRowSelectedProps>
-  >(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleRowSelectedProps, TGetter>
-  getToggleAllPageRowsSelectedProps: <
-    TGetter extends Getter<ToggleRowSelectedProps>
-  >(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleRowSelectedProps, TGetter>
-  setRowSelection: (updater: Updater<RowSelectionState>) => void
-  resetRowSelection: () => void
-  toggleRowSelected: (rowId: string, value?: boolean) => void
-  getRowCanSelect: (rowId: string) => boolean
-  getRowCanSelectSubRows: (rowId: string) => boolean
-  getRowCanMultiSelect: (rowId: string) => boolean
-  // getGroupingRowCanSelect: (rowId: string) => boolean
-  getRowIsSelected: (rowId: string) => boolean
-  getRowIsSomeSelected: (rowId: string) => boolean
-  getIsAllRowsSelected: () => boolean
-  getIsAllPageRowsSelected: () => boolean
-  getIsSomeRowsSelected: () => boolean
-  getIsSomePageRowsSelected: () => boolean
-  toggleAllRowsSelected: (value: boolean) => void
-  toggleAllPageRowsSelected: (value: boolean) => void
-  getPreSelectedRowModel: () => RowModel<TGenerics>
-  getSelectedRowModel: () => RowModel<TGenerics>
-  getFilteredSelectedRowModel: () => RowModel<TGenerics>
-  getGroupedSelectedRowModel: () => RowModel<TGenerics>
-}
-
-//
-
-export function getInitialState(): RowSelectionTableState {
-  return {
-    rowSelection: {},
-  }
-}
-
-export function getDefaultOptions<TGenerics extends PartialGenerics>(
-  instance: TableInstance<TGenerics>
-): RowSelectionOptions<TGenerics> {
-  return {
-    onRowSelectionChange: makeStateUpdater('rowSelection', instance),
-    autoResetRowSelection: true,
-    enableRowSelection: true,
-    enableMultiRowSelection: true,
-    enableSubRowSelection: true,
-    // enableGroupingRowSelection: false,
-    // isAdditiveSelectEvent: (e: MouseEvent | TouchEvent) => !!e.metaKey,
-    // isInclusiveSelectEvent: (e: MouseEvent | TouchEvent) => !!e.shiftKey,
-  }
-}
-
-export function getInstance<TGenerics extends PartialGenerics>(
-  instance: TableInstance<TGenerics>
-): RowSelectionInstance<TGenerics> {
-  let registered = false
-
-  // const pageRows = instance.getPageRows()
-
-  return {
-    _notifyRowSelectionReset: () => {
-      if (!registered) {
-        registered = true
-        return
-      }
-
-      if (instance.options.autoResetAll === false) {
-        return
-      }
-
-      if (
-        instance.options.autoResetAll === true ||
-        instance.options.autoResetRowSelection
-      ) {
-        instance.resetRowSelection()
-      }
-    },
-    setRowSelection: updater =>
-      instance.options.onRowSelectionChange?.(
-        updater,
-        functionalUpdate(updater, instance.getState().rowSelection)
-      ),
-    resetRowSelection: () =>
-      instance.setRowSelection(getInitialState().rowSelection ?? {}),
-    toggleAllRowsSelected: value => {
-      instance.setRowSelection(old => {
-        value =
-          typeof value !== 'undefined'
-            ? value
-            : !instance.getIsAllRowsSelected()
-
-        // Only remove/add the rows that are visible on the screen
-        //  Leave all the other rows that are selected alone.
-        const rowSelection = Object.assign({}, old)
-
-        const preGroupedFlatRows = instance.getPreGroupedRowModel().flatRows
-
-        // We don't use `mutateRowIsSelected` here for performance reasons.
-        // All of the rows are flat already, so it wouldn't be worth it
-        if (value) {
-          preGroupedFlatRows.forEach(row => {
-            rowSelection[row.id] = true
-          })
-        } else {
-          preGroupedFlatRows.forEach(row => {
-            delete rowSelection[row.id]
-          })
-        }
-
-        return rowSelection
-      })
-    },
-    toggleAllPageRowsSelected: value =>
-      instance.setRowSelection(old => {
-        const selectAll =
-          typeof value !== 'undefined'
-            ? value
-            : !instance.getIsAllPageRowsSelected()
-
-        const rowSelection: RowSelectionState = { ...old }
-
-        instance.getRowModel().rows.forEach(row => {
-          mutateRowIsSelected(rowSelection, row.id, value, instance)
-        })
-
-        return rowSelection
-      }),
-    toggleRowSelected: (rowId, value) => {
-      const row = instance.getRow(rowId)
-      const isSelected = row.getIsSelected()
-
-      instance.setRowSelection(old => {
-        value = typeof value !== 'undefined' ? value : !isSelected
-
-        if (isSelected === value) {
-          return old
-        }
-
-        const selectedRowIds = { ...old }
-
-        mutateRowIsSelected(selectedRowIds, rowId, value, instance)
-
-        return selectedRowIds
-      })
-    },
-    // addRowSelectionRange: rowId => {
-    //   const {
-    //     rows,
-    //     rowsById,
-    //     options: { selectGroupingRows, selectSubRows },
-    //   } = instance
-
-    //   const findSelectedRow = (rows: Row[]) => {
-    //     let found
-    //     rows.find(d => {
-    //       if (d.getIsSelected()) {
-    //         found = d
-    //         return true
-    //       }
-    //       const subFound = findSelectedRow(d.subRows || [])
-    //       if (subFound) {
-    //         found = subFound
-    //         return true
-    //       }
-    //       return false
-    //     })
-    //     return found
-    //   }
-
-    //   const firstRow = findSelectedRow(rows) || rows[0]
-    //   const lastRow = rowsById[rowId]
-
-    //   let include = false
-    //   const selectedRowIds = {}
-
-    //   const addRow = (row: Row) => {
-    //     mutateRowIsSelected(selectedRowIds, row.id, true, {
-    //       rowsById,
-    //       selectGroupingRows: selectGroupingRows!,
-    //       selectSubRows: selectSubRows!,
-    //     })
-    //   }
-
-    //   instance.rows.forEach(row => {
-    //     const isFirstRow = row.id === firstRow.id
-    //     const isLastRow = row.id === lastRow.id
-
-    //     if (isFirstRow || isLastRow) {
-    //       if (!include) {
-    //         include = true
-    //       } else if (include) {
-    //         addRow(row)
-    //         include = false
-    //       }
-    //     }
-
-    //     if (include) {
-    //       addRow(row)
-    //     }
-    //   })
-
-    //   instance.setRowSelection(selectedRowIds)
-    // },
-    getPreSelectedRowModel: () => instance.getCoreRowModel(),
-    getSelectedRowModel: memo(
-      () => [instance.getState().rowSelection, instance.getCoreRowModel()],
-      (rowSelection, rowModel) => {
-        if (!Object.keys(rowSelection).length) {
-          return {
-            rows: [],
-            flatRows: [],
-            rowsById: {},
-          }
-        }
-
-        return selectRowsFn(instance, rowModel)
-      },
-      {
-        key: 'getSelectedRowModel',
-        debug: () => instance.options.debugAll ?? instance.options.debugTable,
-        onChange: () => instance._notifyExpandedReset(),
-      }
-    ),
-
-    getFilteredSelectedRowModel: memo(
-      () => [
-        instance.getState().rowSelection,
-        instance.getGlobalFilteredRowModel(),
-      ],
-      (rowSelection, rowModel) => {
-        if (!Object.keys(rowSelection).length) {
-          return {
-            rows: [],
-            flatRows: [],
-            rowsById: {},
-          }
-        }
-
-        return selectRowsFn(instance, rowModel)
-      },
-      {
-        key: 'getFilteredSelectedRowModel',
-        debug: () => instance.options.debugAll ?? instance.options.debugTable,
-        onChange: () => instance._notifyExpandedReset(),
-      }
-    ),
-
-    getGroupedSelectedRowModel: memo(
-      () => [instance.getState().rowSelection, instance.getGroupedRowModel()],
-      (rowSelection, rowModel) => {
-        if (!Object.keys(rowSelection).length) {
-          return {
-            rows: [],
-            flatRows: [],
-            rowsById: {},
-          }
-        }
-
-        return selectRowsFn(instance, rowModel)
-      },
-      {
-        key: 'getGroupedSelectedRowModel',
-        debug: () => instance.options.debugAll ?? instance.options.debugTable,
-        onChange: () => instance._notifyExpandedReset(),
-      }
-    ),
-
-    ///
-
-    getRowIsSelected: rowId => {
-      const { rowSelection } = instance.getState()
-      const row = instance.getRow(rowId)
-
-      if (!row) {
-        throw new Error()
-      }
-
-      return isRowSelected(row, rowSelection, instance) === true
-    },
-
-    getRowIsSomeSelected: rowId => {
-      const { rowSelection } = instance.getState()
-      const row = instance.getRow(rowId)
-
-      if (!row) {
-        throw new Error()
-      }
-
-      return isRowSelected(row, rowSelection, instance) === 'some'
-    },
-
-    getRowCanSelect: rowId => {
-      const row = instance.getRow(rowId)
-
-      if (!row) {
-        throw new Error()
-      }
-
-      if (typeof instance.options.enableRowSelection === 'function') {
-        return instance.options.enableRowSelection(row)
-      }
-
-      return instance.options.enableRowSelection ?? true
-    },
-
-    getRowCanSelectSubRows: rowId => {
-      const row = instance.getRow(rowId)
-
-      if (!row) {
-        throw new Error()
-      }
-
-      if (typeof instance.options.enableSubRowSelection === 'function') {
-        return instance.options.enableSubRowSelection(row)
-      }
-
-      return instance.options.enableSubRowSelection ?? true
-    },
-
-    getRowCanMultiSelect: rowId => {
-      const row = instance.getRow(rowId)
-
-      if (!row) {
-        throw new Error()
-      }
-
-      if (typeof instance.options.enableMultiRowSelection === 'function') {
-        return instance.options.enableMultiRowSelection(row)
-      }
-
-      return instance.options.enableMultiRowSelection ?? true
-    },
-
-    // getGroupingRowCanSelect: rowId => {
-    //   const row = instance.getRow(rowId)
-
-    //   if (!row) {
-    //     throw new Error()
-    //   }
-
-    //   if (typeof instance.options.enableGroupingRowSelection === 'function') {
-    //     return instance.options.enableGroupingRowSelection(row)
-    //   }
-
-    //   return instance.options.enableGroupingRowSelection ?? false
-    // },
-
-    getIsAllRowsSelected: () => {
-      const preFilteredFlatRows =
-        instance.getPreGlobalFilteredRowModel().flatRows
-      const { rowSelection } = instance.getState()
-
-      let isAllRowsSelected = Boolean(
-        preFilteredFlatRows.length && Object.keys(rowSelection).length
-      )
-
-      if (isAllRowsSelected) {
-        if (preFilteredFlatRows.some(row => !rowSelection[row.id])) {
-          isAllRowsSelected = false
-        }
-      }
-
-      return isAllRowsSelected
-    },
-
-    getIsAllPageRowsSelected: () => {
-      const paginationFlatRows = instance.getPaginationRowModel().flatRows
-      const { rowSelection } = instance.getState()
-
-      let isAllPageRowsSelected = !!paginationFlatRows.length
-
-      if (
-        isAllPageRowsSelected &&
-        paginationFlatRows.some(row => !rowSelection[row.id])
-      ) {
-        isAllPageRowsSelected = false
-      }
-
-      return isAllPageRowsSelected
-    },
-
-    getIsSomeRowsSelected: () => {
-      return (
-        !instance.getIsAllRowsSelected() &&
-        !!Object.keys(instance.getState().rowSelection ?? {}).length
-      )
-    },
-
-    getIsSomePageRowsSelected: () => {
-      const paginationFlatRows = instance.getPaginationRowModel().flatRows
-      return instance.getIsAllPageRowsSelected()
-        ? false
-        : !!paginationFlatRows?.length
-    },
-
-    getToggleRowSelectedProps: (rowId, userProps) => {
-      const row = instance.getRow(rowId)
-
-      const isSelected = row.getIsSelected()
-      const isSomeSelected = row.getIsSomeSelected()
-      const canSelect = row.getCanSelect()
-
-      const initialProps: ToggleRowSelectedProps = {
-        onChange: canSelect
-          ? (e: MouseEvent | TouchEvent) => {
-              row.toggleSelected((e.target as HTMLInputElement).checked)
-            }
-          : undefined,
-        checked: isSelected,
-        title: 'Toggle Row Selected',
-        indeterminate: isSomeSelected,
-        // onChange: forInput
-        //   ? (e: Event) => e.stopPropagation()
-        //   : (e: Event) => {
-        //       if (instance.options.isAdditiveSelectEvent(e)) {
-        //         row.toggleSelected()
-        //       } else if (instance.options.isInclusiveSelectEvent(e)) {
-        //         instance.addRowSelectionRange(row.id)
-        //       } else {
-        //         instance.setRowSelection({})
-        //         row.toggleSelected()
-        //       }
-
-        //       if (props.onClick) props.onClick(e)
-        //     },
-      }
-
-      return propGetter(initialProps, userProps)
-    },
-
-    getToggleAllRowsSelectedProps: userProps => {
-      const isSomeRowsSelected = instance.getIsSomeRowsSelected()
-      const isAllRowsSelected = instance.getIsAllRowsSelected()
-
-      const initialProps: ToggleRowSelectedProps = {
-        onChange: (e: MouseEvent | TouchEvent) => {
-          instance.toggleAllRowsSelected((e.target as HTMLInputElement).checked)
-        },
-        checked: isAllRowsSelected,
-        title: 'Toggle All Rows Selected',
-        indeterminate: isSomeRowsSelected,
-      }
-
-      return propGetter(initialProps, userProps)
-    },
-
-    getToggleAllPageRowsSelectedProps: userProps => {
-      const isSomePageRowsSelected = instance.getIsSomePageRowsSelected()
-      const isAllPageRowsSelected = instance.getIsAllPageRowsSelected()
-
-      const initialProps: ToggleRowSelectedProps = {
-        onChange: (e: MouseEvent | TouchEvent) => {
-          instance.toggleAllPageRowsSelected(
-            (e.target as HTMLInputElement).checked
-          )
-        },
-        checked: isAllPageRowsSelected,
-        title: 'Toggle All Current Page Rows Selected',
-        indeterminate: isSomePageRowsSelected,
-      }
-
-      return propGetter(initialProps, userProps)
-    },
-  }
-}
-
-export function createRow<TGenerics extends PartialGenerics>(
-  row: Row<TGenerics>,
-  instance: TableInstance<TGenerics>
-): RowSelectionRow {
-  return {
-    getIsSelected: () => instance.getRowIsSelected(row.id),
-    getIsSomeSelected: () => instance.getRowIsSomeSelected(row.id),
-    toggleSelected: value => instance.toggleRowSelected(row.id, value),
-    getToggleSelectedProps: userProps =>
-      instance.getToggleRowSelectedProps(row.id, userProps),
-    getCanMultiSelect: () => instance.getRowCanMultiSelect(row.id),
-    getCanSelect: () => instance.getRowCanSelect(row.id),
-  }
-}
-
-const mutateRowIsSelected = <TGenerics extends PartialGenerics>(
-  selectedRowIds: Record<string, boolean>,
-  id: string,
-  value: boolean,
-  instance: TableInstance<TGenerics>
-) => {
-  const row = instance.getRow(id)
-
-  const isGrouped = row.getIsGrouped()
-
-  // if ( // TODO: enforce grouping row selection rules
-  //   !isGrouped ||
-  //   (isGrouped && instance.options.enableGroupingRowSelection)
-  // ) {
-  if (value) {
-    selectedRowIds[id] = true
-  } else {
-    delete selectedRowIds[id]
-  }
-  // }
-
-  if (row.subRows?.length && instance.getRowCanSelectSubRows(row.id)) {
-    row.subRows.forEach(row =>
-      mutateRowIsSelected(selectedRowIds, row.id, value, instance)
-    )
-  }
-}
-
-export function selectRowsFn<TGenerics extends PartialGenerics>(
-  instance: TableInstance<TGenerics>,
-  rowModel: RowModel<TGenerics>
-): RowModel<TGenerics> {
-  const rowSelection = instance.getState().rowSelection
-
-  const newSelectedFlatRows: Row<TGenerics>[] = []
-  const newSelectedRowsById: Record<string, Row<TGenerics>> = {}
-
-  // Filters top level and nested rows
-  const recurseRows = (rows: Row<TGenerics>[], depth = 0) => {
-    return rows
-      .map(row => {
-        const isSelected = isRowSelected(row, rowSelection, instance) === true
-
-        if (isSelected) {
-          newSelectedFlatRows.push(row)
-          newSelectedRowsById[row.id] = row
-        }
-
-        if (row.subRows?.length) {
-          row = {
-            ...row,
-            subRows: recurseRows(row.subRows, depth + 1),
-          }
-        }
-
-        if (isSelected) {
-          return row
-        }
-      })
-      .filter(Boolean) as Row<TGenerics>[]
-  }
-
-  return {
-    rows: recurseRows(rowModel.rows),
-    flatRows: newSelectedFlatRows,
-    rowsById: newSelectedRowsById,
-  }
-}
-
-export function isRowSelected<TGenerics extends PartialGenerics>(
-  row: Row<TGenerics>,
-  selection: Record<string, boolean>,
-  instance: TableInstance<TGenerics>
-): boolean | 'some' {
-  if (selection[row.id]) {
-    return true
-  }
-
-  if (row.subRows && row.subRows.length) {
-    let allChildrenSelected = true
-    let someSelected = false
-
-    row.subRows.forEach(subRow => {
-      // Bail out early if we know both of these
-      if (someSelected && !allChildrenSelected) {
-        return
-      }
-
-      if (isRowSelected(subRow, selection, instance)) {
-        someSelected = true
-      } else {
-        allChildrenSelected = false
-      }
-    })
-
-    return allChildrenSelected ? true : someSelected ? 'some' : false
-  }
-
-  return false
-}