全局分面指南

全局分面指南

示例

想要直接跳到实现部分吗？请查看以下示例：

filters-faceted

API

全局分面 API

全局分面允许您从表格数据中为所有列生成值列表。例如，可以从所有列的所有行中生成表格中唯一值的列表，以用作自动完成筛选组件中的搜索建议。或者，可以从数字表格中生成最小值和最大值的元组，以用作范围滑块筛选组件的范围。

全局分面行模型

为了使用任何全局分面功能，您必须在表格选项中包含适当的行模型。

//仅导入您需要的行模型
import {
  getCoreRowModel,
  getFacetedRowModel,
  getFacetedMinMaxValues, //取决于 getFacetedRowModel
  getFacetedUniqueValues, //取决于 getFacetedRowModel
} from '@tanstack/react-table'
//...
const table = useReactTable({
  // 其他选项...
  getCoreRowModel: getCoreRowModel(),
  getFacetedRowModel: getFacetedRowModel(), //用于客户端分面的分面模型（其他分面方法依赖于此模型）
  getFacetedMinMaxValues: getFacetedMinMaxValues(), //如果您需要最小值/最大值
  getFacetedUniqueValues: getFacetedUniqueValues(), //如果您需要唯一值的列表
  //...
})

//仅导入您需要的行模型
import {
  getCoreRowModel,
  getFacetedRowModel,
  getFacetedMinMaxValues, //取决于 getFacetedRowModel
  getFacetedUniqueValues, //取决于 getFacetedRowModel
} from '@tanstack/react-table'
//...
const table = useReactTable({
  // 其他选项...
  getCoreRowModel: getCoreRowModel(),
  getFacetedRowModel: getFacetedRowModel(), //用于客户端分面的分面模型（其他分面方法依赖于此模型）
  getFacetedMinMaxValues: getFacetedMinMaxValues(), //如果您需要最小值/最大值
  getFacetedUniqueValues: getFacetedUniqueValues(), //如果您需要唯一值的列表
  //...
})

使用全局分面行模型

在表格选项中包含适当的行模型后，您将能够使用分面表格实例 API 访问由分面行模型生成的值列表。

// 用于自动完成筛选器的唯一值列表
const autoCompleteSuggestions =
 Array.from(table.getGlobalFacetedUniqueValues().keys())
  .sort()
  .slice(0, 5000);

// 用于自动完成筛选器的唯一值列表
const autoCompleteSuggestions =
 Array.from(table.getGlobalFacetedUniqueValues().keys())
  .sort()
  .slice(0, 5000);

// 用于范围筛选器的最小值和最大值的元组
const [min, max] = table.getGlobalFacetedMinMaxValues() ?? [0, 1];

// 用于范围筛选器的最小值和最大值的元组
const [min, max] = table.getGlobalFacetedMinMaxValues() ?? [0, 1];

自定义全局（服务器端）分面

您可以不在客户端使用内置的分面功能，而是在服务器端实现自己的分面逻辑，并将分面值传递给客户端。您可以使用 getGlobalFacetedUniqueValues 和 getGlobalFacetedMinMaxValues 表格选项从服务器端解析分面值。

const facetingQuery = useQuery(
  'faceting',
  async () => {
    const response = await fetch('/api/faceting');
    return response.json();
  },
  {
    onSuccess: (data) => {
      table.getGlobalFacetedUniqueValues = () => data.uniqueValues;
      table.getGlobalFacetedMinMaxValues = () => data.minMaxValues;
    },
  }
);

const facetingQuery = useQuery(
  'faceting',
  async () => {
    const response = await fetch('/api/faceting');
    return response.json();
  },
  {
    onSuccess: (data) => {
      table.getGlobalFacetedUniqueValues = () => data.uniqueValues;
      table.getGlobalFacetedMinMaxValues = () => data.minMaxValues;
    },
  }
);

在此示例中，我们使用 react-query 中的 useQuery 钩子从服务器获取分面数据。获取数据后，我们将 getGlobalFacetedUniqueValues 和 getGlobalFacetedMinMaxValues 表格选项设置为从服务器响应中返回分面值。这将允许表格使用服务器端分面数据生成自动完��建议和范围筛选器。