Guide de conception Qokit
Contrat de conception public destiné à l'intégration de la plateforme, au développement d'extensions et à l'utilisation des composants.
Guide de conception Qokit
Le guide de conception Qokit s'adresse aux futurs intégrateurs de plateforme, aux développeurs d'extensions et aux équipes front-end. Il expose publiquement les fondamentaux de la marque, les interfaces des composants, la hiérarchie visuelle, les exigences de réactivité et les stratégies de compatibilité sur lesquels on peut compter à long terme.
Ce document décrit « ce sur quoi les développeurs peuvent compter » ; il n'inclut pas la roadmap produit interne, les invites IA, les processus décisionnels du dépôt ou les solutions d'implémentation non publiques.
Prise en main rapide
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>
);
}Lors de l'intégration, sélectionnez les capacités dans l'ordre suivant :
- Sélectionnez les composants de base tels que Button, Card et Dialog depuis
@qokit/components/ui; - Choisissez des combinaisons produits stables depuis
@qokit/components/patterns; - Adaptez l'interface cible en utilisant
@qokit/components/skins/platform,siteouadmin; - Utilisez les jetons CSS partagés et ne copiez pas les styles de base des composants ;
- Vérifiez les états bureau, mobile, clavier et textes longs.
Carte du guide
| Ce qu'il faut savoir | Documentation |
|---|---|
| Couleurs de marque, polices, espacements et Jetons | foundations.md |
| Réactivité, clavier et accessibilité | accessibility.md |
| Importation des composants, contrat public Skeleton/Skin et méthodes de mise à niveau | component-integration.md |
| Button et IconButton | button-component-rules.md |
| Card, Shell, superpositions et matériaux | card-surface-materials.md |
| Normes de qualité publiques pour les sites générés | generated-site-quality.md |
| Évolutions du contrat et historique des mises à niveau | changelog.md |
Contrat public
- La structure des composants, leurs attributs et leur comportement d'accessibilité sont gérés par les composants partagés ;
- Skin modifie uniquement les emplacements de classe et les variables CSS, sans changer le comportement métier ;
- Les Jetons sémantiques conservent la même responsabilité dans les thèmes clair, sombre et générés ;
- Les modifications incompatibles doivent être consignées dans le Changelog et inclure des instructions de migration ;
- En cas d'écart entre la documentation et le code, l'API des composants publiés fait foi, et la documentation est corrigée dans la même version.
