ResourceList
Màn hình danh sách của một tài nguyên từ manh/shell, khai báo bằng một bộ cột: tab trạng thái kèm số đếm, tìm và phân trang ở server, form tạo mới và link sang trang chi tiết.
Mỗi thứ doanh nghiệp theo dõi qua các trạng thái (phiếu sửa chữa, đề xuất mua, đơn hàng) là một cặp ResourceList và ResourceDetail. Khối resource (block_add({ id: "resource" })) viết sẵn cả hai, kèm bảng, API và luồng trạng thái.
Cách dùng
import { useApiClient } from "app/api";
import { ResourceList } from "manh/shell";
import { OrderStatus } from "app/shared/order";
import { orderColumns } from "./orders-columns";
export default function OrdersPage() {
const api = useApiClient();
return <ResourceList api={api.orders} title="Đơn hàng" path="/orders" columns={orderColumns} status="status" statusEnum={OrderStatus} />;
}Để tab có số đếm, API danh sách trả listOf(orders, query, { …, counts: "status" }), xem listOf.
Chữ ký
function ResourceList<T = any>(props: {
api: { list: (q?: any) => Promise<any>; create?: (body: any) => Promise<any> };
title: ReactNode;
columns: any[];
path?: string;
status?: string;
statusEnum?: Enum; // từ defineEnum
titleField?: string;
create?: boolean;
createTitle?: string;
createText?: string;
afterCreate?: (row: T, nav: (to: string) => void) => void;
header?: (reload: () => void) => ReactNode;
params?: Record<string, unknown>;
toolBar?: (reload: () => void) => ReactNode[];
rowActions?: (row: T, reload: () => void) => ReactNode[];
search?: any;
extraColumns?: any[];
pageSize?: number;
}): JSX.Element;Tham số
api: nhóm hàm của tài nguyên trong useApiClient, ví dụapi.orders. Cầnlist; cócreatethì có nút tạo.title: tiêu đề trang.columns: bộ cột của tài nguyên (file*-columns.tsx), dùng cho cả bảng và form tạo.path: đường dẫn trang danh sách. Có nó thì cột đầu tiên thành link tớipath/<id>.status,statusEnum: tên cột trạng thái và enum của nó; bật tab theo trạng thái.titleField: cột làm link, thay cho cột đầu tiên.create:falseđể ẩn nút tạo.createTitle,createText: tiêu đề form và chữ trên nút, mặc định “Thêm”.afterCreate(row, nav): chạy sau khi tạo, ví dụ mở luôn bản ghi mới. Mặc định tải lại danh sách.header(reload): nội dung phía trên bảng, như một hàng<StatRow>hay một thông báo.params: query luôn gửi kèm, ví dụ{ mine: 1 }.toolBar(reload),rowActions(row, reload): thêm nút trên thanh công cụ và ở mỗi dòng.search: cấu hình form tìm củaProTable;extraColumns: cột chỉ có trong bảng;pageSize: mặc định 20.
Trả về
Một trang có PageContainer và ProTable. Danh sách tải qua tableRequest, nên trang, tìm, lọc và sắp xếp chạy ở server. Form tạo dựng từ chính columns, bỏ các cột chỉ để hiện. Tạo xong báo “Đã thêm”; lỗi thì hiện câu báo của server và giữ form mở.
Trên điện thoại (màn hình dưới 768 px), bảng chỉ giữ cột tiêu đề, cột trạng thái, cột thao tác và một cột tiền hoặc ngày. Cột nào tự đặt responsive của antd thì theo đúng cột đó: responsive: ["xs", "sm"] để giữ cột cần xem trên điện thoại (như ngày hẹn) mà máy tính vẫn thấy, responsive: ["lg"] để ẩn trên điện thoại và máy tính bảng. Đừng viết responsive: ["xs"] một mình: antd hiểu là cột chỉ hiện khi màn hình hẹp hơn 576 px, trên máy tính cột biến mất. Thanh công cụ (nút của toolBar và nút tạo) tự xuống dòng khi màn hình hẹp, trang không bị kéo ngang.
Ví dụ
Đề xuất mua: nút tạo ghi “Tạo đề xuất”, tạo xong mở luôn đề xuất đó, mỗi dòng có nút sao chép:
<ResourceList api={api.requests} title="Đề xuất mua" path="/requests" columns={requestColumns}
status="status" statusEnum={RequestStatus} createText="Tạo đề xuất"
afterCreate={(row, nav) => nav("/requests/" + row.id)}
rowActions={(r, reload) => [<a key="copy" onClick={() => copy(r.id).then(reload)}>Sao chép</a>]} />Màn hình không phải “danh sách X và một X” (dashboard, quầy bán hàng, lịch) thì tự viết bằng ProTable và tableRequest.
Bước tiếp theo
- ResourceDetail: trang của một bản ghi, có nút chuyển trạng thái.
- defineEnum: nhãn và màu cho tab trạng thái.
- Trang danh sách: khi nào dùng
ResourceList, khi nào tự viết bảng.