@tanstack/table-core 9.0.0-alpha.4 → 9.0.0-alpha.42

package/src/features/column-resizing/columnResizingFeature.ts

@@ -0,0 +1,92 @@
+import {
+  assignPrototypeAPIs,
+  assignTableAPIs,
+  makeStateUpdater,
+} from '../../utils'
+import {
+  column_getCanResize,
+  column_getIsResizing,
+  getDefaultColumnResizingState,
+  header_getResizeHandler,
+  table_resetHeaderSizeInfo,
+  table_setColumnResizing,
+} from './columnResizingFeature.utils'
+import type { RowData } from '../../types/type-utils'
+import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
+// import type {
+//   Column_ColumnResizing,
+//   Header_ColumnResizing,
+//   TableOptions_ColumnResizing,
+//   TableState_ColumnResizing,
+//   Table_ColumnResizing,
+// } from './columnResizingFeature.types'
+
+export interface ColumnResizingFeatureConstructors<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  // Column: Column_ColumnResizing
+  // Header: Header_ColumnResizing
+  // Table: Table_ColumnResizing
+  // TableOptions: TableOptions_ColumnResizing
+  // TableState: TableState_ColumnResizing
+}
+
+export function constructColumnResizingFeature<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(): TableFeature<ColumnResizingFeatureConstructors<TFeatures, TData>> {
+  return {
+    getInitialState: (initialState) => {
+      return {
+        columnResizing: getDefaultColumnResizingState(),
+        ...initialState,
+      }
+    },
+
+    getDefaultTableOptions: (table) => {
+      return {
+        columnResizeMode: 'onEnd',
+        columnResizeDirection: 'ltr',
+        onColumnResizingChange: makeStateUpdater('columnResizing', table),
+      }
+    },
+
+    assignColumnPrototype: (prototype, table) => {
+      assignPrototypeAPIs('columnResizingFeature', prototype, table, {
+        column_getCanResize: {
+          fn: (column) => column_getCanResize(column),
+        },
+        column_getIsResizing: {
+          fn: (column) => column_getIsResizing(column),
+        },
+      })
+    },
+
+    assignHeaderPrototype: (prototype, table) => {
+      assignPrototypeAPIs('columnResizingFeature', prototype, table, {
+        header_getResizeHandler: {
+          fn: (header, _contextDocument) =>
+            header_getResizeHandler(header, _contextDocument),
+        },
+      })
+    },
+
+    constructTableAPIs: (table) => {
+      assignTableAPIs('columnResizingFeature', table, {
+        table_setColumnResizing: {
+          fn: (updater) => table_setColumnResizing(table, updater),
+        },
+        table_resetHeaderSizeInfo: {
+          fn: (defaultState) => table_resetHeaderSizeInfo(table, defaultState),
+        },
+      })
+    },
+  }
+}
+
+/**
+ * The Column Resizing feature adds column resizing state and APIs to the table and column objects.
+ * **Note:** This is dependent on the Column Sizing feature.
+ */
+export const columnResizingFeature = constructColumnResizingFeature()

package/src/features/column-resizing/columnResizingFeature.types.ts

