列指南

列定义是构建表格最重要的部分。它们负责：

构建将用于所有操作（包括排序、筛选、分组等）的底层数据模型。
将数据模型格式化为将在表格中显示的内容。
创建表头组、表头和表脚。
创建仅用于显示的列，例如操作按钮、复选框、展开器、迷你图等。

列定义类型

以下“类型”的列定义实际上并非 TypeScript 类型，而更像是一种讨论和描述列定义总体类别的方式：

访问器列
- 访问器列具有底层数据模型，这意味着它们可以进行排序、筛选、分组等。
显示列
- 显示列没有数据模型，这意味着它们不能进行排序、筛选等，但它们可用于在表格中显示任意内容，例如行操作按钮、复选框、展开器等。
分组列
- 分组列没有数据模型，因此它们也不能进行排序、筛选等，并且用于将其他列组合在一起。通常为列组定义表头或表脚。

列助手

虽然列定义最终只是普通对象，但表格核心公开了一个 createColumnHelper 函数，当使用行类型调用该函数时，它会返回一个实用程序，用于以尽可能高的类型安全性创建不同的列定义类型。

以下是创建和使用列助手的示例：

tsx

// 定义行形状
type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

const columnHelper = createColumnHelper<Person>()

// 创建一些列！
const defaultColumns = [
  // 显示列
  columnHelper.display({
    id: 'actions',
    cell: props => <RowActions row={props.row} />,
  }),
  // 分组列
  columnHelper.group({
    header: 'Name',
    footer: props => props.column.id,
    columns: [
      // 访问器列
      columnHelper.accessor('firstName', {
        cell: info => info.getValue(),
        footer: props => props.column.id,
      }),
      // 访问器列
      columnHelper.accessor(row => row.lastName, {
        id: 'lastName',
        cell: info => info.getValue(),
        header: () => <span>Last Name</span>,
        footer: props => props.column.id,
      }),
    ],
  }),
  // 分组列
  columnHelper.group({
    header: 'Info',
    footer: props => props.column.id,
    columns: [
      // 访问器列
      columnHelper.accessor('age', {
        header: () => 'Age',
        footer: props => props.column.id,
      }),
      // 分组列
      columnHelper.group({
        header: 'More Info',
        columns: [
          // 访问器列
          columnHelper.accessor('visits', {
            header: () => <span>Visits</span>,
            footer: props => props.column.id,
          }),
          // 访问器列
          columnHelper.accessor('status', {
            header: 'Status',
            footer: props => props.column.id,
          }),
          // 访问器列
          columnHelper.accessor('progress', {
            header: 'Profile Progress',
            footer: props => props.column.id,
          }),
        ],
      }),
    ],
  }),
]

// 定义行形状
type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

const columnHelper = createColumnHelper<Person>()

// 创建一些列！
const defaultColumns = [
  // 显示列
  columnHelper.display({
    id: 'actions',
    cell: props => <RowActions row={props.row} />,
  }),
  // 分组列
  columnHelper.group({
    header: 'Name',
    footer: props => props.column.id,
    columns: [
      // 访问器列
      columnHelper.accessor('firstName', {
        cell: info => info.getValue(),
        footer: props => props.column.id,
      }),
      // 访问器列
      columnHelper.accessor(row => row.lastName, {
        id: 'lastName',
        cell: info => info.getValue(),
        header: () => <span>Last Name</span>,
        footer: props => props.column.id,
      }),
    ],
  }),
  // 分组列
  columnHelper.group({
    header: 'Info',
    footer: props => props.column.id,
    columns: [
      // 访问器列
      columnHelper.accessor('age', {
        header: () => 'Age',
        footer: props => props.column.id,
      }),
      // 分组列
      columnHelper.group({
        header: 'More Info',
        columns: [
          // 访问器列
          columnHelper.accessor('visits', {
            header: () => <span>Visits</span>,
            footer: props => props.column.id,
          }),
          // 访问器列
          columnHelper.accessor('status', {
            header: 'Status',
            footer: props => props.column.id,
          }),
          // 访问器列
          columnHelper.accessor('progress', {
            header: 'Profile Progress',
            footer: props => props.column.id,
          }),
        ],
      }),
    ],
  }),
]

创建访问器列

数据列的独特之处在于，必须将其配置为为 data 数组中的每个项提取原始值。

有 3 种方法可以做到这一点：

