@tanstack/react-table 8.0.0-alpha.1 → 8.0.0-alpha.16

package/src/features/Visibility.ts

@@ -1,281 +0,0 @@
-import {
-  Cell,
-  Column,
-  Getter,
-  OnChangeFn,
-  PropGetterValue,
-  ReactTable,
-  Updater,
-} from '../types'
-import { functionalUpdate, makeStateUpdater, memo, propGetter } from '../utils'
-
-export type VisibilityOptions = {
-  onColumnVisibilityChange?: OnChangeFn<VisibilityState>
-  enableHiding?: boolean
-}
-
-export type VisibilityDefaultOptions = {
-  onColumnVisibilityChange: OnChangeFn<VisibilityState>
-}
-
-export type VisibilityState = Record<string, boolean>
-
-export type VisibilityTableState = {
-  columnVisibility: VisibilityState
-}
-
-export type VisibilityInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  getVisibleFlatColumns: () => Column<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  getVisibleLeafColumns: () => Column<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-  setColumnVisibility: (updater: Updater<VisibilityState>) => void
-  toggleColumnVisibility: (columnId: string, value?: boolean) => void
-  toggleAllColumnsVisible: (value?: boolean) => void
-  getColumnIsVisible: (columId: string) => boolean
-  getColumnCanHide: (columnId: string) => boolean
-  getIsAllColumnsVisible: () => boolean
-  getIsSomeColumnsVisible: () => boolean
-  getToggleAllColumnsVisibilityProps: <
-    TGetter extends Getter<ToggleAllColumnsVisibilityProps>
-  >(
-    userProps?: TGetter
-  ) => undefined | PropGetterValue<ToggleAllColumnsVisibilityProps, TGetter>
-}
-
-type ToggleVisibilityProps = {}
-type ToggleAllColumnsVisibilityProps = {}
-
-export type VisibilityColumnDef = {
-  enableHiding?: boolean
-  defaultCanHide?: boolean
-}
-
-export type VisibilityRow<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
-> = {
-  getVisibleCells: () => Cell<
-    TData,
-    TValue,
-    TFilterFns,
-    TSortingFns,
-    TAggregationFns
-  >[]
-}
-
-export type VisibilityColumn = {
-  getCanHide: () => boolean
-  getIsVisible: () => boolean
-  toggleVisibility: (value?: boolean) => void
-  getToggleVisibilityProps: <TGetter extends Getter<ToggleVisibilityProps>>(
-    userProps?: TGetter
-  ) => PropGetterValue<ToggleVisibilityProps, TGetter>
-}
-
-//
-
-export function getInitialState(): VisibilityTableState {
-  return {
-    columnVisibility: {},
-  }
-}
-
-export function getDefaultOptions<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): VisibilityDefaultOptions {
-  return {
-    onColumnVisibilityChange: makeStateUpdater('columnVisibility', instance),
-  }
-}
-
-export function getDefaultColumn() {
-  return {
-    defaultIsVisible: true,
-  }
-}
-
-export function createColumn<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  column: Column<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>,
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): VisibilityColumn {
-  return {
-    getCanHide: () => instance.getColumnCanHide(column.id),
-    getIsVisible: () => instance.getColumnIsVisible(column.id),
-    toggleVisibility: value =>
-      instance.toggleColumnVisibility(column.id, value),
-    getToggleVisibilityProps: userProps => {
-      const props: ToggleVisibilityProps = {
-        type: 'checkbox',
-        checked: column.getIsVisible?.(),
-        title: 'Toggle Column Visibility',
-        onChange: (e: MouseEvent | TouchEvent) => {
-          column.toggleVisibility?.((e.target as HTMLInputElement).checked)
-        },
-      }
-
-      return propGetter(props, userProps)
-    },
-  }
-}
-
-export function getInstance<
-  TData,
-  TValue,
-  TFilterFns,
-  TSortingFns,
-  TAggregationFns
->(
-  instance: ReactTable<TData, TValue, TFilterFns, TSortingFns, TAggregationFns>
-): VisibilityInstance<TData, TValue, TFilterFns, TSortingFns, TAggregationFns> {
-  return {
-    getVisibleFlatColumns: memo(
-      () => [
-        instance.getAllFlatColumns(),
-        instance
-          .getAllFlatColumns()
-          .filter(d => d.getIsVisible?.())
-          .map(d => d.id)
-          .join('_'),
-      ],
-      allFlatColumns => {
-        return allFlatColumns.filter(d => d.getIsVisible?.())
-      },
-      'getVisibleFlatColumns',
-      instance.options.debug
-    ),
-
-    getVisibleLeafColumns: memo(
-      () => [
-        instance.getAllLeafColumns(),
-        instance
-          .getAllLeafColumns()
-          .filter(d => d.getIsVisible?.())
-          .map(d => d.id)
-          .join('_'),
-      ],
-      allFlatColumns => {
-        return allFlatColumns.filter(d => d.getIsVisible?.())
-      },
-      'getVisibleLeafColumns',
-      instance.options.debug
-    ),
-
-    setColumnVisibility: updater =>
-      instance.options.onColumnVisibilityChange?.(
-        updater,
-        functionalUpdate(updater, instance.getState().columnVisibility)
-      ),
-
-    toggleColumnVisibility: (columnId, value) => {
-      if (!columnId) return
-
-      if (instance.getColumnCanHide(columnId)) {
-        instance.setColumnVisibility(old => ({
-          ...old,
-          [columnId]: value ?? !instance.getColumnIsVisible(columnId),
-        }))
-      }
-    },
-
-    toggleAllColumnsVisible: value => {
-      value = value ?? !instance.getIsAllColumnsVisible()
-
-      instance.setColumnVisibility(
-        instance.getAllLeafColumns().reduce(
-          (obj, column) => ({
-            ...obj,
-            [column.id]: !value ? !column.getCanHide?.() : value,
-          }),
-          {}
-        )
-      )
-    },
-
-    getColumnIsVisible: columnId => {
-      const column = instance.getColumn(columnId)
-
-      if (!column) {
-        throw new Error()
-      }
-
-      return (
-        instance.getState().columnVisibility?.[columnId] ??
-        column.defaultIsVisible ??
-        true
-      )
-    },
-
-    getColumnCanHide: columnId => {
-      const column = instance.getColumn(columnId)
-
-      if (!column) {
-        throw new Error()
-      }
-
-      return (
-        instance.options.enableHiding ??
-        column.enableHiding ??
-        column.defaultCanHide ??
-        true
-      )
-    },
-
-    getIsAllColumnsVisible: () =>
-      !instance.getAllLeafColumns().some(column => !column.getIsVisible?.()),
-
-    getIsSomeColumnsVisible: () =>
-      instance.getAllLeafColumns().some(column => column.getIsVisible?.()),
-
-    getToggleAllColumnsVisibilityProps: userProps => {
-      const props: ToggleAllColumnsVisibilityProps = {
-        onChange: (e: MouseEvent) => {
-          instance.toggleAllColumnsVisible(
-            (e.target as HTMLInputElement)?.checked
-          )
-        },
-        type: 'checkbox',
-        title: 'Toggle visibility for all columns',
-        checked: instance.getIsAllColumnsVisible(),
-        indeterminate:
-          !instance.getIsAllColumnsVisible() &&
-          instance.getIsSomeColumnsVisible()
-            ? 'indeterminate'
-            : undefined,
-      }
-
-      return propGetter(props, userProps)
-    },
-  }
-}