@@ -0,0 +1,81 @@
+import type { OnChangeFn, Updater } from '../../types/type-utils'
+
+export interface TableState_ColumnResizing {
+  columnResizing: columnResizingState
+}
+
+export interface columnResizingState {
+  columnSizingStart: Array<[string, number]>
+  deltaOffset: null | number
+  deltaPercentage: null | number
+  isResizingColumn: false | string
+  startOffset: null | number
+  startSize: null | number
+}
+
+export type ColumnResizeMode = 'onChange' | 'onEnd'
+
+export type ColumnResizeDirection = 'ltr' | 'rtl'
+
+export interface TableOptions_ColumnResizing {
+  /**
+   * Determines when the columnSizing state is updated. `onChange` updates the state when the user is dragging the resize handle. `onEnd` updates the state when the user releases the resize handle.
+   */
+  columnResizeMode?: ColumnResizeMode
+  /**
+   * Enables or disables column resizing for the column.
+   */
+  enableColumnResizing?: boolean
+  /**
+   * Enables or disables right-to-left support for resizing the column. defaults to 'ltr'.
+   */
+  columnResizeDirection?: ColumnResizeDirection
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnResizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnResizing` from your own managed state.
+   */
+  onColumnResizingChange?: OnChangeFn<columnResizingState>
+}
+
+export type ColumnResizingDefaultOptions = Pick<
+  TableOptions_ColumnResizing,
+  'columnResizeMode' | 'onColumnResizingChange' | 'columnResizeDirection'
+>
+
+export interface Table_ColumnResizing {
+  /**
+   * Resets column sizing info to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.
+   */
+  resetHeaderSizeInfo: (defaultState?: boolean) => void
+  /**
+   * Sets the column sizing info state using an updater function or a value. This will trigger the underlying `oncolumnResizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+   */
+  setcolumnResizing: (updater: Updater<columnResizingState>) => void
+}
+
+export interface ColumnDef_ColumnResizing {
+  /**
+   * Enables or disables column resizing for the column.
+   */
+  enableResizing?: boolean
+}
+
+export interface Column_ColumnResizing {
+  /**
+   * Returns `true` if the column can be resized.
+   */
+  getCanResize: () => boolean
+  /**
+   * Returns `true` if the column is currently being resized.
+   */
+  getIsResizing: () => boolean
+}
+
+export interface Header_ColumnResizing {
+  /**
+   * Returns an event handler function that can be used to resize the header. It can be used as an:
+   * - `onMouseDown` handler
+   * - `onTouchStart` handler
+   * The dragging and release events are automatically handled for you.
+   */
+  getResizeHandler: (context?: Document) => (event: unknown) => void
+}

package/src/features/column-resizing/columnResizingFeature.utils.ts

