@tanstack/table-core 9.0.0-alpha.10 → 9.0.0-alpha.11

package/src/features/ColumnVisibility.ts

@@ -1,317 +0,0 @@
-import { ColumnPinningPosition } from '..'
-import {
-  Cell,
-  Column,
-  OnChangeFn,
-  Table,
-  Updater,
-  Row,
-  RowData,
-  TableFeature,
-} from '../types'
-import { getMemoOptions, makeStateUpdater, memo } from '../utils'
-
-export type VisibilityState = Record<string, boolean>
-
-export interface VisibilityTableState {
-  columnVisibility: VisibilityState
-}
-
-export interface VisibilityOptions {
-  /**
-   * Whether to enable column hiding. Defaults to `true`.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#enablehiding)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  enableHiding?: boolean
-  /**
-   * If provided, this function will be called with an `updaterFn` when `state.columnVisibility` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#oncolumnvisibilitychange)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  onColumnVisibilityChange?: OnChangeFn<VisibilityState>
-}
-
-export type VisibilityDefaultOptions = Pick<
-  VisibilityOptions,
-  'onColumnVisibilityChange'
->
-
-export interface VisibilityInstance<TData extends RowData> {
-  /**
-   * If column pinning, returns a flat array of leaf-node columns that are visible in the unpinned/center portion of the table.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcentervisibleleafcolumns)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getCenterVisibleLeafColumns: () => Column<TData, unknown>[]
-  /**
-   * Returns whether all columns are visible
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisallcolumnsvisible)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getIsAllColumnsVisible: () => boolean
-  /**
-   * Returns whether any columns are visible
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getissomecolumnsvisible)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getIsSomeColumnsVisible: () => boolean
-  /**
-   * If column pinning, returns a flat array of leaf-node columns that are visible in the left portion of the table.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getleftvisibleleafcolumns)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getLeftVisibleLeafColumns: () => Column<TData, unknown>[]
-  /**
-   * If column pinning, returns a flat array of leaf-node columns that are visible in the right portion of the table.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getrightvisibleleafcolumns)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getRightVisibleLeafColumns: () => Column<TData, unknown>[]
-  /**
-   * Returns a handler for toggling the visibility of all columns, meant to be bound to a `input[type=checkbox]` element.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettoggleallcolumnsvisibilityhandler)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getToggleAllColumnsVisibilityHandler: () => (event: unknown) => void
-  /**
-   * Returns a flat array of columns that are visible, including parent columns.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleflatcolumns)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getVisibleFlatColumns: () => Column<TData, unknown>[]
-  /**
-   * Returns a flat array of leaf-node columns that are visible.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisibleleafcolumns)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getVisibleLeafColumns: () => Column<TData, unknown>[]
-  /**
-   * Resets the column visibility state to the initial state. If `defaultState` is provided, the state will be reset to `{}`
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#resetcolumnvisibility)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  resetColumnVisibility: (defaultState?: boolean) => void
-  /**
-   * Sets or updates the `state.columnVisibility` state.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#setcolumnvisibility)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  setColumnVisibility: (updater: Updater<VisibilityState>) => void
-  /**
-   * Toggles the visibility of all columns.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#toggleallcolumnsvisible)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  toggleAllColumnsVisible: (value?: boolean) => void
-}
-
-export interface VisibilityColumnDef {
-  enableHiding?: boolean
-}
-
-export interface VisibilityRow<TData extends RowData> {
-  _getAllVisibleCells: () => Cell<TData, unknown>[]
-  /**
-   * Returns an array of cells that account for column visibility for the row.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getvisiblecells)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getVisibleCells: () => Cell<TData, unknown>[]
-}
-
-export interface VisibilityColumn {
-  /**
-   * Returns whether the column can be hidden
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getcanhide)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getCanHide: () => boolean
-  /**
-   * Returns whether the column is visible
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#getisvisible)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getIsVisible: () => boolean
-  /**
-   * Returns a function that can be used to toggle the column visibility. This function can be used to bind to an event handler to a checkbox.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#gettogglevisibilityhandler)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  getToggleVisibilityHandler: () => (event: unknown) => void
-  /**
-   * Toggles the visibility of the column.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-visibility#togglevisibility)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-visibility)
-   */
-  toggleVisibility: (value?: boolean) => void
-}
-
-//
-
-export const ColumnVisibility: TableFeature = {
-  _getInitialState: (state): VisibilityTableState => {
-    return {
-      columnVisibility: {},
-      ...state,
-    }
-  },
-
-  _getDefaultOptions: <TData extends RowData>(
-    table: Table<TData>
-  ): VisibilityDefaultOptions => {
-    return {
-      onColumnVisibilityChange: makeStateUpdater('columnVisibility', table),
-    }
-  },
-
-  _createColumn: <TData extends RowData, TValue>(
-    column: Column<TData, TValue>,
-    table: Table<TData>
-  ): void => {
-    column.toggleVisibility = value => {
-      if (column.getCanHide()) {
-        table.setColumnVisibility(old => ({
-          ...old,
-          [column.id]: value ?? !column.getIsVisible(),
-        }))
-      }
-    }
-    column.getIsVisible = () => {
-      const childColumns = column.columns
-      return (
-        (childColumns.length
-          ? childColumns.some(c => c.getIsVisible())
-          : table.getState().columnVisibility?.[column.id]) ?? true
-      )
-    }
-
-    column.getCanHide = () => {
-      return (
-        (column.columnDef.enableHiding ?? true) &&
-        (table.options.enableHiding ?? true)
-      )
-    }
-    column.getToggleVisibilityHandler = () => {
-      return (e: unknown) => {
-        column.toggleVisibility?.(
-          ((e as MouseEvent).target as HTMLInputElement).checked
-        )
-      }
-    }
-  },
-
-  _createRow: <TData extends RowData>(
-    row: Row<TData>,
-    table: Table<TData>
-  ): void => {
-    row._getAllVisibleCells = memo(
-      () => [row.getAllCells(), table.getState().columnVisibility],
-      cells => {
-        return cells.filter(cell => cell.column.getIsVisible())
-      },
-      getMemoOptions(table.options, 'debugRows', '_getAllVisibleCells')
-    )
-    row.getVisibleCells = memo(
-      () => [
-        row.getLeftVisibleCells(),
-        row.getCenterVisibleCells(),
-        row.getRightVisibleCells(),
-      ],
-      (left, center, right) => [...left, ...center, ...right],
-      getMemoOptions(table.options, 'debugRows', 'getVisibleCells')
-    )
-  },
-
-  _createTable: <TData extends RowData>(table: Table<TData>): void => {
-    const makeVisibleColumnsMethod = (
-      key: string,
-      getColumns: () => Column<TData, unknown>[]
-    ): (() => Column<TData, unknown>[]) => {
-      return memo(
-        () => [
-          getColumns(),
-          getColumns()
-            .filter(d => d.getIsVisible())
-            .map(d => d.id)
-            .join('_'),
-        ],
-        columns => {
-          return columns.filter(d => d.getIsVisible?.())
-        },
-        getMemoOptions(table.options, 'debugColumns', key)
-      )
-    }
-
-    table.getVisibleFlatColumns = makeVisibleColumnsMethod(
-      'getVisibleFlatColumns',
-      () => table.getAllFlatColumns()
-    )
-    table.getVisibleLeafColumns = makeVisibleColumnsMethod(
-      'getVisibleLeafColumns',
-      () => table.getAllLeafColumns()
-    )
-    table.getLeftVisibleLeafColumns = makeVisibleColumnsMethod(
-      'getLeftVisibleLeafColumns',
-      () => table.getLeftLeafColumns()
-    )
-    table.getRightVisibleLeafColumns = makeVisibleColumnsMethod(
-      'getRightVisibleLeafColumns',
-      () => table.getRightLeafColumns()
-    )
-    table.getCenterVisibleLeafColumns = makeVisibleColumnsMethod(
-      'getCenterVisibleLeafColumns',
-      () => table.getCenterLeafColumns()
-    )
-
-    table.setColumnVisibility = updater =>
-      table.options.onColumnVisibilityChange?.(updater)
-
-    table.resetColumnVisibility = defaultState => {
-      table.setColumnVisibility(
-        defaultState ? {} : table.initialState.columnVisibility ?? {}
-      )
-    }
-
-    table.toggleAllColumnsVisible = value => {
-      value = value ?? !table.getIsAllColumnsVisible()
-
-      table.setColumnVisibility(
-        table.getAllLeafColumns().reduce(
-          (obj, column) => ({
-            ...obj,
-            [column.id]: !value ? !column.getCanHide?.() : value,
-          }),
-          {}
-        )
-      )
-    }
-
-    table.getIsAllColumnsVisible = () =>
-      !table.getAllLeafColumns().some(column => !column.getIsVisible?.())
-
-    table.getIsSomeColumnsVisible = () =>
-      table.getAllLeafColumns().some(column => column.getIsVisible?.())
-
-    table.getToggleAllColumnsVisibilityHandler = () => {
-      return (e: unknown) => {
-        table.toggleAllColumnsVisible(
-          ((e as MouseEvent).target as HTMLInputElement)?.checked
-        )
-      }
-    }
-  },
-}
-
-export function _getVisibleLeafColumns<TData extends RowData>(
-  table: Table<TData>,
-  position?: ColumnPinningPosition | 'center'
-) {
-  return !position
-    ? table.getVisibleLeafColumns()
-    : position === 'center'
-      ? table.getCenterVisibleLeafColumns()
-      : position === 'left'
-        ? table.getLeftVisibleLeafColumns()
-        : table.getRightVisibleLeafColumns()
-}

