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

package/src/features/column-pinning/columnPinningFeature.ts

@@ -1,333 +0,0 @@
-import {
-  assignPrototypeAPIs,
-  assignTableAPIs,
-  callMemoOrStaticFn,
-  makeStateUpdater,
-} from '../../utils'
-import { table_getVisibleLeafColumns } from '../column-visibility/columnVisibilityFeature.utils'
-import {
-  column_getCanPin,
-  column_getIsPinned,
-  column_getPinnedIndex,
-  column_pin,
-  getDefaultColumnPinningState,
-  row_getCenterVisibleCells,
-  row_getEndVisibleCells,
-  row_getStartVisibleCells,
-  table_getCenterFlatHeaders,
-  table_getCenterFooterGroups,
-  table_getCenterHeaderGroups,
-  table_getCenterLeafColumns,
-  table_getCenterLeafHeaders,
-  table_getCenterVisibleLeafColumns,
-  table_getEndFlatHeaders,
-  table_getEndFooterGroups,
-  table_getEndHeaderGroups,
-  table_getEndLeafColumns,
-  table_getEndLeafHeaders,
-  table_getEndVisibleLeafColumns,
-  table_getIsSomeColumnsPinned,
-  table_getPinnedLeafColumns,
-  table_getPinnedVisibleLeafColumns,
-  table_getStartFlatHeaders,
-  table_getStartFooterGroups,
-  table_getStartHeaderGroups,
-  table_getStartLeafColumns,
-  table_getStartLeafHeaders,
-  table_getStartVisibleLeafColumns,
-  table_resetColumnPinning,
-  table_setColumnPinning,
-} from './columnPinningFeature.utils'
-import type { TableFeature } from '../../types/TableFeatures'
-
-/**
- * Feature that adds column pinning state and APIs for logical start, center,
- * and end regions.
- *
- * In LTR languages/layouts, start usually corresponds to left and end to
- * right. In RTL languages/layouts, start usually corresponds to right and end
- * to left.
- */
-export const columnPinningFeature: TableFeature = {
-  getInitialState: (initialState) => {
-    return {
-      columnPinning: {
-        ...getDefaultColumnPinningState(),
-        ...initialState.columnPinning,
-      },
-      ...initialState,
-    }
-  },
-
-  getDefaultTableOptions: (table) => {
-    return {
-      onColumnPinningChange: makeStateUpdater('columnPinning', table),
-    }
-  },
-
-  assignColumnPrototype: (prototype, table) => {
-    assignPrototypeAPIs('columnPinningFeature', prototype, table, {
-      column_pin: {
-        fn: (column, position) => column_pin(column, position),
-      },
-      column_getCanPin: {
-        fn: (column) => column_getCanPin(column),
-      },
-      column_getPinnedIndex: {
-        fn: (column) => column_getPinnedIndex(column),
-      },
-      column_getIsPinned: {
-        fn: (column) => column_getIsPinned(column),
-      },
-    })
-  },
-
-  assignRowPrototype: (prototype, table) => {
-    assignPrototypeAPIs('columnPinningFeature', prototype, table, {
-      row_getCenterVisibleCells: {
-        fn: (row) => row_getCenterVisibleCells(row),
-        memoDeps: (row) => [
-          row.getAllCells(),
-          row.table.atoms.columnPinning?.get(),
-          row.table.atoms.columnVisibility?.get(),
-        ],
-      },
-      row_getStartVisibleCells: {
-        fn: (row) => row_getStartVisibleCells(row),
-        memoDeps: (row) => [
-          row.getAllCells(),
-          row.table.atoms.columnPinning?.get()?.start,
-          row.table.atoms.columnVisibility?.get(),
-        ],
-      },
-      row_getEndVisibleCells: {
-        fn: (row) => row_getEndVisibleCells(row),
-        memoDeps: (row) => [
-          row.getAllCells(),
-          row.table.atoms.columnPinning?.get()?.end,
-          row.table.atoms.columnVisibility?.get(),
-        ],
-      },
-    })
-  },
-
-  constructTableAPIs: (table) => {
-    assignTableAPIs('columnPinningFeature', table, {
-      table_setColumnPinning: {
-        fn: (updater) => table_setColumnPinning(table, updater),
-      },
-      table_resetColumnPinning: {
-        fn: (defaultState) => table_resetColumnPinning(table, defaultState),
-      },
-      table_getIsSomeColumnsPinned: {
-        fn: (position) => table_getIsSomeColumnsPinned(table, position),
-      },
-      // header groups
-      table_getStartHeaderGroups: {
-        fn: () => table_getStartHeaderGroups(table),
-        memoDeps: () => [
-          table.getAllColumns(),
-          callMemoOrStaticFn(
-            table,
-            'getVisibleLeafColumns',
-            table_getVisibleLeafColumns,
-          ),
-          table.atoms.columnPinning?.get()?.start,
-          table.atoms.columnOrder?.get(),
-        ],
-      },
-      table_getCenterHeaderGroups: {
-        fn: () => table_getCenterHeaderGroups(table),
-        memoDeps: () => [
-          table.getAllColumns(),
-          callMemoOrStaticFn(
-            table,
-            'getVisibleLeafColumns',
-            table_getVisibleLeafColumns,
-          ),
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnOrder?.get(),
-        ],
-      },
-      table_getEndHeaderGroups: {
-        fn: () => table_getEndHeaderGroups(table),
-        memoDeps: () => [
-          table.getAllColumns(),
-          callMemoOrStaticFn(
-            table,
-            'getVisibleLeafColumns',
-            table_getVisibleLeafColumns,
-          ),
-          table.atoms.columnPinning?.get()?.end,
-          table.atoms.columnOrder?.get(),
-        ],
-      },
-      // footer groups
-      table_getStartFooterGroups: {
-        fn: () => table_getStartFooterGroups(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getStartHeaderGroups',
-            table_getStartHeaderGroups,
-          ),
-        ],
-      },
-      table_getCenterFooterGroups: {
-        fn: () => table_getCenterFooterGroups(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getCenterHeaderGroups',
-            table_getCenterHeaderGroups,
-          ),
-        ],
-      },
-      table_getEndFooterGroups: {
-        fn: () => table_getEndFooterGroups(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getEndHeaderGroups',
-            table_getEndHeaderGroups,
-          ),
-        ],
-      },
-      // flat headers
-      table_getStartFlatHeaders: {
-        fn: () => table_getStartFlatHeaders(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getStartHeaderGroups',
-            table_getStartHeaderGroups,
-          ),
-        ],
-      },
-      table_getEndFlatHeaders: {
-        fn: () => table_getEndFlatHeaders(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getEndHeaderGroups',
-            table_getEndHeaderGroups,
-          ),
-        ],
-      },
-      table_getCenterFlatHeaders: {
-        fn: () => table_getCenterFlatHeaders(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getCenterHeaderGroups',
-            table_getCenterHeaderGroups,
-          ),
-        ],
-      },
-      // leaf headers
-      table_getStartLeafHeaders: {
-        fn: () => table_getStartLeafHeaders(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getStartHeaderGroups',
-            table_getStartHeaderGroups,
-          ),
-        ],
-      },
-      table_getEndLeafHeaders: {
-        fn: () => table_getEndLeafHeaders(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getEndHeaderGroups',
-            table_getEndHeaderGroups,
-          ),
-        ],
-      },
-      table_getCenterLeafHeaders: {
-        fn: () => table_getCenterLeafHeaders(table),
-        memoDeps: () => [
-          callMemoOrStaticFn(
-            table,
-            'getCenterHeaderGroups',
-            table_getCenterHeaderGroups,
-          ),
-        ],
-      },
-      // leaf columns
-      table_getStartLeafColumns: {
-        fn: () => table_getStartLeafColumns(table),
-        memoDeps: () => [
-          table.options.columns,
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnOrder?.get(),
-          table.atoms.grouping?.get(),
-          table.options.groupedColumnMode,
-        ],
-      },
-      table_getEndLeafColumns: {
-        fn: () => table_getEndLeafColumns(table),
-        memoDeps: () => [
-          table.options.columns,
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnOrder?.get(),
-          table.atoms.grouping?.get(),
-          table.options.groupedColumnMode,
-        ],
-      },
-      table_getCenterLeafColumns: {
-        fn: () => table_getCenterLeafColumns(table),
-        memoDeps: () => [
-          table.options.columns,
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnOrder?.get(),
-          table.atoms.grouping?.get(),
-          table.options.groupedColumnMode,
-        ],
-      },
-      table_getPinnedLeafColumns: {
-        fn: (position) => table_getPinnedLeafColumns(table, position),
-        // must not memo here as it's just a shortcut function
-      },
-      // visible leaf columns
-      table_getStartVisibleLeafColumns: {
-        fn: () => table_getStartVisibleLeafColumns(table),
-        memoDeps: () => [
-          table.options.columns,
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnVisibility?.get(),
-          table.atoms.columnOrder?.get(),
-          table.atoms.grouping?.get(),
-          table.options.groupedColumnMode,
-        ],
-      },
-      table_getCenterVisibleLeafColumns: {
-        fn: () => table_getCenterVisibleLeafColumns(table),
-        memoDeps: () => [
-          table.options.columns,
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnVisibility?.get(),
-          table.atoms.columnOrder?.get(),
-          table.atoms.grouping?.get(),
-          table.options.groupedColumnMode,
-        ],
-      },
-      table_getEndVisibleLeafColumns: {
-        fn: () => table_getEndVisibleLeafColumns(table),
-        memoDeps: () => [
-          table.options.columns,
-          table.atoms.columnPinning?.get(),
-          table.atoms.columnVisibility?.get(),
-          table.atoms.columnOrder?.get(),
-          table.atoms.grouping?.get(),
-          table.options.groupedColumnMode,
-        ],
-      },
-      table_getPinnedVisibleLeafColumns: {
-        fn: (position) => table_getPinnedVisibleLeafColumns(table, position),
-        // must not memo here as it's just a shortcut function
-      },
-    })
-  },
-}