@@ -0,0 +1,276 @@
+import {
+  column_getSize,
+  header_getSize,
+  table_setColumnSizing,
+} from '../column-sizing/columnSizingFeature.utils'
+import { table_getColumn } from '../../core/columns/coreColumnsFeature.utils'
+import { cloneState } from '../../utils'
+import type { CellData, RowData, Updater } from '../../types/type-utils'
+import type { TableFeatures } from '../../types/TableFeatures'
+import type { Table_Internal } from '../../types/Table'
+import type { Header } from '../../types/Header'
+import type { Column_Internal } from '../../types/Column'
+import type { ColumnSizingState } from '../column-sizing/columnSizingFeature.types'
+import type { columnResizingState } from './columnResizingFeature.types'
+
+export function getDefaultColumnResizingState(): columnResizingState {
+  return {
+    startOffset: null,
+    startSize: null,
+    deltaOffset: null,
+    deltaPercentage: null,
+    isResizingColumn: false,
+    columnSizingStart: [],
+  }
+}
+
+export function column_getCanResize<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  return (
+    (column.columnDef.enableResizing ?? true) &&
+    (column.table.options.enableColumnResizing ?? true)
+  )
+}
+
+export function column_getIsResizing<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(column: Column_Internal<TFeatures, TData, TValue>) {
+  return (
+    column.table.atoms.columnResizing?.get()?.isResizingColumn === column.id
+  )
+}
+
+export function header_getResizeHandler<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+  TValue extends CellData = CellData,
+>(header: Header<TFeatures, TData, TValue>, _contextDocument?: Document) {
+  const column = table_getColumn(header.column.table, header.column.id)!
+  const canResize = column_getCanResize(column)
+
+  return (event: unknown) => {
+    if (!canResize) {
+      return
+    }
+
+    ;(event as any).persist?.()
+
+    if (isTouchStartEvent(event)) {
+      // lets not respond to multiple touches (e.g. 2 or 3 fingers)
+      if (event.touches.length > 1) {
+        return
+      }
+    }
+
+    const startSize = header_getSize(header)
+
+    const columnSizingStart: Array<[string, number]> = header
+      .getLeafHeaders()
+      .map((leafHeader) => [
+        leafHeader.column.id,
+        column_getSize(leafHeader.column),
+      ])
+
+    const clientX = isTouchStartEvent(event)
+      ? Math.round(event.touches[0]!.clientX)
+      : (event as MouseEvent).clientX
+
+    const newColumnSizing: ColumnSizingState = {}
+
+    const updateOffset = (eventType: 'move' | 'end', clientXPos?: number) => {
+      if (typeof clientXPos !== 'number') {
+        return
+      }
+
+      table_setColumnResizing(column.table, (old) => {
+        const deltaDirection =
+          column.table.options.columnResizeDirection === 'rtl' ? -1 : 1
+        const deltaOffset =
+          (clientXPos - (old.startOffset ?? 0)) * deltaDirection
+        const startSize = old.startSize ?? 0
+        const deltaPercentage = Math.max(
+          startSize > 0 ? deltaOffset / startSize : 0,
+          -0.999999,
+        )
+
+        old.columnSizingStart.forEach(([columnId, headerSize]) => {
+          newColumnSizing[columnId] =
+            Math.round(
+              Math.max(
+                headerSize > 0
+                  ? headerSize + headerSize * deltaPercentage
+                  : deltaOffset / old.columnSizingStart.length,
+                0,
+              ) * 100,
+            ) / 100
+        })
+
+        return {
+          ...old,
+          deltaOffset,
+          deltaPercentage,
+        }
+      })
+
+      if (
+        column.table.options.columnResizeMode === 'onChange' ||
+        eventType === 'end'
+      ) {
+        table_setColumnSizing(column.table, (old) => ({
+          ...old,
+          ...newColumnSizing,
+        }))
+      }
+    }
+
+    const onMove = (clientXPos?: number) => updateOffset('move', clientXPos)
+
+    const onEnd = (clientXPos?: number) => {
+      updateOffset('end', clientXPos)
+
+      table_setColumnResizing(column.table, (old) => ({
+        ...old,
+        isResizingColumn: false,
+        startOffset: null,
+        startSize: null,
+        deltaOffset: null,
+        deltaPercentage: null,
+        columnSizingStart: [],
+      }))
+    }
+
+    const contextDocument =
+      _contextDocument || typeof document !== 'undefined' ? document : null
+
+    const mouseEvents = {
+      moveHandler: (e: MouseEvent) => onMove(e.clientX),
+      upHandler: (e: MouseEvent) => {
+        contextDocument?.removeEventListener(
+          'mousemove',
+          mouseEvents.moveHandler,
+        )
+        contextDocument?.removeEventListener('mouseup', mouseEvents.upHandler)
+        onEnd(e.clientX)
+      },
+    }
+
+    const touchEvents = {
+      moveHandler: (touchEvent: TouchEvent) => {
+        if (touchEvent.cancelable) {
+          touchEvent.preventDefault()
+          touchEvent.stopPropagation()
+        }
+        onMove(touchEvent.touches[0]!.clientX)
+        return false
+      },
+      upHandler: (e: TouchEvent) => {
+        contextDocument?.removeEventListener(
+          'touchmove',
+          touchEvents.moveHandler,
+        )
+        contextDocument?.removeEventListener('touchend', touchEvents.upHandler)
+        if (e.cancelable) {
+          e.preventDefault()
+          e.stopPropagation()
+        }
+        onEnd(e.touches[0]?.clientX)
+      },
+    }
+
+    const passiveIfSupported = passiveEventSupported()
+      ? { passive: false }
+      : false
+
+    if (isTouchStartEvent(event)) {
+      contextDocument?.addEventListener(
+        'touchmove',
+        touchEvents.moveHandler,
+        passiveIfSupported,
+      )
+      contextDocument?.addEventListener(
+        'touchend',
+        touchEvents.upHandler,
+        passiveIfSupported,
+      )
+    } else {
+      contextDocument?.addEventListener(
+        'mousemove',
+        mouseEvents.moveHandler,
+        passiveIfSupported,
+      )
+      contextDocument?.addEventListener(
+        'mouseup',
+        mouseEvents.upHandler,
+        passiveIfSupported,
+      )
+    }
+
+    table_setColumnResizing(column.table, (old) => ({
+      ...old,
+      startOffset: clientX,
+      startSize,
+      deltaOffset: 0,
+      deltaPercentage: 0,
+      columnSizingStart,
+      isResizingColumn: column.id,
+    }))
+  }
+}
+
+export function table_setColumnResizing<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(
+  table: Table_Internal<TFeatures, TData>,
+  updater: Updater<columnResizingState>,
+) {
+  table.options.onColumnResizingChange?.(updater)
+}
+
+export function table_resetHeaderSizeInfo<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(table: Table_Internal<TFeatures, TData>, defaultState?: boolean) {
+  table_setColumnResizing(
+    table,
+    defaultState
+      ? getDefaultColumnResizingState()
+      : cloneState(
+          table.initialState.columnResizing ?? getDefaultColumnResizingState(),
+        ),
+  )
+}
+
+export function passiveEventSupported() {
+  let passiveSupported: boolean | null = null
+
+  if (typeof passiveSupported === 'boolean') return passiveSupported
+
+  let supported = false
+  try {
+    const options = {
+      get passive() {
+        supported = true
+        return false
+      },
+    }
+
+    const noop = () => {}
+
+    window.addEventListener('test', noop, options)
+    window.removeEventListener('test', noop)
+  } catch (err) {
+    supported = false
+  }
+  passiveSupported = supported
+  return passiveSupported
+}
+
+export function isTouchStartEvent(e: unknown): e is TouchEvent {
+  return (e as TouchEvent).type === 'touchstart'
+}