如果您的项是对象，请使用与要提取的值对应的对象键。
如果您的项是嵌套数组，请使用与要提取的值对应的数组索引。
使用返回要提取的值的访问器函数。

对象键

如果您的每个项都是具有以下形状的对象：

tsx

type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

您可以像这样提取 firstName 值：

tsx


columnHelper.accessor('firstName')

// 或

{
  accessorKey: 'firstName',
}


columnHelper.accessor('firstName')

// 或

{
  accessorKey: 'firstName',
}

数组索引

如果您的每个项都是具有以下形状的数组：

tsx

type Sales = [Date, number]

type Sales = [Date, number]

您可以像这样提取 number 值：

tsx

columnHelper.accessor(1)

// 或

{
  accessorKey: 1,
}

columnHelper.accessor(1)

// 或

{
  accessorKey: 1,
}

访问器函数

如果您的每个项都是具有以下形状的对象：

tsx

type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

type Person = {
  firstName: string
  lastName: string
  age: number
  visits: number
  status: string
  progress: number
}

您可以像这样提取计算的全名值：

tsx

columnHelper.accessor(row => `${row.firstName} ${row.lastName}`, {
  id: 'fullName',
})

// 或

{
  id: 'fullName',
  accessorFn: row => `${row.firstName} ${row.lastName}`,
}

columnHelper.accessor(row => `${row.firstName} ${row.lastName}`, {
  id: 'fullName',
})

// 或

{
  id: 'fullName',
  accessorFn: row => `${row.firstName} ${row.lastName}`,
}

🧠 请记住，访问的值是用于排序、筛选等的值，因此您需要确保访问器函数返回一个可以以有意义的方式操作的原始值。如果返回非原始值（如对象或数组），则需要适当的筛选/排序/分组函数来操作它们，甚至可能需要提供您自己的函数！😬

唯一列 ID

列使用 3 种策略进行唯一标识：

如果使用对象键或数组索引定义访问器列，则将使用相同的键或索引来唯一标识该列。
- 对象键中的任何句点 (.) 都将替换为下划线 (_)。
如果使用访问器函数定义访问器列
- 列的 id 属性将用于唯一标识该列，或者
- 如果提供了原始 string 标头，则该标头字符串将用于唯一标识该列

🧠 一个简单的记忆方法：如果使用访问器函数定义列，请提供字符串标头或提供唯一的 id 属性。

列格式��和渲染

默认情况下，列单元格将其数据模型值显示为字符串。您可以通过提供自定义渲染实现来覆盖此行为。每个实现都提供了有关单元格、表头或表脚的相关信息，并返回您的框架适配器可以渲染的内容，例如 JSX/组件/字符串等。这将取决于您使用的适配器。

您可以使用以下几个格式化程序：

cell：用于格式化单元格。
aggregatedCell：用于在聚合时格式化单元格。
header：用于格式化表头。
footer：用于格式化表脚。

单元格格式化

您可以通过将函数传递给 cell 属性并使用 props.getValue() 函数访问单元格的值来提供自定义单元格格式化程序：

tsx

columnHelper.accessor('firstName', {
  cell: props => <span>{props.getValue().toUpperCase()}</span>,
})

columnHelper.accessor('firstName', {
  cell: props => <span>{props.getValue().toUpperCase()}</span>,
})

单元格格式化程序还提供了 row 和 table 对象，允许您自定义单元格格式化，而不仅仅是单元格值。以下示例提供了 firstName 作为访问器，但也显示了位于原始行对象上的前缀用户 ID：

tsx

columnHelper.accessor('firstName', {
  cell: props => (
    <span>{`${props.row.original.id} - ${props.getValue()}`}</span>
  ),
})

columnHelper.accessor('firstName', {
  cell: props => (
    <span>{`${props.row.original.id} - ${props.getValue()}`}</span>
  ),
})

聚合单元格格式化

有关聚合单元格的更多信息，请参阅分组。

表头和表脚格式化

表头和表脚无法访问行数据，但仍使用相同的概念来显示自定义内容。

API

列��义指南

列定义类型

列助手

创建访问器列

对象键

数组索引

访问器函数

唯一列 ID

列格式��和渲染

单元格格式化

聚合单元格格式化

表头和表脚格式化

列指南

API

列���义指南

列定义类型

列助手

创建访问器列

对象键

数组索引

访问器函数

唯一列 ID

列格式���和渲染

单元格格式化

聚合单元格格式化

表头和表脚格式化

列��义指南

列格式��和渲染