Skip to Content

API cần biết

Những prop của pro-components 2.8.10 hay bị dùng sai nhất, gồm ProTable, form trong Modal / Drawer, valueType và valueEnum.

App trên manh.run chạy đúng bản @ant-design/pro-components@2.8.10. Trang này chỉ ghi những chỗ dễ sai. Tài liệu đầy đủ có ở procomponents.ant.design .

ProTable

  • request(params, sort, filter) phải trả { data, total, success: true }. params gồm current, pageSize và giá trị của mọi ô tìm kiếm, mang tên theo dataIndex.
  • params={{ … }} truyền thêm dữ liệu cho request. Giá trị đổi thì bảng tự tải lại. manualRequest khiến bảng không tự tải lần đầu mà chờ người dùng bấm tìm.
  • Sau khi tạo, sửa, xoá, gọi actionRef.current?.reload(). reloadAndRest() tải lại và về trang 1; clearSelected() bỏ chọn các dòng.
  • columnsState={{ persistenceKey: "requests", persistenceType: "localStorage" }} nhớ cột nào đang ẩn hay ghim cho từng người dùng.
  • search={false} ẩn form tìm kiếm; options={false} ẩn các nút mật độ, tải lại, cài đặt cột.
  • dateFormatter="string" gửi ngày trong ô tìm kiếm dưới dạng chuỗi, không phải đối tượng dayjs.
  • polling (ms, tối thiểu 2000) để danh sách tự cập nhật.
  • Cờ trên cột: search: false, hideInTable, hideInSearch, hideInForm, hideInDescriptions, copyable, ellipsis, sorter, fixed, search.transform.

Form

  • width của field: xs 104 · sm 216 · md 328 · lg 440 · xl 552 (px).
  • onFinish trả true thì ModalForm / DrawerForm đóng; trả false hoặc ném lỗi thì form giữ nguyên.
  • Muốn mở lại form với các field trống thì đặt modalProps.destroyOnClose / drawerProps.destroyOnClose. Chỉ đặt destroyOnHidden của antd v6 thì không đủ, xem Form.
  • submitter={{ searchConfig: { submitText, resetText } }} đổi chữ trên nút; submitter={false} ẩn nút; render để đặt nút ở chỗ khác, ví dụ trong FooterToolbar.
  • ProFormDependency name={[…]} để hiện field theo điều kiện. transform trên field đổi dạng giá trị khi gửi, convertValue đổi ngược lại khi hiện.
  • Dùng renderFormItem (bản 2.x). formItemRender là tên ở v3 nên dùng ở đây sẽ không có tác dụng.

valueType

Một valueType quyết định cùng lúc cách hiện ô trong bảng, ô tìm kiếm, field trong form và dòng trong trang chi tiết. Các giá trị có trong 2.8.10:

  • Chữ: text, textarea, password, code, jsonCode
  • Số: digit, money, percent, progress, second, rate
  • Ngày giờ: date, dateTime, dateWeek, dateMonth, dateQuarter, dateYear, dateRange, dateTimeRange, time, timeRange, fromNow
  • Lựa chọn: select, treeSelect, checkbox, radio, radioButton, switch, segmented, cascader, color
  • Hình: avatar, image
  • Bố cục (form dựng từ schema): group, formList, formSet, divider, dependency
  • Chỉ trong bảng: option (cột thao tác), index, indexBorder

valueType có thể là một hàm theo từng dòng, hoặc một đối tượng kèm tuỳ chọn:

app/projects/page.tsx
const columns: ProColumns<Project>[] = [ { title: "Tiến độ", dataIndex: "pct", valueType: (r) => ({ type: "progress", status: r.late ? "exception" : "active" }) }, { title: "Giá", dataIndex: "price", valueType: { type: "money", locale: "vi-VN" } }, // … ];

valueEnum

valueEnum biến cột select hoặc cột trạng thái thành Badge có màu. Giá trị status: Success, Error, Processing, Warning, Default.

app/requests/page.tsx
const STATUS = { pending: { text: "Chờ duyệt", status: "Processing" }, approved: { text: "Đã duyệt", status: "Success" }, rejected: { text: "Từ chối", status: "Error" }, };

Cần biết

  • status trong valueEnum viết hoa chữ đầu ("Success"), còn Badge status của antd viết thường ("success"). Nếu dùng chung một bảng trạng thái cho cả hai, phải chuyển đổi giữa hai kiểu viết. Quên bước này thì chấm màu biến mất mà không báo lỗi gì.
  • Ví dụ trên internet có thể dùng tên prop của pro-components v3. Prop nào không có trong bản 2.8.10 sẽ không có tác dụng, nên kiểm lại trước khi dùng.

manh/ui

manh/ui gom định dạng tiền, số, ngày, số điện thoại, màu trạng thái và theme antd vào một chỗ. Module này dành cho giao diện (.tsx), có sẵn trong mọi app, không cần cài. App không import thì không bị ảnh hưởng.

app/orders/page.tsx
import { formatMoney, formatDate, formatPhone, statusColor } from "manh/ui"; formatMoney(1234567); // "1.234.567 ₫" (mặc định vi-VN, VND) formatMoney(1234.5, { currency: "USD", locale: "en-US" }); // "$1,234.50" formatDate(order.createdAt); // "05/03/2024" (en-US: "Mar 5, 2024") formatPhone("+84912345678"); // "0912 345 678" <Tag color={statusColor(order.status)}>{order.status}</Tag>
  • Ngôn ngữ, tiền tệ và nước của số điện thoại là tham số. setDefaults({ locale: "en-US", currency: "USD", country: "US" }) đổi mặc định cho cả app. Hiện có tiếng Việt và tiếng Anh. Ngôn ngữ khác vẫn có số tiền đúng nhờ Intl.
  • Dữ liệu sai (rỗng, không phải số, ngày hỏng) trả về chuỗi rỗng, không báo lỗi.
  • statusColor đọc paid, pending, overdue, cancelled… và một số nhãn tiếng Việt; trạng thái lạ nhận màu xám.
  • makeConfig({ locale, brand, dark }) trả locale và theme để trải vào ConfigProvider. tokens là bảng token thiết kế (màu trạng thái, chữ, nền, khoảng cách, bo góc).
  • Không dùng được trong app/shared (file đó không import antd). Ở phía server vẫn dùng manh/vn.

Bước tiếp theo

  • Trang danh sách — các prop của ProTable trong một trang đầy đủ.
  • Form — DrawerForm, StepsForm và lưu ý về xoá dữ liệu cũ của form.
  • Công thức trang — các tên prop cũ cần thay.
Cập nhật