Panduan Desain Qokit
Kontrak desain publik untuk integrasi platform, pengembangan ekstensi, dan penggunaan komponen.
Panduan Desain Qokit
Panduan Desain Qokit ditujukan untuk pihak integrasi platform masa depan, pengembang ekstensi, dan tim frontend, yang menjelaskan secara publik fondasi merek, antarmuka komponen, hierarki visual, persyaratan responsif, dan strategi kompatibilitas yang dapat diandalkan dalam jangka panjang.
Di sini dijelaskan "apa yang dapat diandalkan oleh pengembang", tidak termasuk rute produk internal, prompt AI, proses keputusan repositori, atau skema implementasi yang tidak dipublikasikan.
Akses Cepat
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>
);
}Saat mengakses, pilih kemampuan sesuai urutan berikut:
- Pilih komponen dasar seperti Button, Card, Dialog dari
@qokit/components/ui; - Pilih kombinasi produk yang stabil dari
@qokit/components/patterns; - Gunakan
@qokit/components/skins/platform,site, atauadminuntuk menyesuaikan antarmuka target; - Gunakan Token CSS bersama, jangan menyalin gaya dasar komponen;
- Verifikasi status desktop, seluler, keyboard, dan teks panjang.
Peta Panduan
| Apa yang perlu diketahui | Dokumen |
|---|---|
| Warna merek, font, spasi, dan Token | foundations.md |
| Responsif, keyboard, dan aksesibilitas | accessibility.md |
| Impor komponen, kontrak umum Skeleton/Skin, dan cara upgrade | component-integration.md |
| Button dan IconButton | button-component-rules.md |
| Card, Shell, overlay, dan material | card-surface-materials.md |
| Standar kualitas publik untuk situs yang dihasilkan | generated-site-quality.md |
| Perubahan kontrak dan catatan upgrade | changelog.md |
Kontrak Publik
- Struktur komponen, atribut, dan perilaku aksesibilitas dikelola oleh komponen bersama;
- Skin hanya mengubah slot class dan variabel CSS, tidak mengubah perilaku bisnis;
- Token semantik mempertahankan tanggung jawab yang sama di tema terang, gelap, dan situs yang dihasilkan;
- Perubahan merusak harus dicatat di Changelog, dan menyediakan panduan migrasi;
- Jika terdapat perbedaan antara dokumen dan kode, gunakan API komponen yang telah dirilis sebagai acuan, dan perbaiki dokumen pada versi yang sama.
