Skip to Content

defineEnum

Khai báo một danh sách trạng thái hay loại một lần, kèm nhãn và màu, rồi dùng chung ở server và giao diện.

Cách dùng

app/shared/order.ts
import { defineEnum } from "manh/enum"; export const OrderStatus = defineEnum({ pending: ["Chờ xử lý", "processing"], done: ["Hoàn thành", "success"], cancelled: ["Đã huỷ", "default"], }); export type OrderStatus = (typeof OrderStatus.values)[number];

Đặt trong app/shared/ để cả trang .tsx và handler .ts cùng import.

Chữ ký

manh/enum
type EnumColor = "success" | "error" | "processing" | "warning" | "default" | (string & {}); function defineEnum<const T extends Record<string, readonly [label: string, color?: EnumColor]>>(def: T): { readonly values: [K, ...K[]]; label(v: K | string | null | undefined): string; color(v: K | string | null | undefined): EnumColor | undefined; readonly valueEnum: Record<K, { text: string; status?: string; color?: string }>; readonly options: Array<{ value: K; label: string }>; is(v: unknown): v is K; }; // K = các khoá của def

Tham số

  • def: object, khoá là giá trị lưu trong database, giá trị là [nhãn, màu]. Màu là một trong success, error, processing, warning, default (hiện thành Badge) hoặc bất kỳ màu Tag nào của antd ("blue", "#1677ff"). Màu không bắt buộc.

Trả về

Một object chỉ đọc:

  • values: mảng các khoá, dùng cho z.enum(X.values) và vòng lặp.
  • label(v): nhãn của giá trị. Giá trị lạ thì trả chính nó dạng chuỗi.
  • color(v): màu của giá trị, hoặc undefined.
  • valueEnum: đưa vào valueEnum của cột ProTable hoặc ProDescriptions.
  • options: [{ value, label }] cho Select, Segmented, Radio.
  • is(v): true khi v là một khoá đã khai báo.

Ví dụ

Server:

app/orders/[id:int]/status/post.ts
import { z } from "@hono/zod-openapi"; import { OrderStatus } from "app/shared/order"; export const schema = { body: z.object({ to: z.enum(OrderStatus.values) }) };

Giao diện:

app/orders/order-columns.tsx
import { Tag } from "antd"; import { OrderStatus } from "app/shared/order"; export const statusColumn = { title: "Trạng thái", dataIndex: "status", valueEnum: OrderStatus.valueEnum }; export const StatusTag = ({ v }: { v: string }) => <Tag color={OrderStatus.color(v)}>{OrderStatus.label(v)}</Tag>;

Đổi một nhãn ở đây thì mọi màn hình, bộ lọc, schema và email đổi theo. Không khai báo lại cùng danh sách trong trang hay handler.

Bước tiếp theo

  • defineFlow: trạng thái nào được chuyển sang trạng thái nào.
  • Cấu trúc app/: app/shared, nơi đặt enum dùng chung cho giao diện và server.
Cập nhật