package/src/features/column-sizing/columnSizingFeature.ts

@@ -0,0 +1,146 @@
+import {
+  assignPrototypeAPIs,
+  assignTableAPIs,
+  callMemoOrStaticFn,
+  makeStateUpdater,
+} from '../../utils'
+import { table_getPinnedVisibleLeafColumns } from '../column-pinning/columnPinningFeature.utils'
+import {
+  column_getAfter,
+  column_getSize,
+  column_getStart,
+  column_resetSize,
+  getDefaultColumnSizingColumnDef,
+  getDefaultColumnSizingState,
+  header_getSize,
+  header_getStart,
+  table_getCenterTotalSize,
+  table_getLeftTotalSize,
+  table_getRightTotalSize,
+  table_getTotalSize,
+  table_resetColumnSizing,
+  table_setColumnSizing,
+} from './columnSizingFeature.utils'
+import type { RowData } from '../../types/type-utils'
+import type { TableFeature, TableFeatures } from '../../types/TableFeatures'
+// import type {
+//   ColumnDef_ColumnSizing,
+//   Column_ColumnSizing,
+//   Header_ColumnSizing,
+//   TableOptions_ColumnSizing,
+//   TableState_ColumnSizing,
+//   Table_ColumnSizing,
+// } from './columnSizingFeature.types'
+
+export interface ColumnSizingFeatureConstructors<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+> {
+  // ColumnDef: ColumnDef_ColumnSizing
+  // Column: Column_ColumnSizing
+  // Header: Header_ColumnSizing
+  // Table: Table_ColumnSizing
+  // TableOptions: TableOptions_ColumnSizing
+  // TableState: TableState_ColumnSizing
+}
+
+export function constructColumnSizingFeature<
+  TFeatures extends TableFeatures,
+  TData extends RowData,
+>(): TableFeature<ColumnSizingFeatureConstructors<TFeatures, TData>> {
+  return {
+    getInitialState: (initialState) => {
+      return {
+        columnSizing: getDefaultColumnSizingState(),
+        ...initialState,
+      }
+    },
+
+    getDefaultColumnDef: () => {
+      return getDefaultColumnSizingColumnDef()
+    },
+
+    getDefaultTableOptions: (table) => {
+      return {
+        onColumnSizingChange: makeStateUpdater('columnSizing', table),
+      }
+    },
+
+    assignColumnPrototype: (prototype, table) => {
+      assignPrototypeAPIs('columnSizingFeature', prototype, table, {
+        column_getSize: {
+          fn: (column) => column_getSize(column),
+        },
+        column_getStart: {
+          fn: (column, position) => column_getStart(column, position),
+          memoDeps: (column, position) => [
+            position,
+            callMemoOrStaticFn(
+              column.table,
+              'getPinnedVisibleLeafColumns',
+              table_getPinnedVisibleLeafColumns,
+              position,
+            ),
+            column.table.atoms.columnSizing?.get(),
+          ],
+        },
+        column_getAfter: {
+          fn: (column, position) => column_getAfter(column, position),
+          memoDeps: (column, position) => [
+            position,
+            callMemoOrStaticFn(
+              column.table,
+              'getPinnedVisibleLeafColumns',
+              table_getPinnedVisibleLeafColumns,
+              position,
+            ),
+            column.table.atoms.columnSizing?.get(),
+          ],
+        },
+        column_resetSize: {
+          fn: (column) => column_resetSize(column),
+        },
+      })
+    },
+
+    assignHeaderPrototype: (prototype, table) => {
+      assignPrototypeAPIs('columnSizingFeature', prototype, table, {
+        header_getSize: {
+          fn: (header) => header_getSize(header),
+        },
+        header_getStart: {
+          fn: (header) => header_getStart(header),
+        },
+      })
+    },
+
+    constructTableAPIs: (table) => {
+      assignTableAPIs('columnSizingFeature', table, {
+        table_setColumnSizing: {
+          fn: (updater) => table_setColumnSizing(table, updater),
+        },
+        table_resetColumnSizing: {
+          fn: (defaultState) => table_resetColumnSizing(table, defaultState),
+        },
+        table_getTotalSize: {
+          fn: () => table_getTotalSize(table),
+        },
+        table_getLeftTotalSize: {
+          fn: () => table_getLeftTotalSize(table),
+        },
+        table_getCenterTotalSize: {
+          fn: () => table_getCenterTotalSize(table),
+        },
+        table_getRightTotalSize: {
+          fn: () => table_getRightTotalSize(table),
+        },
+      })
+    },
+  }
+}
+
+/**
+ * The Column Sizing feature adds column sizing state and APIs to the table, header, and column objects.
+ * **Note:** This does not include column resizing. The columnResizingFeature feature has been split out into its own standalone feature.
+ */
+export const columnSizingFeature = constructColumnSizingFeature()

