Table State (React) 指南

示例

想直接看实现？可以参考以下示例

TanStack Table 拥有一个简单底层的内部状态管理系统，用于存储和管理表格的状态。它还允许您选择性地提取出您需要在自己的状态管理中管理的任何状态。本指南将引导您了解与表格状态交互和管理状态的不同方式。

访问表格状态

您无需进行任何特殊设置即可使表格状态正常工作。如果您不将任何值传递给 state、initialState，或任何 on[State]Change 表格选项，表格将自行管理其内部状态。您可以通过使用 table.getState() 表格实例 API 来访问此内部状态的任何部分。

jsx

const table = useReactTable({
  columns,
  data,
  //...
})

console.log(table.getState()) //access the entire internal state
console.log(table.getState().rowSelection) //access just the row selection state

const table = useReactTable({
  columns,
  data,
  //...
})

console.log(table.getState()) //access the entire internal state
console.log(table.getState().rowSelection) //access just the row selection state

自定义初始状态

如果您只需要自定义某些状态的初始默认值，您仍然不需要自己管理任何状态。您只需在表格实例的 initialState 选项中设置值即可。

jsx

const table = useReactTable({
  columns,
  data,
  initialState: {
    columnOrder: ['age', 'firstName', 'lastName'], //customize the initial column order
    columnVisibility: {
      id: false //hide the id column by default
    },
    expanded: true, //expand all rows by default
    sorting: [
      {
        id: 'age',
        desc: true //sort by age in descending order by default
      }
    ]
  },
  //...
})

const table = useReactTable({
  columns,
  data,
  initialState: {
    columnOrder: ['age', 'firstName', 'lastName'], //customize the initial column order
    columnVisibility: {
      id: false //hide the id column by default
    },
    expanded: true, //expand all rows by default
    sorting: [
      {
        id: 'age',
        desc: true //sort by age in descending order by default
      }
    ]
  },
  //...
})

注意：每个特定状态只能在 initialState 或 state 中指定，不能两者都指定。如果您将某个特定状态值传递给 initialState 和 state，则 state 中的初始化状态将覆盖 initialState 中任何对应的值。

受控状态

如果您需要在应用程序的其他区域轻松访问表格状态，TanStack Table 可以轻松地在您自己的状态管理系统中控制和管理表格的任何或所有状态。您可以通过将自己的状态和状态管理函数传递给 state 和 on[State]Change 表格选项来做到这一点。

独立受控状态

您可以只控制您需要轻松访问的状态。如果您不需要，则不必控制所有表格状态。建议仅根据具体情况控制所需的状态。

为了控制某个特定状态，您需要将相应的 state 值和 on[State]Change 函数都传递给表格实例。

让我们以“手动”服务器端数据获取场景为例，说明过滤、排序和分页。您可以将过滤、排序和分页状态存储在您自己的状态管理中，但如果您的 API 不关心其他值（如列顺序、列可见性等），则可以省略它们。

jsx

const [columnFilters, setColumnFilters] = React.useState([]) //no default filters
const [sorting, setSorting] = React.useState([{
  id: 'age',
  desc: true, //sort by age in descending order by default
}]) 
const [pagination, setPagination] = React.useState({ pageIndex: 0, pageSize: 15 })

//Use our controlled state values to fetch data
const tableQuery = useQuery({
  queryKey: ['users', columnFilters, sorting, pagination],
  queryFn: () => fetchUsers(columnFilters, sorting, pagination),
  //...
})

const table = useReactTable({
  columns,
  data: tableQuery.data,
  //...
  state: {
    columnFilters, //pass controlled state back to the table (overrides internal state)
    sorting,
    pagination
  },
  onColumnFiltersChange: setColumnFilters, //hoist columnFilters state into our own state management
  onSortingChange: setSorting,
  onPaginationChange: setPagination,
})
//...

const [columnFilters, setColumnFilters] = React.useState([]) //no default filters
const [sorting, setSorting] = React.useState([{
  id: 'age',
  desc: true, //sort by age in descending order by default
}]) 
const [pagination, setPagination] = React.useState({ pageIndex: 0, pageSize: 15 })

//Use our controlled state values to fetch data
const tableQuery = useQuery({
  queryKey: ['users', columnFilters, sorting, pagination],
  queryFn: () => fetchUsers(columnFilters, sorting, pagination),
  //...
})

const table = useReactTable({
  columns,
  data: tableQuery.data,
  //...
  state: {
    columnFilters, //pass controlled state back to the table (overrides internal state)
    sorting,
    pagination
  },
  onColumnFiltersChange: setColumnFilters, //hoist columnFilters state into our own state management
  onSortingChange: setSorting,
  onPaginationChange: setPagination,
})
//...

完全受控状态

或者，您可以通过 onStateChange 表格选项来控制整个表格状态。它会将整个表格状态提升到您自己的状态管理系统中。请谨慎使用此方法，因为您可能会发现将一些频繁变化的状态值（如 columnSizingInfo 状态）提升到 React 树的更上层可能会导致性能问题。

