Hướng dẫn Thiết kế Qokit
Hợp đồng thiết kế công khai dành cho tích hợp nền tảng, phát triển mở rộng và sử dụng thành phần.
Hướng dẫn thiết kế Qokit
Hướng dẫn thiết kế Qokit hướng tới các bên tích hợp nền tảng trong tương lai, nhà phát triển mở rộng và đội ngũ frontend, công khai các nền tảng thương hiệu, giao diện thành phần, cấp độ trực quan, yêu cầu đáp ứng và chiến lược tương thích mà có thể dựa vào lâu dài.
Ở đây mô tả "nhà phát triển có thể dựa vào gì", không bao gồm lộ trình sản phẩm nội bộ, gợi ý AI, quá trình ra quyết định kho lưu trữ hoặc các giải pháp triển khai chưa được công khai.
Tiếp cận nhanh
import { Button, Card } from '@qokit/components/ui';
import { platformButtonSkin, platformCardSkin } from '@qokit/components/skins/platform';
export function IntegrationAction() {
return (
<Card layer="shell" skin={platformCardSkin}>
<Button skin={platformButtonSkin} type="button" variant="primary">
连接 Qokit
</Button>
</Card>
);
}Khi tiếp cận, hãy chọn khả năng theo thứ tự sau:
- Chọn Button, Card, Dialog và các thành phần cơ bản từ
@qokit/components/ui; - Chọn tổ hợp sản phẩm ổn định từ
@qokit/components/patterns; - Sử dụng
@qokit/components/skins/platform,sitehoặcadminđể thích nghi với giao diện mục tiêu; - Sử dụng Token CSS chia sẻ, không sao chép kiểu cơ bản của thành phần;
- Xác minh trạng thái trên máy tính để bàn, di động, bàn phím và văn bản dài.
Bản đồ hướng dẫn
| Nội dung cần biết | Tài liệu |
|---|---|
| Màu thương hiệu, phông chữ, khoảng cách và Token | foundations.md |
| Đáp ứng, bàn phím và khả năng tiếp cận | accessibility.md |
| Nhập thành phần, Hợp đồng chung Skeleton/Skin và cách nâng cấp | component-integration.md |
| Button và IconButton | button-component-rules.md |
| Card, Shell, lớp nổi và vật liệu | card-surface-materials.md |
| Tiêu chuẩn chất lượng công khai cho trang được tạo | generated-site-quality.md |
| Thay đổi hợp đồng và nhật ký nâng cấp | changelog.md |
Hợp đồng công khai
- Cấu trúc thành phần, thuộc tính và hành vi khả năng tiếp cận được duy trì bởi thành phần chia sẻ;
- Skin chỉ thay đổi slot class và biến CSS, không thay đổi hành vi nghiệp vụ;
- Token ngữ nghĩa giữ cùng trách nhiệm trong chủ đề sáng, tối và trang được tạo;
- Các thay đổi phá vỡ phải được ghi lại trong Changelog và cung cấp hướng dẫn di chuyển;
- Khi tài liệu và mã nguồn có sự khác biệt, hãy dựa vào API thành phần đã phát hành và sửa tài liệu trong cùng phiên bản đó.
