Files
hi-frontend/packages/ui/src/composed/pro-table/pro-table.tsx
T
shanshanzhong147 dfe1bafd1c feat: 用户订阅流量限速规则编辑器与列表信息增强
- 订阅表单新增卡片式流量限速规则编辑器(TrafficLimitRuleEditor),替换 ArrayInput
- 用户列表与订阅详情展示会员状态(member_status)、最近登录时间(last_login_time)
- ProTable 支持列级 meta.className 自定义样式
- 仪表盘统计与促销规则表单配套调整,用户文案双语同步
2026-07-09 13:34:03 -07:00

500 lines
14 KiB
TypeScript

"use client";
import {
type ColumnDef,
type ColumnFiltersState,
flexRender,
getCoreRowModel,
getFilteredRowModel,
getPaginationRowModel,
getSortedRowModel,
type SortingState,
useReactTable,
type VisibilityState,
} from "@tanstack/react-table";
import {
Alert,
AlertDescription,
AlertTitle,
} from "@workspace/ui/components/alert";
import { Button } from "@workspace/ui/components/button";
import { Checkbox } from "@workspace/ui/components/checkbox";
import {
Table,
TableBody,
TableCell,
TableHead,
TableHeader,
TableRow,
} from "@workspace/ui/components/table";
import Empty from "@workspace/ui/composed/empty";
import {
ColumnFilter,
type IParams,
} from "@workspace/ui/composed/pro-table/column-filter";
import { ColumnHeader } from "@workspace/ui/composed/pro-table/column-header";
import { ColumnToggle } from "@workspace/ui/composed/pro-table/column-toggle";
import { Pagination } from "@workspace/ui/composed/pro-table/pagination";
import { SortableRow } from "@workspace/ui/composed/pro-table/sortable-row";
import { ProTableWrapper } from "@workspace/ui/composed/pro-table/wrapper";
import { cn } from "@workspace/ui/lib/utils";
import { useSize } from "ahooks";
import {
CircleAlert,
GripVertical,
ListRestart,
Loader,
RefreshCcw,
} from "lucide-react";
import type React from "react";
import {
Fragment,
useEffect,
useImperativeHandle,
useRef,
useState,
} from "react";
export interface ProTableProps<TData, TValue> {
columns: ColumnDef<TData, TValue>[];
request: (
pagination: {
page: number;
size: number;
},
filter: TValue
) => Promise<{ list: TData[]; total: number }>;
params?: IParams[];
header?: {
title?: React.ReactNode;
toolbar?: React.ReactNode | React.ReactNode[];
hidden?: boolean;
};
actions?: {
render?: (row: TData) => React.ReactNode[];
batchRender?: (rows: TData[]) => React.ReactNode[];
};
action?: React.Ref<ProTableActions | undefined>;
texts?: Partial<{
actions: string;
asc: string;
desc: string;
hide: string;
textRowsPerPage: string;
textPageOf: (current: number, total: number) => string;
selectedRowsText: (total: number) => string;
}>;
empty?: React.ReactNode;
error?: React.ReactNode;
onSort?: (
sourceId: string | number,
targetId: string | number | null,
items: TData[]
) => Promise<TData[]>;
initialFilters?: Record<string, unknown>;
}
export interface ProTableActions {
refresh: () => void;
reset: () => void;
}
export function ProTable<
TData extends Record<string, unknown> & { id?: string | number },
TValue extends Record<string, unknown>,
>({
columns,
request,
params,
header,
actions,
action,
texts,
empty,
error,
onSort,
initialFilters,
}: ProTableProps<TData, TValue>) {
const [sorting, setSorting] = useState<SortingState>([]);
const [columnFilters, setColumnFilters] = useState<ColumnFiltersState>(() => {
if (initialFilters) {
return Object.entries(initialFilters).map(([id, value]) => ({
id,
value,
})) as ColumnFiltersState;
}
return [];
});
const [columnVisibility, setColumnVisibility] = useState<VisibilityState>({});
const [rowSelection, setRowSelection] = useState({});
const [data, setData] = useState<TData[]>([]);
const [rowCount, setRowCount] = useState<number>(0);
const [isLoading, setIsLoading] = useState(false);
const [requestError, setRequestError] = useState(false);
const [pagination, setPagination] = useState({
pageIndex: 0,
pageSize: 200,
});
const loading = useRef(false);
const table = useReactTable({
data,
columns: [
...(onSort
? [
{
id: "sortable",
header: (
<GripVertical className="h-4 w-4 cursor-move text-gray-500 hover:text-gray-700" />
),
enableSorting: false,
enableHiding: false,
},
]
: []),
...(actions?.batchRender ? [createSelectColumn<TData, TValue>()] : []),
...columns.map(
(column) =>
({
enableSorting: false,
...column,
}) as ColumnDef<TData, TValue>
),
...(actions?.render
? ([
{
id: "actions",
header: texts?.actions,
cell: ({ row }) => (
<div className="flex items-center justify-end gap-2">
{actions?.render?.(row.original).map((item, index) => (
<Fragment key={index}>{item}</Fragment>
))}
</div>
),
enableSorting: false,
enableHiding: false,
},
] as ColumnDef<TData, TValue>[])
: []),
] as ColumnDef<TData, TValue>[],
onPaginationChange: setPagination,
onSortingChange: setSorting,
onColumnFiltersChange: setColumnFilters,
getCoreRowModel: getCoreRowModel(),
getPaginationRowModel: getPaginationRowModel(),
getSortedRowModel: getSortedRowModel(),
getFilteredRowModel: getFilteredRowModel(),
onColumnVisibilityChange: setColumnVisibility,
onRowSelectionChange: setRowSelection,
state: {
sorting,
columnFilters,
columnVisibility,
rowSelection,
pagination,
},
manualPagination: true,
manualFiltering: true,
rowCount,
manualSorting: true,
});
const fetchData = async () => {
if (loading.current) return;
loading.current = true;
setIsLoading(true);
setRequestError(false);
try {
const response = await request(
{
page: pagination.pageIndex + 1,
size: pagination.pageSize,
},
Object.fromEntries(
columnFilters.map((item) => [item.id, item.value])
) as TValue
);
setData(response.list);
setRowCount(response.total);
} catch (_error) {
setData([]);
setRowCount(0);
setRequestError(true);
} finally {
loading.current = false;
setIsLoading(false);
}
};
const reset = async () => {
table.resetSorting();
table.resetColumnFilters();
table.resetGlobalFilter(true);
table.resetColumnVisibility();
table.resetRowSelection();
table.resetPagination();
};
const ref = useRef<HTMLDivElement>(null);
const size = useSize(ref);
useImperativeHandle(action, () => ({
refresh: fetchData,
reset,
}));
useEffect(() => {
fetchData();
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [
pagination.pageIndex,
pagination.pageSize,
JSON.stringify(columnFilters),
]);
const selectedRows = table
.getSelectedRowModel()
.flatRows.map((row) => row.original);
const selectedCount = selectedRows.length;
return (
<div className="flex flex-col gap-4" ref={ref}>
{!header?.hidden && (
<div className="flex flex-wrap-reverse items-center justify-between gap-4">
<div>
{params ? (
<ColumnFilter
filters={Object.fromEntries(
columnFilters.map((item) => [item.id, item.value])
)}
params={params}
table={table}
/>
) : (
header?.title
)}
</div>
<div className="flex flex-1 items-center justify-end gap-2">
<Button onClick={fetchData} size="icon" variant="outline">
<RefreshCcw />
</Button>
<ColumnToggle table={table} />
<Button onClick={reset} size="icon" variant="outline">
<ListRestart />
</Button>
{header?.toolbar}
</div>
</div>
)}
{selectedCount > 0 && actions?.batchRender && (
<Alert className="flex items-center justify-between">
<AlertTitle className="m-0">
{texts?.selectedRowsText?.(selectedCount) ||
`Selected ${selectedCount} rows`}
</AlertTitle>
<AlertDescription className="flex gap-2">
{actions.batchRender(selectedRows)}
</AlertDescription>
</Alert>
)}
<div
className="relative w-auto overflow-x-auto rounded-md border"
style={{
width: size?.width,
}}
>
<ProTableWrapper data={data} onSort={onSort} setData={setData}>
<Table className="w-full">
<TableHeader>
{table.getHeaderGroups().map((headerGroup) => (
<TableRow key={headerGroup.id}>
{headerGroup.headers.map((header) => (
<TableHead
className={cn(
"!z-auto",
getTableHeaderClass(header.column.id),
getColumnClassName(header)
)}
key={header.id}
>
<ColumnHeader
header={header}
text={{
asc: texts?.asc,
desc: texts?.desc,
hide: texts?.hide,
}}
/>
</TableHead>
))}
</TableRow>
))}
</TableHeader>
<TableBody>
{requestError ? (
<TableRow>
<TableCell
className="py-12"
colSpan={table.getAllLeafColumns().length}
>
{error || <ProTableErrorState />}
</TableCell>
</TableRow>
) : table.getRowModel()?.rows?.length ? (
onSort ? (
table.getRowModel().rows.map((row) => (
<SortableRow
data-state={row.getIsSelected() && "selected"}
id={
row.original.id
? String(row.original.id)
: String(row.index)
}
isSortable
key={
row.original.id
? String(row.original.id)
: String(row.index)
}
>
{row
.getVisibleCells()
.filter((cell) => cell.column.id !== "sortable")
.map((cell) => (
<TableCell
className={cn(
getTableCellClass(cell.column.id),
getColumnClassName(cell)
)}
key={cell.id}
>
{flexRender(
cell.column.columnDef.cell,
cell.getContext()
)}
</TableCell>
))}
</SortableRow>
))
) : (
table.getRowModel().rows.map((row) => (
<TableRow
data-state={row.getIsSelected() && "selected"}
key={row.id}
>
{row.getVisibleCells().map((cell) => (
<TableCell
className={cn(
getTableCellClass(cell.column.id),
getColumnClassName(cell)
)}
key={cell.id}
>
{flexRender(
cell.column.columnDef.cell,
cell.getContext()
)}
</TableCell>
))}
</TableRow>
))
)
) : (
<TableRow>
<TableCell
className="py-24"
colSpan={table.getAllLeafColumns().length}
>
{empty || <Empty />}
</TableCell>
</TableRow>
)}
</TableBody>
</Table>
</ProTableWrapper>
{isLoading && (
<div
aria-label="Loading data"
className="absolute top-0 z-20 flex h-full w-full items-center justify-center bg-muted/80"
role="status"
>
<Loader className="h-4 w-4 animate-spin" />
</div>
)}
</div>
{rowCount > 0 && <Pagination table={table} />}
</div>
);
}
function ProTableErrorState() {
return (
<Alert className="mx-auto max-w-md" variant="destructive">
<CircleAlert aria-hidden="true" />
<AlertTitle>Failed to load data</AlertTitle>
<AlertDescription>Refresh the table or try again later.</AlertDescription>
</Alert>
);
}
function createSelectColumn<TData, TValue>(): ColumnDef<TData, TValue> {
return {
id: "selected",
header: ({ table }) => (
<Checkbox
aria-label="Select all"
checked={
table.getIsAllPageRowsSelected() ||
(table.getIsSomePageRowsSelected() && "indeterminate")
}
onCheckedChange={(value) => table.toggleAllPageRowsSelected(!!value)}
/>
),
cell: ({ row }) => (
<Checkbox
aria-label="Select row"
checked={row.getIsSelected()}
onCheckedChange={(value) => row.toggleSelected(!!value)}
/>
),
enableSorting: false,
enableHiding: false,
};
}
function getTableHeaderClass(columnId: string) {
if (["sortable", "selected"].includes(columnId)) {
return "sticky left-0 z-10 bg-background shadow-[2px_0_5px_-2px_rgba(0,0,0,0.1)] [&:has([role=checkbox])]:pr-2";
}
if (columnId === "actions") {
return "sticky right-0 z-10 text-right bg-background shadow-[-2px_0_5px_-2px_rgba(0,0,0,0.1)]";
}
return "truncate";
}
function getTableCellClass(columnId: string) {
if (["sortable", "selected"].includes(columnId)) {
return "sticky left-0 bg-background shadow-[2px_0_5px_-2px_rgba(0,0,0,0.1)]";
}
if (columnId === "actions") {
return "sticky right-0 bg-background shadow-[-2px_0_5px_-2px_rgba(0,0,0,0.1)]";
}
return "truncate";
}
function getColumnClassName(
columnLike: {
column: {
columnDef: {
meta?: {
className?: string;
};
};
};
}
) {
return columnLike.column.columnDef.meta?.className || "";
}