tableRequest, rowsOf
tableRequest nối một ProTable tự viết với một API danh sách: trang, sắp xếp, lọc và ô tìm đi thẳng tới query của listOf. rowsOf lấy { data, total } từ kết quả dạng mảng hay dạng trang.
Phần lớn trang danh sách không cần hàm này: <ResourceList> của manh/shell đã có tab trạng thái, tìm, phân trang và form tạo, xem Trang danh sách. Dùng tableRequest khi bảng có bố cục riêng.
Cách dùng
import { useRef } from "react";
import { PageContainer, ProTable, type ActionType } from "@ant-design/pro-components";
import { useApiClient } from "app/api";
import { tableRequest } from "app/hooks";
import { orderColumns } from "./orders-columns";
export default function OrdersPage() {
const api = useApiClient();
const ref = useRef<ActionType>();
return (
<PageContainer title="Đơn hàng">
<ProTable rowKey="id" actionRef={ref} columns={orderColumns}
request={tableRequest(api.orders.list)} options={{ search: true }} />
</PageContainer>
);
}Chữ ký
function tableRequest(
list: (q: any) => Promise<any>,
extra?: Record<string, unknown>,
): (params?: any, sort?: Record<string, "ascend" | "descend" | null>, filter?: Record<string, any>) =>
Promise<{ data: any[]; total: number; success: boolean }>;
function rowsOf<T = any>(r: any): { data: T[]; total: number };Tham số
tableRequest(list, extra?):
list: hàm danh sách của useApiClient, ví dụapi.orders.list.extra: trường luôn gửi kèm mỗi lần tải, ví dụ{ customerId: 12 }để bảng chỉ hiện đơn của một khách.
rowsOf(r):
r: kết quả của một API danh sách: một mảng, hoặc object códata(hayitems,rows) vàtotal.
Trả về
tableRequest trả hàm đúng dạng request của ProTable. Mỗi lần bảng tải, hàm gửi:
pagevàcurrent(cùng số trang),pageSize;- giá trị trong form tìm của bảng, dưới đúng tên cột, bỏ ô trống;
- bộ lọc cột: một giá trị thì gửi giá trị đó, nhiều giá trị thì gửi mảng;
- chữ trong ô tìm của thanh công cụ dưới tên
search; - cột đang sắp xếp dưới tên
sort, chiềuorderlàaschoặcdesc.
API trả mảng hay { data, total } đều được. Các khoá khác của kết quả (ví dụ counts theo trạng thái) đi tiếp tới onLoad của ProTable. Khi lỗi, hàm hiện lỗi của server, trả success: false và bảng giữ nguyên, không ném lỗi.
rowsOf trả { data, total }; với mảng thì total là độ dài mảng.
Ví dụ
Tên trong sort và các trường lọc phải được khai báo ở phía server, nếu không chúng bị bỏ khỏi query:
export const schema = {
query: listSchema({ filters: { status: z.enum(OrderStatus.values).optional() }, sort: ["createdAt", "total"] }),
};Đọc một danh sách trong code khác:
const { data } = useRequest(() => api.orders.list({ status: "new", pageSize: 5 }));
const { data: rows, total } = rowsOf(data);Bước tiếp theo
- listSchema, listOf: phía server của cùng bảng.
- submit: form tạo và sửa tải lại bảng này.
- Trang danh sách: khi nào dùng
<ResourceList>thay cho bảng tự viết.