可能还需要一些额外的技巧才能使其正常工作。如果您使用 onStateChange 表格选项，则 state 的初始值必须包含您想使用的所有功能的相应状态值。您可以手动输入所有初始状态值，或者以特殊方式使用 table.setOptions API，如下所示。

jsx

//create a table instance with default state values
const table = useReactTable({
  columns,
  data,
  //... Note: `state` values are NOT passed in yet
})


const [state, setState] = React.useState({
  ...table.initialState, //populate the initial state with all of the default state values from the table instance
  pagination: {
    pageIndex: 0,
    pageSize: 15 //optionally customize the initial pagination state.
  }
})

//Use the table.setOptions API to merge our fully controlled state onto the table instance
table.setOptions(prev => ({
  ...prev, //preserve any other options that we have set up above
  state, //our fully controlled state overrides the internal state
  onStateChange: setState //any state changes will be pushed up to our own state management
}))

//create a table instance with default state values
const table = useReactTable({
  columns,
  data,
  //... Note: `state` values are NOT passed in yet
})


const [state, setState] = React.useState({
  ...table.initialState, //populate the initial state with all of the default state values from the table instance
  pagination: {
    pageIndex: 0,
    pageSize: 15 //optionally customize the initial pagination state.
  }
})

//Use the table.setOptions API to merge our fully controlled state onto the table instance
table.setOptions(prev => ({
  ...prev, //preserve any other options that we have set up above
  state, //our fully controlled state overrides the internal state
  onStateChange: setState //any state changes will be pushed up to our own state management
}))

状态变更回调

到目前为止，我们已经看到了 on[State]Change 和 onStateChange 表格选项如何将表格状态的更改“提升”到我们自己的状态管理中。然而，在使用这些选项时，有几点需要注意。

1. 状态变更回调必须在其 state 选项中包含相应的状态值。

指定 on[State]Change 回调函数会告诉表格实例，这将是一个受控状态。如果您不指定相应的 state 值，该状态将“冻结”在其初始值。

jsx

const [sorting, setSorting] = React.useState([])
//...
const table = useReactTable({
  columns,
  data,
  //...
  state: {
    sorting, //required because we are using `onSortingChange`
  },
  onSortingChange: setSorting, //makes the `state.sorting` controlled
})

const [sorting, setSorting] = React.useState([])
//...
const table = useReactTable({
  columns,
  data,
  //...
  state: {
    sorting, //required because we are using `onSortingChange`
  },
  onSortingChange: setSorting, //makes the `state.sorting` controlled
})

2. 更新器可以是原始值，也可以是回调函数。

on[State]Change 和 onStateChange 回调函数的用法与 React 中的 setState 函数完全相同。更新器值可以是新的状态值，也可以是一个回调函数，该函数接收先前状态值并返回新的状态值。

这对我们有什么影响？这意味着，如果您想在任何 on[State]Change 回调中添加一些额外的逻辑，您可以这样做，但您需要检查新的传入更新值是函数还是值。

jsx

const [sorting, setSorting] = React.useState([])
const [pagination, setPagination] = React.useState({ pageIndex: 0, pageSize: 10 })

const table = useReactTable({
  columns,
  data,
  //...
  state: {
    pagination,
    sorting,
  }
  //syntax 1
  onPaginationChange: (updater) => {
    setPagination(old => {
      const newPaginationValue = updater instanceof Function ? updater(old) : updater
      //do something with the new pagination value
      //...
      return newPaginationValue
    })
  },
  //syntax 2
  onSortingChange: (updater) => {
    const newSortingValue = updater instanceof Function ? updater(sorting) : updater
    //do something with the new sorting value
    //...
    setSorting(updater) //normal state update
  }
})

const [sorting, setSorting] = React.useState([])
const [pagination, setPagination] = React.useState({ pageIndex: 0, pageSize: 10 })

const table = useReactTable({
  columns,
  data,
  //...
  state: {
    pagination,
    sorting,
  }
  //syntax 1
  onPaginationChange: (updater) => {
    setPagination(old => {
      const newPaginationValue = updater instanceof Function ? updater(old) : updater
      //do something with the new pagination value
      //...
      return newPaginationValue
    })
  },
  //syntax 2
  onSortingChange: (updater) => {
    const newSortingValue = updater instanceof Function ? updater(sorting) : updater
    //do something with the new sorting value
    //...
    setSorting(updater) //normal state update
  }
})

状态类型

TanStack Table 中的所有复杂状态都有自己的 TypeScript 类型，您可以导入并使用它们。这对于确保您正在为要控制的状态值使用正确的数据结构和属性非常有用。

tsx

import { useReactTable, type SortingState } from '@tanstack/react-table'
//...
const [sorting, setSorting] = React.useState<SortingState[]>([
  {
    id: 'age', //you should get autocomplete for the `id` and `desc` properties
    desc: true,
  }
])

import { useReactTable, type SortingState } from '@tanstack/react-table'
//...
const [sorting, setSorting] = React.useState<SortingState[]>([
  {
    id: 'age', //you should get autocomplete for the `id` and `desc` properties
    desc: true,
  }
])

Table State (React) 指南

示例