Skip to Content

AppShell

Khung app cho nhân viên từ manh/shell: menu lọc theo vai, nút đăng xuất, tiếng Việt cho mọi component, theme của app và tự hiện lỗi API. app/layout.tsx chỉ khai báo menu.

Cách dùng

app/layout.tsx
import { AppShell } from "manh/shell"; import { ADMIN_ROLE, ROLE_LABELS } from "app/shared/auth-roles"; import { DashboardOutlined, ShoppingCartOutlined, TeamOutlined } from "@ant-design/icons"; import { getUser, signOut } from "app/hooks"; import { APP_THEME } from "app/theme"; const MENU = [ { path: "/", name: "Tổng quan", icon: <DashboardOutlined /> }, { path: "/orders", name: "Đơn hàng", icon: <ShoppingCartOutlined /> }, { path: "/users", name: "Người dùng", icon: <TeamOutlined />, roles: [ADMIN_ROLE] }, ]; export default function Layout() { return <AppShell appName="Cửa hàng Minh Long" menu={MENU} roleLabels={ROLE_LABELS} user={getUser()} onSignOut={signOut} theme={APP_THEME} />; }

Bộ khởi đầu auth đã viết sẵn file này. Thêm màn hình mới thì thêm một dòng vào MENU.

Chữ ký

manh/shell
type MenuItem = { path?: string; name: string; icon?: ReactNode; roles?: string[]; children?: MenuItem[]; count?: () => Promise<number> | number }; function AppShell(props: { appName: string; logo?: ReactNode; menu: MenuItem[]; roleLabels?: Record<string, string>; user: { name: string; role: string; avatarUrl?: string | null } | null; onSignOut: () => void; theme?: { colorPrimary?: string; borderRadius?: number; dark?: boolean; compact?: boolean }; publicPaths?: string[]; isPublic?: (pathname: string) => boolean; extra?: ReactNode; }): JSX.Element;

Tham số

  • appName, logo: tên và logo ở góc trên.
  • menu: các mục menu.
    • roles: chỉ các vai này thấy mục đó.
    • children: gom nhiều màn hình thành một nhóm, ví dụ nhóm “Kho”.
    • count: hàm trả số việc đang chờ, hiện thành số đỏ cạnh mục và tải lại mỗi lần đổi trang.
  • roleLabels: tên vai hiện ở góc trên, ví dụ { technician: "Kỹ thuật viên" }.
  • user: người đang đăng nhập, thường là getUser(). null thì chuyển về /login.
  • onSignOut: chạy khi bấm Đăng xuất, thường là signOut; sau đó về /login.
  • theme: màu chính, bo góc, nền tối, giao diện gọn. Truyền APP_THEME từ app/theme.tsx.
  • publicPaths: các trang hiện không có khung và không cần đăng nhập, mặc định ["/login", "/register"].
  • isPublic: hàm quyết định trang nào là công khai, cho website có nhiều trang.
  • extra: nút thêm ở đầu trang, ví dụ chuông thông báo.

Trả về

Một layout bọc mọi trang con:

  • Tiếng Việt cho antd và pro-components, theme của app.
  • Thêm các kiểu cột vnd, vnDate, vnDateTime, vnDateRange, phone cho ProTable và ProDescriptions.
  • Mục menu đang mở được tô, nhóm chứa nó tự mở.
  • Mỗi lần gọi API hỏng (trừ 401) tự hiện câu báo của server, nên trang không cần try / catch kèm message.error.

Ví dụ

Menu có nhóm và số việc đang chờ:

app/layout.tsx
const MENU = [ { path: "/orders", name: "Chờ duyệt", count: () => api.orders.list({ status: "pending", pageSize: 1 }).then((r) => r.total) }, { name: "Kho", icon: <InboxOutlined />, children: [ { path: "/stock", name: "Tồn kho" }, { path: "/stock/receipts", name: "Phiếu nhập" }, ] }, ];

Muốn hiện lỗi ở chỗ riêng thì dùng errorText(e) cũng có trong manh/shell; hàm làm cùng việc với apiErrorText.

Bước tiếp theo

Cập nhật