Lzh on GitHub

状态 (State)

列排序状态以以下形式存储在表格中:

export type ColumnOrderTableState = {
  columnOrder: ColumnOrderState
}
export type ColumnOrderState = string[]

表格选项 (Table Options)

onColumnOrderChange

onColumnOrderChange?: OnChangeFn<ColumnOrderState>

如果提供,当 state.columnOrder 改变时,此函数将使用 updaterFn 调用。这会覆盖默认的内部状态管理,因此你需要完全或部分地在表格之外持久化状态更改。

表格 API (Table API)

setColumnOrder

setColumnOrder: (updater: Updater<ColumnOrderState>) => void

设置或更新 state.columnOrder 状态。

resetColumnOrder

resetColumnOrder: (defaultState?: boolean) => void

columnOrder 状态重置为 initialState.columnOrder,或者可以传递 true 来强制重置为默认的空白状态 []

列 API (Column API)

getIndex

getIndex: (position?: ColumnPinningPosition) => number

返回列在可见列顺序中的索引。可以选择传入 position 参数以获取列在表格子部分中的索引。

getIsFirstColumn

getIsFirstColumn: (position?: ColumnPinningPosition) => boolean

如果列是可见列顺序中的第一列,则返回 true。可以选择传入 position 参数以检查列是否是表格子部分中的第一列。

getIsLastColumn

getIsLastColumn: (position?: ColumnPinningPosition) => boolean

如果列是可见列顺序中的最后一列,则返回 true。可以选择传入 position 参数以检查列是否是表格子部分中的最后一列。