展开 API | TanStack Table Docs

状态

展开状态使用以下结构存储在表格中：

tsx

export type ExpandedState = true | Record<string, boolean>

export type ExpandedTableState = {
  expanded: ExpandedState
}

export type ExpandedState = true | Record<string, boolean>

export type ExpandedTableState = {
  expanded: ExpandedState
}

行 API

toggleExpanded

tsx

toggleExpanded: (expanded?: boolean) => void

toggleExpanded: (expanded?: boolean) => void

切换行的展开状态（如果提供了 expanded，则设置它）。

getIsExpanded

tsx

getIsExpanded: () => boolean

getIsExpanded: () => boolean

返回行是否已展开。

getIsAllParentsExpanded

tsx

getIsAllParentsExpanded: () => boolean

getIsAllParentsExpanded: () => boolean

返回行的所有父行是否已展开。

getCanExpand

tsx

getCanExpand: () => boolean

getCanExpand: () => boolean

返回行是否可以展开。

getToggleExpandedHandler

tsx

getToggleExpandedHandler: () => () => void

getToggleExpandedHandler: () => () => void

返回一个可用于切换行展开状态的函数。此函数可用于将事件处理程序绑定到按钮。

表格选项

manualExpanding

tsx

manualExpanding?: boolean

manualExpanding?: boolean

启用手动行展开。如果设置为 true，getExpandedRowModel 将不用于展开行，并且您需要在自己的数据模型中执行展开。如果您正在进行服务器端展开，这很有用。

onExpandedChange

tsx

onExpandedChange?: OnChangeFn<ExpandedState>

onExpandedChange?: OnChangeFn<ExpandedState>

当 expanded 表格状态更改时调用此函数。如果提供了函数，您将负责自己管理此状态。要将管理的状态传递回表格，请使用 tableOptions.state.expanded 选项。

autoResetExpanded

tsx

autoResetExpanded?: boolean

autoResetExpanded?: boolean

启用此设置可在展开状态更改时自动重置表格的展开状态。

enableExpanding

tsx

enableExpanding?: boolean

enableExpanding?: boolean

启用/禁用所有行的展开。

getExpandedRowModel

tsx

getExpandedRowModel?: (table: Table<TData>) => () => RowModel<TData>

getExpandedRowModel?: (table: Table<TData>) => () => RowModel<TData>

此函数负责返回展开的行模型。如果未提供此函数，表格将不会展开行。您可以使用默认导出的 getExpandedRowModel 函数获取展开的行模型或实现自己的模型。

getIsRowExpanded

tsx

getIsRowExpanded?: (row: Row<TData>) => boolean

getIsRowExpanded?: (row: Row<TData>) => boolean

如果提供，允许您覆盖确定行当前是否展开的默认行为。

getRowCanExpand

tsx

getRowCanExpand?: (row: Row<TData>) => boolean

getRowCanExpand?: (row: Row<TData>) => boolean

如果提供，允许您覆盖确定行是否可以展开的默认行为。

paginateExpandedRows

tsx

paginateExpandedRows?: boolean

paginateExpandedRows?: boolean

如果为 true，展开的行将与表格的其余部分一起分页（这意味着展开的行可能跨越多个页面）。

如果为 false，展开的行将不被视为分页（这意味着展开的行将始终在其父页面上呈现。这也意味着将呈现比设置的页面大小更多的行）。

表格 API

setExpanded

tsx

setExpanded: (updater: Updater<ExpandedState>) => void

setExpanded: (updater: Updater<ExpandedState>) => void

通过更新函数或值更新表格的展开状态。

toggleAllRowsExpanded

tsx

toggleAllRowsExpanded: (expanded?: boolean) => void

toggleAllRowsExpanded: (expanded?: boolean) => void

切换所有行的展开状态。或者，提供一个值以设置展开状态。

resetExpanded

tsx

resetExpanded: (defaultState?: boolean) => void

resetExpanded: (defaultState?: boolean) => void

将表格的展开状态重置为初始状态。如果提供了 defaultState，则展开状态将重置为 {}。

getCanSomeRowsExpand

tsx

getCanSomeRowsExpand: () => boolean

getCanSomeRowsExpand: () => boolean

返回是否有任何可以展开的行。

getToggleAllRowsExpandedHandler

tsx

getToggleAllRowsExpandedHandler: () => (event: unknown) => void

getToggleAllRowsExpandedHandler: () => (event: unknown) => void

返回一个可用于切换所有行展开状态的处理程序。此处理程序旨在与 input[type=checkbox] 元素一起使用。

getIsSomeRowsExpanded

tsx

getIsSomeRowsExpanded: () => boolean

getIsSomeRowsExpanded: () => boolean

返回是否有任何当前展开的行。

getIsAllRowsExpanded

tsx

getIsAllRowsExpanded: () => boolean

getIsAllRowsExpanded: () => boolean

返回是否所有行都当前已展开。

getExpandedDepth

tsx

getExpandedDepth: () => number

getExpandedDepth: () => number

返回展开行的最大深度。

getExpandedRowModel

tsx

getExpandedRowModel: () => RowModel<TData>

getExpandedRowModel: () => RowModel<TData>

返回应用展开后的行模型。

getPreExpandedRowModel

tsx

getPreExpandedRowModel: () => RowModel<TData>

getPreExpandedRowModel: () => RowModel<TData>

返回应用展开前的行模型。