Advanced Data Table
Generate data tables with TanStack Table featuring sorting, filtering, pagination, and row selection.
Prerequisites
bash
npm install @tanstack/react-table npx shadcn@latest add table input button dropdown-menu checkbox
Complete DataTable Component
1. Column Definitions Helper
typescript
// src/components/ui/data-table/columns.tsx
import type { ColumnDef, Row } from '@tanstack/react-table'
import { Checkbox } from '@/components/ui/checkbox'
import { Button } from '@/components/ui/button'
import { ArrowUpDown, MoreHorizontal } from 'lucide-react'
import {
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuTrigger,
} from '@/components/ui/dropdown-menu'
// Sortable header helper
export function sortableHeader(label: string) {
return ({ column }: { column: { toggleSorting: (desc?: boolean) => void; getIsSorted: () => 'asc' | 'desc' | false } }) => (
<Button
variant="ghost"
onClick={() => column.toggleSorting(column.getIsSorted() === 'asc')}
className="-ml-4"
>
{label}
<ArrowUpDown className="ml-2 h-4 w-4" />
</Button>
)
}
// Selection column
export function selectionColumn<T>(): ColumnDef<T> {
return {
id: 'select',
header: ({ table }) => (
<Checkbox
checked={table.getIsAllPageRowsSelected()}
onCheckedChange={(value) => table.toggleAllPageRowsSelected(!!value)}
aria-label="Select all"
/>
),
cell: ({ row }) => (
<Checkbox
checked={row.getIsSelected()}
onCheckedChange={(value) => row.toggleSelected(!!value)}
aria-label="Select row"
/>
),
enableSorting: false,
enableHiding: false,
}
}
// Actions column
export function actionsColumn<T>(
actions: Array<{ label: string; onClick: (row: Row<T>) => void }>
): ColumnDef<T> {
return {
id: 'actions',
cell: ({ row }) => (
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button variant="ghost" className="h-8 w-8 p-0">
<MoreHorizontal className="h-4 w-4" />
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent align="end">
{actions.map((action) => (
<DropdownMenuItem key={action.label} onClick={() => action.onClick(row)}>
{action.label}
</DropdownMenuItem>
))}
</DropdownMenuContent>
</DropdownMenu>
),
}
}
2. DataTable Component
typescript
// src/components/ui/data-table/data-table.tsx
import { useState } from 'react'
import {
useReactTable,
getCoreRowModel,
getPaginationRowModel,
getSortedRowModel,
getFilteredRowModel,
flexRender,
type ColumnDef,
type SortingState,
type ColumnFiltersState,
type VisibilityState,
type RowSelectionState,
} from '@tanstack/react-table'
import {
Table,
TableBody,
TableCell,
TableHead,
TableHeader,
TableRow,
} from '@/components/ui/table'
import { Input } from '@/components/ui/input'
import { Button } from '@/components/ui/button'
interface DataTableProps<TData, TValue> {
columns: ColumnDef<TData, TValue>[]
data: TData[]
searchKey?: string
searchPlaceholder?: string
}
export function DataTable<TData, TValue>({
columns,
data,
searchKey,
searchPlaceholder = 'Search...',
}: DataTableProps<TData, TValue>) {
const [sorting, setSorting] = useState<SortingState>([])
const [columnFilters, setColumnFilters] = useState<ColumnFiltersState>([])
const [columnVisibility, setColumnVisibility] = useState<VisibilityState>({})
const [rowSelection, setRowSelection] = useState<RowSelectionState>({})
const table = useReactTable({
data,
columns,
getCoreRowModel: getCoreRowModel(),
getPaginationRowModel: getPaginationRowModel(),
getSortedRowModel: getSortedRowModel(),
getFilteredRowModel: getFilteredRowModel(),
onSortingChange: setSorting,
onColumnFiltersChange: setColumnFilters,
onColumnVisibilityChange: setColumnVisibility,
onRowSelectionChange: setRowSelection,
state: {
sorting,
columnFilters,
columnVisibility,
rowSelection,
},
})
return (
<div className="space-y-4">
{/* Search */}
{searchKey && (
<Input
placeholder={searchPlaceholder}
value={(table.getColumn(searchKey)?.getFilterValue() as string) ?? ''}
onChange={(e) => table.getColumn(searchKey)?.setFilterValue(e.target.value)}
className="max-w-sm"
/>
)}
{/* Table */}
<div className="rounded-md border">
<Table>
<TableHeader>
{table.getHeaderGroups().map((headerGroup) => (
<TableRow key={headerGroup.id}>
{headerGroup.headers.map((header) => (
<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>
{/* Pagination */}
<div className="flex items-center justify-between">
<p className="text-sm text-muted-foreground">
{table.getFilteredSelectedRowModel().rows.length} of{' '}
{table.getFilteredRowModel().rows.length} row(s) selected.
</p>
<div className="flex gap-2">
<Button
variant="outline"
size="sm"
onClick={() => table.previousPage()}
disabled={!table.getCanPreviousPage()}
>
Previous
</Button>
<Button
variant="outline"
size="sm"
onClick={() => table.nextPage()}
disabled={!table.getCanNextPage()}
>
Next
</Button>
</div>
</div>
</div>
)
}
3. Usage Example
typescript
// src/app/users/page.tsx
import { DataTable } from '@/components/ui/data-table/data-table'
import { selectionColumn, sortableHeader, actionsColumn } from '@/components/ui/data-table/columns'
import type { ColumnDef } from '@tanstack/react-table'
interface User {
id: string
name: string
email: string
role: 'admin' | 'user'
createdAt: Date
}
const columns: ColumnDef<User>[] = [
selectionColumn<User>(),
{
accessorKey: 'name',
header: sortableHeader('Name'),
},
{
accessorKey: 'email',
header: sortableHeader('Email'),
},
{
accessorKey: 'role',
header: 'Role',
cell: ({ row }) => (
<span className="capitalize">{row.getValue('role')}</span>
),
},
{
accessorKey: 'createdAt',
header: sortableHeader('Created'),
cell: ({ row }) => new Date(row.getValue('createdAt')).toLocaleDateString(),
},
actionsColumn<User>([
{ label: 'Edit', onClick: (row) => console.log('Edit', row.original) },
{ label: 'Delete', onClick: (row) => console.log('Delete', row.original) },
]),
]
export default function UsersPage({ users }: { users: User[] }) {
return (
<DataTable
columns={columns}
data={users}
searchKey="email"
searchPlaceholder="Filter by email..."
/>
)
}
Features Summary
| Feature | Implementation |
|---|---|
| Sorting | Click column headers with sortableHeader() |
| Filtering | Set searchKey prop for global search |
| Pagination | Built-in with Previous/Next buttons |
| Row Selection | Add selectionColumn() to columns |
| Row Actions | Add actionsColumn() with custom actions |
Accessibility
- •Checkbox columns include
aria-labelattributes - •Table uses semantic HTML (
<table>,<thead>,<tbody>) - •Sort buttons are keyboard accessible
Next Steps
- •Use
/ds-virtualizefor tables with 1000+ rows - •See LAYER-07-INTERACTION-PATTERNS for loading states