Docs
データテーブル

データテーブル

TanStack Table を使用して構築された強力なテーブルとデータグリッド。

Docs
Status
Amount
success
ken99@yahoo.com
$316.00
success
Abe45@gmail.com
$242.00
processing
Monserrat44@gmail.com
$837.00
success
Silas22@gmail.com
$874.00
failed
carmella@hotmail.com
$721.00
0 of 5 row(s) selected.

はじめに

これまで作成したすべてのデータテーブルまたはデータグリッドはユニークでした。それらはすべて動作が異なり、特定の並べ替えおよびフィルターの要件があり、異なるデータソースを使用しています。

これらのバリエーションをすべて単一のコンポーネントに結合するのは理にかなっていません。そうすると、ヘッドレス UI が提供する柔軟性が失われます。

そのため、データテーブルコンポーネントの代わりに、独自のものを作成する方法に関するガイドを提供する方が役立つと考えました。

基本的な <Table /> コンポーネントから始めて、複雑なデータテーブルを一から構築します。

目次

このガイドでは、TanStack Table と <Table /> コンポーネントを使用して、独自のカスタムデータテーブルを構築する方法を説明します。次のトピックを取り上げます。

インストール

  1. <Table /> コンポーネントをプロジェクトに追加します。
npx shadcn-ui@latest add table
  1. tanstack/react-table の依存関係を追加します。
npm install @tanstack/react-table

前提条件

最近の支払いを表示するテーブルを作成します。データは次のようになります。

type Payment = {
  id: string
  amount: number
  status: "pending" | "processing" | "success" | "failed"
  email: string
}
 
export const payments: Payment[] = [
  {
    id: "728ed52f",
    amount: 100,
    status: "pending",
    email: "m@example.com",
  },
  {
    id: "489e1d42",
    amount: 125,
    status: "processing",
    email: "example@gmail.com",
  },
  // ...
]

プロジェクト構造

次のファイル構造を作成します。

app
└── payments
    ├── columns.tsx
    ├── data-table.tsx
    └── page.tsx

Next.js の例を使用していますが、これは他の React フレームワークにも機能します。

  • columns.tsx (クライアントコンポーネント) には列の定義が含まれます。
  • data-table.tsx (クライアントコンポーネント) には <DataTable /> コンポーネントが含まれます。
  • page.tsx (サーバーコンポーネント) は、データを取得してテーブルをレンダリングする場所です。

基本的なテーブル

基本的なテーブルから始めましょう。

列の定義

最初に列を定義します。

app/payments/columns.tsx
"use client"
 
import { ColumnDef } from "@tanstack/react-table"
 
// この型はデータの形状を定義するために使用されます。
// 必要に応じて、ここで Zod スキーマを使用できます。
export type Payment = {
  id: string
  amount: number
  status: "pending" | "processing" | "success" | "failed"
  email: string
}
 
export const columns: ColumnDef<Payment>[] = [
  {
    accessorKey: "status",
    header: "Status",
  },
  {
    accessorKey: "email",
    header: "Email",
  },
  {
    accessorKey: "amount",
    header: "Amount",
  },
]

<DataTable /> コンポーネント

次に、テーブルをレンダリングするための <DataTable /> コンポーネントを作成します。

app/payments/data-table.tsx
"use client"
 
import {
  ColumnDef,
  flexRender,
  getCoreRowModel,
  useReactTable,
} from "@tanstack/react-table"
 
import {
  Table,
  TableBody,
  TableCell,
  TableHead,
  TableHeader,
  TableRow,
} from "@/components/ui/table"
 
interface DataTableProps<TData, TValue> {
  columns: ColumnDef<TData, TValue>[]
  data: TData[]
}
 
export function DataTable<TData, TValue>({
  columns,
  data,
}: DataTableProps<TData, TValue>) {
  const table = useReactTable({
    data,
    columns,
    getCoreRowModel: getCoreRowModel(),
  })
 
  return (
    <div className="rounded-md border">
      <Table>
        <TableHeader>
          {table.getHeaderGroups().map((headerGroup) => (
            <TableRow key={headerGroup.id}>
              {headerGroup.headers.map((header) => {
                return (
                  <TableHead key={header.id}>
                    {header.isPlaceholder
                      ? null
                      : flexRender(
                          header.column.columnDef.header,
                          header.getContext()
                        )}
                  </TableHead>
                )
              })}
            </TableRow>
          ))}
        </TableHeader>
        <TableBody>
          {table.getRowModel().rows?.length ? (
            table.getRowModel().rows.map((row) => (
              <TableRow
                key={row.id}
                data-state={row.getIsSelected() && "selected"}
              >
                {row.getVisibleCells().map((cell) => (
                  <TableCell key={cell.id}>
                    {flexRender(cell.column.columnDef.cell, cell.getContext())}
                  </TableCell>
                ))}
              </TableRow>
            ))
          ) : (
            <TableRow>
              <TableCell colSpan={columns.length} className="h-24 text-center">
                No results.
              </TableCell>
            </TableRow>
          )}
        </TableBody>
      </Table>
    </div>
  )
}

テーブルのレンダリング

最後に、page コンポーネントでテーブルをレンダリングします。

app/payments/page.tsx
import { Payment, columns } from "./columns"
import { DataTable } from "./data-table"
 
async function getData(): Promise<Payment[]> {
  // API からデータを取得します。
  return [
    {
      id: "728ed52f",
      amount: 100,
      status: "pending",
      email: "m@example.com",
    },
    // ...
  ]
}
 
export default async function DemoPage() {
  const data = await getData()
 
  return (
    <div className="container mx-auto py-10">
      <DataTable columns={columns} data={data} />
    </div>
  )
}

セルの書式設定

金額のセルをドル額で表示するように書式設定しましょう。また、セルを右揃えにします。

列の定義の更新

header と cell の定義を次のように更新して、金額用の新しい actions 列を追加します。actions セルは <Dropdown /> コンポーネントを返します。

app/payments/columns.tsx
"use client"
 
import { ColumnDef } from "@tanstack/react-table"
import { MoreHorizontal } from "lucide-react"