Guida al design di Qokit
Contratto di design pubblico per integrazioni di piattaforma, sviluppo di estensioni e utilizzo dei componenti.
Linee guida di design di Qokit
Le linee guida di design di Qokit sono rivolte ai futuri partner di integrazione della piattaforma, agli sviluppatori di estensioni e ai team frontend, spiegando pubblicamente le basi del brand, gli interfacce dei componenti, la gerarchia visiva, i requisiti di responsive design e le strategie di compatibilità su cui si può fare affidamento a lungo termine.
Qui viene descritto "su cosa può fare affidamento uno sviluppatore"; non includono la roadmap interna del prodotto, i prompt dell'IA, il processo decisionale del repository o soluzioni implementative non pubbliche.
Integrazione rapida
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>
);
}Durante l'integrazione, selezionare le funzionalità nell'ordine seguente:
- Selezionare componenti di base come Button, Card, Dialog da
@qokit/components/ui; - Selezionare combinazioni di prodotti stabili da
@qokit/components/patterns; - Utilizzare
@qokit/components/skins/platform,siteoadminper adattare l'interfaccia target; - Utilizzare i CSS Token condivisi, senza copiare gli stili di base dei componenti;
- Verificare gli stati desktop, mobile, tastiera e testi lunghi.
Mappa delle guide
| Cosa è necessario sapere | Documento |
|---|---|
| Colori del brand, font, spaziatura e Token | foundations.md |
| Responsive, tastiera e accessibilità | accessibility.md |
| Importazione dei componenti, contratto pubblico Skeleton/Skin e modalità di aggiornamento | component-integration.md |
| Button e IconButton | button-component-rules.md |
| Card, Shell, overlay e materiali | card-surface-materials.md |
| Standard di qualità pubblici per i siti generati | generated-site-quality.md |
| Modifiche al contratto e registro degli aggiornamenti | changelog.md |
Contratto pubblico
- La struttura dei componenti, le proprietà e il comportamento di accessibilità sono gestiti dai componenti condivisi;
- Skin modifica solo gli slot delle class e le variabili CSS, senza alterare il comportamento aziendale;
- I Token semantici mantengono lo stesso ruolo nei temi light, dark e nei siti generati;
- Le modifiche breaking devono essere registrate nel Changelog e accompagnate da istruzioni di migrazione;
- In caso di discrepanza tra documentazione e codice, prevale l'API del componente pubblicato, e la documentazione viene corretta nella stessa versione.