package/src/features/GlobalFaceting.ts

@@ -1,66 +0,0 @@
-import { RowModel } from '..'
-import { Table, RowData, TableFeature } from '../types'
-
-export interface GlobalFacetingInstance<TData extends RowData> {
-  _getGlobalFacetedMinMaxValues?: () => undefined | [number, number]
-  _getGlobalFacetedRowModel?: () => RowModel<TData>
-  _getGlobalFacetedUniqueValues?: () => Map<any, number>
-  /**
-   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalautofilterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
-   */
-  getGlobalFacetedMinMaxValues: () => undefined | [number, number]
-  /**
-   * Returns the row model for the table after **global** filtering has been applied.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfacetedrowmodel)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
-   */
-  getGlobalFacetedRowModel: () => RowModel<TData>
-  /**
-   * Returns the faceted unique values for the global filter.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-faceting#getglobalfaceteduniquevalues)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-faceting)
-   */
-  getGlobalFacetedUniqueValues: () => Map<any, number>
-}
-
-//
-
-export const GlobalFaceting: TableFeature = {
-  _createTable: <TData extends RowData>(table: Table<TData>): void => {
-    table._getGlobalFacetedRowModel =
-      table.options.getFacetedRowModel &&
-      table.options.getFacetedRowModel(table, '__global__')
-
-    table.getGlobalFacetedRowModel = () => {
-      if (table.options.manualFiltering || !table._getGlobalFacetedRowModel) {
-        return table.getPreFilteredRowModel()
-      }
-
-      return table._getGlobalFacetedRowModel()
-    }
-
-    table._getGlobalFacetedUniqueValues =
-      table.options.getFacetedUniqueValues &&
-      table.options.getFacetedUniqueValues(table, '__global__')
-    table.getGlobalFacetedUniqueValues = () => {
-      if (!table._getGlobalFacetedUniqueValues) {
-        return new Map()
-      }
-
-      return table._getGlobalFacetedUniqueValues()
-    }
-
-    table._getGlobalFacetedMinMaxValues =
-      table.options.getFacetedMinMaxValues &&
-      table.options.getFacetedMinMaxValues(table, '__global__')
-    table.getGlobalFacetedMinMaxValues = () => {
-      if (!table._getGlobalFacetedMinMaxValues) {
-        return
-      }
-
-      return table._getGlobalFacetedMinMaxValues()
-    }
-  },
-}

