Qokit Design-Leitfaden
Öffentlicher Designvertrag für Plattformintegration, Erweiterungsentwicklung und Komponentennutzung.
Qokit Design-Richtlinien
Die Qokit Design-Richtlinien richten sich an zukünftige Plattformintegratoren, Erweiterungsentwickler und Frontend-Teams. Sie machen die Markenbasis, Komponenten-Schnittstellen, visuelle Hierarchien, responsiven Anforderungen und Kompatibilitätsstrategien öffentlich, auf die langfristig vertraut werden kann.
Hier wird beschrieben, „worauf Entwickler vertrauen können“. Interne Produktroadmaps, KI-Prompts, Entscheidungsprozesse in den Repositories oder nicht veröffentlichte Implementierungen sind nicht enthalten.
Schnelle Integration
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>
);
}Wählen Sie bei der Integration folgende Fähigkeiten in dieser Reihenfolge aus:
- Wählen Sie Basis-Komponenten wie Button, Card und Dialog aus
@qokit/components/ui; - Wählen Sie stabile Produktkombinationen aus
@qokit/components/patterns; - Passen Sie die Zieloberfläche mit
@qokit/components/skins/platform,siteoderadminan; - Verwenden Sie gemeinsame CSS-Token, kopieren Sie jedoch nicht die Basis-Stile der Komponenten;
- Überprüfen Sie Desktop-, Mobile-, Tastatur- und Langtext-Zustände.
Richtlinien-Karte
| Zu wissen ist | Dokumentation |
|---|---|
| Markenfarben, Schriftarten, Abstände und Token | foundations.md |
| Responsivität, Tastatur und Barrierefreiheit | accessibility.md |
| Komponenten-Import, gemeinsamer Vertrag für Skeleton/Skin und Upgrade-Methode | component-integration.md |
| Button und IconButton | button-component-rules.md |
| Card, Shell, Overlays und Materialien | card-surface-materials.md |
| Öffentliche Qualitätsstandards für generierte Sites | generated-site-quality.md |
| Änderungen am Vertrag und Upgrades-Protokoll | changelog.md |
Öffentlicher Vertrag
- Die Struktur, Attribute und das barrierefreie Verhalten von Komponenten werden von gemeinsamen Komponenten verwaltet;
- Skin ändert nur die Class-Slots und CSS-Variablen, nicht das Geschäftsverhalten;
- Semantische Token behalten ihre gleiche Aufgabe in hellen, dunklen und generierten Site-Themen bei;
- Breaking Changes müssen im Changelog dokumentiert und Migrationshinweise bereitgestellt werden;
- Bei Unterschieden zwischen Dokumentation und Code gilt die veröffentlichte Komponenten-API; die Dokumentation wird in derselben Version korrigiert.
