Guía de diseño de Qokit
Contrato de diseño público dirigido a la integración de la plataforma, desarrollo de extensiones y uso de componentes.
Guía de diseño de Qokit
La guía de diseño de Qokit está dirigida a futuros integradores de la plataforma, desarrolladores de extensiones y equipos frontend, explicando públicamente las bases de marca, interfaces de componentes, jerarquía visual, requisitos de diseño responsivo y estrategias de compatibilidad en las que se puede confiar a largo plazo.
Aquí se describe "qué pueden depender los desarrolladores", sin incluir la hoja de ruta interna del producto, los prompts de IA, el proceso de decisión del repositorio ni soluciones de implementación no publicadas.
Integración rápida
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>
);
}Al integrar, seleccione las capacidades en el siguiente orden:
- Seleccione componentes básicos como Button, Card y Dialog desde
@qokit/components/ui; - Seleccione combinaciones de productos estables desde
@qokit/components/patterns; - Utilice
@qokit/components/skins/platform,siteoadminpara adaptarse a la interfaz objetivo; - Utilice los Tokens CSS compartidos, no copie los estilos base de los componentes;
- Verifique los estados de escritorio, móvil, teclado y texto largo.
Mapa de la guía
| Contenido necesario | Documento |
|---|---|
| Colores de marca, fuentes, espaciado y Tokens | foundations.md |
| Diseño responsivo, teclado y accesibilidad | accessibility.md |
| Importación de componentes, contrato público Skeleton/Skin y formas de actualización | component-integration.md |
| Button e IconButton | button-component-rules.md |
| Card, Shell, superposiciones y materiales | card-surface-materials.md |
| Estándares de calidad públicos para sitios generados | generated-site-quality.md |
| Cambios en el contrato y registro de actualizaciones | changelog.md |
Contrato público
- La estructura de los componentes, sus atributos y el comportamiento de accesibilidad son mantenidos por componentes compartidos;
- Skin solo cambia los slots de clase y las variables CSS, no altera el comportamiento empresarial;
- Los Tokens semánticos mantienen la misma responsabilidad en temas de tema claro, oscuro y sitios generados;
- Los cambios disruptivos deben registrarse en Changelog y proporcionar instrucciones de migración;
- Cuando exista una discrepancia entre la documentación y el código, prevalece la API del componente publicado, y la documentación se corrige en la misma versión.
