@tanstack/table-core/build/lib/features/ColumnOrdering.d.ts

Headless UI for building powerful tables & datagrids for TS/JS.

import { Column, OnChangeFn, RowData, TableFeature, Updater } from '../types';
import { ColumnPinningPosition } from '..';
export interface ColumnOrderTableState {
    columnOrder: ColumnOrderState;
}
export type ColumnOrderState = string[];
export interface ColumnOrderOptions {
    /**
     * If provided, this function will be called with an `updaterFn` when `state.columnOrder` 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-ordering#oncolumnorderchange)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
     */
    onColumnOrderChange?: OnChangeFn<ColumnOrderState>;
}
export interface ColumnOrderColumn {
    /**
     * Returns the index of the column in the order of the visible columns. Optionally pass a `position` parameter to get the index of the column in a sub-section of the table
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getindex)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
     */
    getIndex: (position?: ColumnPinningPosition | 'center') => number;
    /**
     * Returns `true` if the column is the first column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the first in a sub-section of the table.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getisfirstcolumn)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
     */
    getIsFirstColumn: (position?: ColumnPinningPosition | 'center') => boolean;
    /**
     * Returns `true` if the column is the last column in the order of the visible columns. Optionally pass a `position` parameter to check if the column is the last in a sub-section of the table.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#getislastcolumn)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
     */
    getIsLastColumn: (position?: ColumnPinningPosition | 'center') => boolean;
}
export interface ColumnOrderDefaultOptions {
    onColumnOrderChange: OnChangeFn<ColumnOrderState>;
}
export interface ColumnOrderInstance<TData extends RowData> {
    _getOrderColumnsFn: () => (columns: Column<TData, unknown>[]) => Column<TData, unknown>[];
    /**
     * Resets the **columnOrder** state to `initialState.columnOrder`, or `true` can be passed to force a default blank state reset to `[]`.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#resetcolumnorder)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
     */
    resetColumnOrder: (defaultState?: boolean) => void;
    /**
     * Sets or updates the `state.columnOrder` state.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/features/column-ordering#setcolumnorder)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/column-ordering)
     */
    setColumnOrder: (updater: Updater<ColumnOrderState>) => void;
}
export declare const ColumnOrdering: TableFeature;