package/src/features/column-pinning/columnPinningFeature.types.ts

@@ -1,203 +0,0 @@
-import type { OnChangeFn, RowData, Updater } from '../../types/type-utils'
-import type { TableFeatures } from '../../types/TableFeatures'
-import type { Cell } from '../../types/Cell'
-import type { Header } from '../../types/Header'
-import type { HeaderGroup } from '../../types/HeaderGroup'
-import type { Column } from '../../types/Column'
-
-/**
- * Logical column pinning region.
- *
- * In LTR languages/layouts, `start` usually corresponds to left and `end`
- * usually corresponds to right. In RTL languages/layouts, `start` usually
- * corresponds to right and `end` usually corresponds to left.
- */
-export type ColumnPinningPosition = false | 'start' | 'end'
-
-export interface ColumnPinningState {
-  start: Array<string>
-  end: Array<string>
-}
-
-export interface TableState_ColumnPinning {
-  columnPinning: ColumnPinningState
-}
-
-export interface TableOptions_ColumnPinning {
-  /**
-   * Allows columns to be pinned into logical start and end regions.
-   *
-   * In LTR languages/layouts, start usually corresponds to left and end to
-   * right. In RTL languages/layouts, start usually corresponds to right and end
-   * to left.
-   *
-   * Defaults to `true`; column-level `enablePinning` can still opt individual
-   * columns out.
-   */
-  enableColumnPinning?: boolean
-  /**
-   * Called with an updater when column pinning state changes. Pair this with
-   * `state.columnPinning` when using external state; external atoms can own the
-   * slice without this callback.
-   */
-  onColumnPinningChange?: OnChangeFn<ColumnPinningState>
-}
-
-export interface ColumnPinningDefaultOptions {
-  onColumnPinningChange: OnChangeFn<ColumnPinningState>
-}
-
-export interface ColumnDef_ColumnPinning {
-  /**
-   * Allows this column's leaf columns to be pinned.
-   *
-   * Defaults to `true`; table-level `enableColumnPinning` must also allow
-   * pinning.
-   */
-  enablePinning?: boolean
-}
-
-export interface Column_ColumnPinning {
-  /**
-   * Checks whether this column or any of its leaves can be pinned.
-   */
-  getCanPin: () => boolean
-  /**
-   * Reads the column's logical pinned position: `'start'`, `'end'`, or `false`.
-   */
-  getIsPinned: () => ColumnPinningPosition
-  /**
-   * Finds this column's index within its pinned region.
-   */
-  getPinnedIndex: () => number
-  /**
-   * Pins this column's leaf columns to logical start or end, or unpins them
-   * when `false` is passed.
-   */
-  pin: (position: ColumnPinningPosition) => void
-}
-
-export interface Row_ColumnPinning<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
-> {
-  /**
-   * Gets visible row cells whose columns are not pinned start or end.
-   */
-  getCenterVisibleCells: () => Array<Cell<TFeatures, TData, unknown>>
-  /**
-   * Gets visible row cells whose columns are pinned to logical start.
-   */
-  getStartVisibleCells: () => Array<Cell<TFeatures, TData, unknown>>
-  /**
-   * Gets visible row cells whose columns are pinned to logical end.
-   */
-  getEndVisibleCells: () => Array<Cell<TFeatures, TData, unknown>>
-}
-
-export interface Table_ColumnPinning<
-  in out TFeatures extends TableFeatures,
-  in out TData extends RowData,
-> {
-  /**
-   * Builds flat center-region headers for columns that are not pinned,
-   * including parent headers.
-   */
-  getCenterFlatHeaders: () => Array<Header<TFeatures, TData, unknown>>
-  /**
-   * Builds footer groups for the center region of unpinned columns.
-   */
-  getCenterFooterGroups: () => Array<HeaderGroup<TFeatures, TData>>
-  /**
-   * Builds header groups for the center region of unpinned columns.
-   */
-  getCenterHeaderGroups: () => Array<HeaderGroup<TFeatures, TData>>
-  /**
-   * Gets leaf columns that are not pinned start or end.
-   */
-  getCenterLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Builds center-region leaf headers for columns that are not pinned.
-   */
-  getCenterLeafHeaders: () => Array<Header<TFeatures, TData, unknown>>
-  /**
-   * Lists visible leaf columns in the unpinned center region.
-   */
-  getCenterVisibleLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Checks whether any columns are pinned, optionally limited to one side.
-   */
-  getIsSomeColumnsPinned: (position?: ColumnPinningPosition) => boolean
-  /**
-   * Builds flat logical start-region headers for pinned columns, including parent
-   * headers.
-   */
-  getStartFlatHeaders: () => Array<Header<TFeatures, TData, unknown>>
-  /**
-   * Builds footer groups for logical start-pinned columns.
-   */
-  getStartFooterGroups: () => Array<HeaderGroup<TFeatures, TData>>
-  /**
-   * Builds header groups for logical start-pinned columns.
-   */
-  getStartHeaderGroups: () => Array<HeaderGroup<TFeatures, TData>>
-  /**
-   * Gets leaf columns pinned to the logical start region in pinning-state order.
-   */
-  getStartLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Builds leaf headers for logical start-pinned columns.
-   */
-  getStartLeafHeaders: () => Array<Header<TFeatures, TData, unknown>>
-  /**
-   * Lists visible leaf columns in the logical start pinned region.
-   */
-  getStartVisibleLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Builds flat logical end-region headers for pinned columns, including parent
-   * headers.
-   */
-  getEndFlatHeaders: () => Array<Header<TFeatures, TData, unknown>>
-  /**
-   * Builds footer groups for logical end-pinned columns.
-   */
-  getEndFooterGroups: () => Array<HeaderGroup<TFeatures, TData>>
-  /**
-   * Builds header groups for logical end-pinned columns.
-   */
-  getEndHeaderGroups: () => Array<HeaderGroup<TFeatures, TData>>
-  /**
-   * Gets leaf columns pinned to the logical end region in pinning-state order.
-   */
-  getEndLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Builds leaf headers for logical end-pinned columns.
-   */
-  getEndLeafHeaders: () => Array<Header<TFeatures, TData, unknown>>
-  /**
-   * Lists visible leaf columns in the logical end pinned region.
-   */
-  getEndVisibleLeafColumns: () => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Resets `columnPinning` to `initialState.columnPinning`.
-   *
-   * Pass `true` to ignore initial state and reset to empty start/end arrays.
-   */
-  resetColumnPinning: (defaultState?: boolean) => void
-  /**
-   * Updates column pinning state with a next state or updater function.
-   */
-  setColumnPinning: (updater: Updater<ColumnPinningState>) => void
-  /**
-   * Returns pinned leaf columns for the requested pinning region.
-   */
-  getPinnedLeafColumns: (
-    position: ColumnPinningPosition | 'center',
-  ) => Array<Column<TFeatures, TData, unknown>>
-  /**
-   * Lists visible leaf columns for the requested pinning region.
-   */
-  getPinnedVisibleLeafColumns: (
-    position: ColumnPinningPosition | 'center',
-  ) => Array<Column<TFeatures, TData, unknown>>
-}