package/src/features/withColumnResizing.oldts

@@ -1,281 +0,0 @@
-import React, {
-  ComponentProps,
-  MouseEvent as ReactMouseEvent,
-  PropsWithoutRef,
-  PropsWithRef,
-  TouchEvent as ReactTouchEvent,
-} from 'react'
-
-import { getLeafHeaders, makeStateUpdater } from '../utils'
-
-import { withColumnResizing as name, withColumnVisibility } from '../Constants'
-import {
-  ColumnId,
-  ColumnResizing,
-  ReduceColumn,
-  ReduceHeader,
-  Header,
-  MakeInstance,
-  GetDefaultOptions,
-} from '../types'
-
-let passiveSupported: boolean | null = null
-
-export function passiveEventSupported() {
-  // memoize support to avoid adding multiple test events
-  if (typeof passiveSupported === 'boolean') return passiveSupported
-
-  let supported = false
-  try {
-    const options = {
-      get passive() {
-        supported = true
-        return false
-      },
-    }
-
-    window.addEventListener('test', noop, options)
-    window.removeEventListener('test', noop)
-  } catch (err) {
-    supported = false
-  }
-  passiveSupported = supported
-  return passiveSupported
-}
-
-const getDefaultOptions: GetDefaultOptions = options => {
-  return {
-    onColumnResizingChange: React.useCallback(
-      makeStateUpdater('columnResizing'),
-      []
-    ),
-    ...options,
-    initialState: {
-      columnResizing: {
-        columnWidths: {},
-      },
-      ...options.initialState,
-    },
-  }
-}
-
-const extendInstance: MakeInstance = instance => {
-  instance.setColumnResizing = React.useCallback(
-    updater => instance.options.onColumnResizingChange?.(updater, instance),
-    [instance]
-  )
-
-  instance.getColumnCanResize = React.useCallback(
-    columnId => {
-      const column = instance.allColumns.find(d => d.id === columnId)
-
-      if (!column) return false
-
-      return (
-        (column.disableResizing ? false : undefined) ??
-        (instance.options?.disableResizing ? false : undefined) ??
-        column.defaultCanResize ??
-        true
-      )
-    },
-    [instance.allColumns, instance.options.disableResizing]
-  )
-
-  instance.getColumnWidth = React.useCallback(
-    columnId => {
-      if (!columnId) return 0
-      const { allColumns } = instance
-      const column = allColumns.find(d => d.id === columnId)
-      const columnWidths = instance.state.columnResizing?.columnWidths
-
-      if (!column) return 0
-
-      return Math.min(
-        Math.max(
-          column?.minWidth ?? 0,
-          (columnWidths?.[columnId] ?? 0) || (column.width ?? 0)
-        ),
-        column.maxWidth ?? 0
-      )
-    },
-    [instance]
-  )
-
-  const isResizingColumn = instance.state.columnResizing?.isResizingColumn
-  instance.getColumnIsResizing = React.useCallback(
-    columnId => {
-      return isResizingColumn === columnId
-    },
-    [isResizingColumn]
-  )
-
-  return instance
-}
-
-const reduceColumn: ReduceColumn = (column, { instance }) => {
-  column.getIsResizing = () => instance.getColumnIsResizing(column.id)
-  column.getCanResize = () => instance.getColumnCanResize(column.id)
-
-  return column
-}
-
-const reduceHeader: ReduceHeader = (header, { instance }) => {
-  header.getIsResizing = () =>
-    header?.column?.getIsResizing ? header.column.getIsResizing() : true
-  header.getCanResize = () =>
-    header?.column?.getCanResize ? header.column.getCanResize() : true
-
-  function isTouchStartEvent(
-    e: ReactTouchEvent | ReactMouseEvent
-  ): e is ReactTouchEvent {
-    return e.type === 'touchstart'
-  }
-
-  header.getResizerProps = (props = {}) => {
-    const onResizeStart = (
-      e: ReactMouseEvent | ReactTouchEvent,
-      header: Header
-    ) => {
-      if (isTouchStartEvent(e)) {
-        // lets not respond to multiple touches (e.g. 2 or 3 fingers)
-        if (e.touches && e.touches.length > 1) {
-          return
-        }
-      }
-      const headersToResize = getLeafHeaders(header)
-      const headerIdWidths: [ColumnId, number][] = headersToResize.map(d => [
-        d.id,
-        d.getWidth(),
-      ])
-
-      const clientX = isTouchStartEvent(e)
-        ? Math.round(e.touches[0].clientX)
-        : e.clientX
-
-      const onMove = (clientXPos?: number) => {
-        if (typeof clientXPos !== 'number') {
-          return
-        }
-
-        return instance.setColumnResizing(old => {
-          const deltaX = clientXPos - (old?.startX ?? 0)
-          const percentageDeltaX = Math.max(
-            deltaX / (old?.columnWidth ?? 0),
-            -0.999999
-          )
-
-          const newColumnWidths: ColumnResizing['columnWidths'] = {}
-          ;(old?.headerIdWidths ?? []).forEach(([headerId, headerWidth]) => {
-            newColumnWidths[headerId] = Math.max(
-              headerWidth + headerWidth * percentageDeltaX,
-              0
-            )
-          })
-
-          return {
-            ...old,
-            columnWidths: {
-              ...(old?.columnWidths ?? {}),
-              ...newColumnWidths,
-            },
-          }
-        })
-      }
-
-      const onEnd = () =>
-        instance.setColumnResizing(old => ({
-          ...old,
-          startX: null,
-          isResizingColumn: false,
-        }))
-
-      const mouseEvents = {
-        moveHandler: (e: MouseEvent) => onMove(e.clientX),
-        upHandler: () => {
-          document.removeEventListener('mousemove', mouseEvents.moveHandler)
-          document.removeEventListener('mouseup', mouseEvents.upHandler)
-          onEnd()
-        },
-      }
-
-      const touchEvents = {
-        moveHandler: (e: TouchEvent) => {
-          if (e.cancelable) {
-            e.preventDefault()
-            e.stopPropagation()
-          }
-          onMove(e.touches[0].clientX)
-          return false
-        },
-        upHandler: () => {
-          document.removeEventListener('touchmove', touchEvents.moveHandler)
-          document.removeEventListener('touchend', touchEvents.upHandler)
-          onEnd()
-        },
-      }
-
-      const passiveIfSupported = passiveEventSupported()
-        ? { passive: false }
-        : false
-
-      if (isTouchStartEvent(e)) {
-        document.addEventListener(
-          'touchmove',
-          touchEvents.moveHandler,
-          passiveIfSupported
-        )
-        document.addEventListener(
-          'touchend',
-          touchEvents.upHandler,
-          passiveIfSupported
-        )
-      } else {
-        document.addEventListener(
-          'mousemove',
-          mouseEvents.moveHandler,
-          passiveIfSupported
-        )
-        document.addEventListener(
-          'mouseup',
-          mouseEvents.upHandler,
-          passiveIfSupported
-        )
-      }
-
-      instance.setColumnResizing(old => ({
-        ...old,
-        startX: clientX,
-        headerIdWidths,
-        columnWidth: header.getWidth(),
-        isResizingColumn: header.id,
-      }))
-    }
-
-    return {
-      onMouseDown: (e: ReactMouseEvent) => {
-        e.persist()
-        onResizeStart(e, header)
-      },
-      onTouchStart: (e: ReactTouchEvent) => {
-        e.persist()
-        onResizeStart(e, header)
-      },
-      draggable: false,
-      role: 'separator',
-      ...props,
-    }
-  }
-
-  return header
-}
-
-export const withColumnResizing = {
-  name,
-  after: [withColumnVisibility],
-  plugs: {
-    getDefaultOptions,
-    extendInstance,
-    reduceColumn,
-    reduceHeader,
-  },
-}