package/src/features/column-sizing/columnSizingFeature.types.ts

@@ -0,0 +1,92 @@
+import type { OnChangeFn, Updater } from '../../types/type-utils'
+import type { ColumnPinningPosition } from '../column-pinning/columnPinningFeature.types'
+
+export interface TableState_ColumnSizing {
+  columnSizing: ColumnSizingState
+}
+
+export type ColumnSizingState = Record<string, number>
+
+export interface TableOptions_ColumnSizing {
+  /**
+   * If provided, this function will be called with an `updaterFn` when `state.columnSizing` changes. This overrides the default internal state management, so you will also need to supply `state.columnSizing` from your own managed state.
+   */
+  onColumnSizingChange?: OnChangeFn<ColumnSizingState>
+}
+
+export type ColumnSizingDefaultOptions = Pick<
+  TableOptions_ColumnSizing,
+  'onColumnSizingChange'
+>
+
+export interface Table_ColumnSizing {
+  /**
+   * If pinning, returns the total size of the center portion of the table by calculating the sum of the sizes of all unpinned/center leaf-columns.
+   */
+  getCenterTotalSize: () => number
+  /**
+   * Returns the total size of the left portion of the table by calculating the sum of the sizes of all left leaf-columns.
+   */
+  getLeftTotalSize: () => number
+  /**
+   * Returns the total size of the right portion of the table by calculating the sum of the sizes of all right leaf-columns.
+   */
+  getRightTotalSize: () => number
+  /**
+   * Returns the total size of the table by calculating the sum of the sizes of all leaf-columns.
+   */
+  getTotalSize: () => number
+  /**
+   * Resets column sizing to its initial state. If `defaultState` is `true`, the default state for the table will be used instead of the initialValue provided to the table.
+   */
+  resetColumnSizing: (defaultState?: boolean) => void
+  /**
+   * Sets the column sizing state using an updater function or a value. This will trigger the underlying `onColumnSizingChange` function if one is passed to the table options, otherwise the state will be managed automatically by the table.
+   */
+  setColumnSizing: (updater: Updater<ColumnSizingState>) => void
+}
+
+export interface ColumnDef_ColumnSizing {
+  /**
+   * The maximum allowed size for the column
+   */
+  maxSize?: number
+  /**
+   * The minimum allowed size for the column
+   */
+  minSize?: number
+  /**
+   * The desired size for the column
+   */
+  size?: number
+}
+
+export interface Column_ColumnSizing {
+  /**
+   * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all succeeding (right) headers in relation to the current column.
+   */
+  getAfter: (position?: ColumnPinningPosition | 'center') => number
+  /**
+   * Returns the current size of the column.
+   */
+  getSize: () => number
+  /**
+   * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding (left) headers in relation to the current column.
+   */
+  getStart: (position?: ColumnPinningPosition | 'center') => number
+  /**
+   * Resets the column to its initial size.
+   */
+  resetSize: () => void
+}
+
+export interface Header_ColumnSizing {
+  /**
+   * Returns the current size of the header.
+   */
+  getSize: () => number
+  /**
+   * Returns the offset measurement along the row-axis (usually the x-axis for standard tables) for the header. This is effectively a sum of the offset measurements of all preceding headers.
+   */
+  getStart: (position?: ColumnPinningPosition) => number
+}