package/src/features/GlobalFiltering.ts

@@ -1,162 +0,0 @@
-import { FilterFn, FilterFnOption } from '..'
-import { BuiltInFilterFn, filterFns } from '../filterFns'
-import {
-  Column,
-  OnChangeFn,
-  Table,
-  Updater,
-  RowData,
-  TableFeature,
-} from '../types'
-import { isFunction, makeStateUpdater } from '../utils'
-
-export interface GlobalFilterTableState {
-  globalFilter: any
-}
-
-export interface GlobalFilterColumnDef {
-  /**
-   * Enables/disables the **global** filter for this column.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#enableglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  enableGlobalFilter?: boolean
-}
-
-export interface GlobalFilterColumn {
-  /**
-   * Returns whether or not the column can be **globally** filtered. Set to `false` to disable a column from being scanned during global filtering.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getcanglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  getCanGlobalFilter: () => boolean
-}
-
-export interface GlobalFilterOptions<TData extends RowData> {
-  /**
-   * Enables/disables **global** filtering for all columns.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#enableglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  enableGlobalFilter?: boolean
-  /**
-   * If provided, this function will be called with the column and should return `true` or `false` to indicate whether this column should be used for global filtering.
-   *
-   * This is useful if the column can contain data that is not `string` or `number` (i.e. `undefined`).
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getcolumncanglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  getColumnCanGlobalFilter?: (column: Column<TData, unknown>) => boolean
-  /**
-   * The filter function to use for global filtering.
-   * - A `string` referencing a built-in filter function
-   * - A `string` that references a custom filter functions provided via the `tableOptions.filterFns` option
-   * - A custom filter function
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#globalfilterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  globalFilterFn?: FilterFnOption<TData>
-  /**
-   * If provided, this function will be called with an `updaterFn` when `state.globalFilter` changes. This overrides the default internal state management, so you will need to persist the state change either fully or partially outside of the table.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#onglobalfilterchange)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  onGlobalFilterChange?: OnChangeFn<any>
-}
-
-export interface GlobalFilterInstance<TData extends RowData> {
-  /**
-   * Currently, this function returns the built-in `includesString` filter function. In future releases, it may return more dynamic filter functions based on the nature of the data provided.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getglobalautofilterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  getGlobalAutoFilterFn: () => FilterFn<TData> | undefined
-  /**
-   * Returns the filter function (either user-defined or automatic, depending on configuration) for the global filter.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#getglobalfilterfn)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  getGlobalFilterFn: () => FilterFn<TData> | undefined
-  /**
-   * Resets the **globalFilter** state to `initialState.globalFilter`, or `true` can be passed to force a default blank state reset to `undefined`.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#resetglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  resetGlobalFilter: (defaultState?: boolean) => void
-  /**
-   * Sets or updates the `state.globalFilter` state.
-   * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/global-filtering#setglobalfilter)
-   * @link [Guide](https://tanstack.com/table/v8/docs/guide/global-filtering)
-   */
-  setGlobalFilter: (updater: Updater<any>) => void
-}
-
-//
-
-export const GlobalFiltering: TableFeature = {
-  _getInitialState: (state): GlobalFilterTableState => {
-    return {
-      globalFilter: undefined,
-      ...state,
-    }
-  },
-
-  _getDefaultOptions: <TData extends RowData>(
-    table: Table<TData>
-  ): GlobalFilterOptions<TData> => {
-    return {
-      onGlobalFilterChange: makeStateUpdater('globalFilter', table),
-      globalFilterFn: 'auto',
-      getColumnCanGlobalFilter: column => {
-        const value = table
-          .getCoreRowModel()
-          .flatRows[0]?._getAllCellsByColumnId()
-          [column.id]?.getValue()
-
-        return typeof value === 'string' || typeof value === 'number'
-      },
-    } as GlobalFilterOptions<TData>
-  },
-
-  _createColumn: <TData extends RowData>(
-    column: Column<TData, unknown>,
-    table: Table<TData>
-  ): void => {
-    column.getCanGlobalFilter = () => {
-      return (
-        (column.columnDef.enableGlobalFilter ?? true) &&
-        (table.options.enableGlobalFilter ?? true) &&
-        (table.options.enableFilters ?? true) &&
-        (table.options.getColumnCanGlobalFilter?.(column) ?? true) &&
-        !!column.accessorFn
-      )
-    }
-  },
-
-  _createTable: <TData extends RowData>(table: Table<TData>): void => {
-    table.getGlobalAutoFilterFn = () => {
-      return filterFns.includesString
-    }
-
-    table.getGlobalFilterFn = () => {
-      const { globalFilterFn: globalFilterFn } = table.options
-
-      return isFunction(globalFilterFn)
-        ? globalFilterFn
-        : globalFilterFn === 'auto'
-          ? table.getGlobalAutoFilterFn()
-          : table.options.filterFns?.[globalFilterFn as string] ??
-            filterFns[globalFilterFn as BuiltInFilterFn]
-    }
-
-    table.setGlobalFilter = updater => {
-      table.options.onGlobalFilterChange?.(updater)
-    }
-
-    table.resetGlobalFilter = defaultState => {
-      table.setGlobalFilter(
-        defaultState ? undefined : table.initialState.globalFilter
-      )
-    }
-  },
-}