Skip to Content
设计

Qokit 设计指南

面向平台集成、扩展开发与组件使用的公开设计契约。

Qokit Design GuidePublic components, tokens & integrationQokit 设计指南公共组件、设计令牌与平台集成Qokit 設計指南公開元件、設計權杖與平台整合Guía de diseño de QokitComponentes públicos, tokens e integraciónQokit DesignleitfadenÖffentliche Komponenten, Tokens und IntegrationGuide de conception QokitComposants publics, jetons et intégrationGuia de design QokitComponentes públicos, tokens e integraçãoQokit デザインガイド公開コンポーネント、トークン、統合Qokit 디자인 가이드공개 컴포넌트, 토큰 및 통합Guida al design QokitComponenti pubblici, token e integrazioneQokit-ontwerpgidsPublieke componenten, tokens en integratiePanduan Desain QokitKomponen publik, token, dan integrasiHướng dẫn thiết kế QokitThành phần công khai, token và tích hợpQokit Tasarım RehberiHerkese açık bileşenler, tokenlar ve entegrasyonGuia de design QokitComponentes públicos, tokens e integraçãoГайд по дизайну QokitПубличные компоненты, токены и интеграцияدليل تصميم Qokitمكوّنات عامة ورموز تصميم وتكاملQokit डिज़ाइन गाइडसार्वजनिक कॉम्पोनेंट, टोकन और इंटीग्रेशनคู่มือการออกแบบ Qokitคอมโพเนนต์สาธารณะ โทเค็น และการผสานรวมPrzewodnik projektowy QokitPubliczne komponenty, tokeny i integracja

Qokit 设计指南

Qokit 设计指南面向未来的平台集成方、扩展开发者和前端团队,公开说明可以长期依赖的品牌基础、组件接口、视觉层级、响应式要求与兼容策略。

这里描述的是“开发者可以依赖什么”,不包含内部产品路线、AI 提示、仓库决策过程或未公开实现方案。

快速接入

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>
  );
}

接入时按以下顺序选择能力:

  1. 从 @qokit/components/ui 选择 Button、Card、Dialog 等基础组件;
  2. 从 @qokit/components/patterns 选择稳定的产品组合;
  3. 使用 @qokit/components/skins/platform、site 或 admin 适配目标界面;
  4. 使用共享 CSS Token,不复制组件基础样式;
  5. 验证桌面、移动端、键盘和长文案状态。

指南地图

需要了解的内容文档
品牌颜色、字体、间距和 Tokenfoundations.md
响应式、键盘与无障碍accessibility.md
组件导入、Skeleton/Skin 公共契约与升级方式component-integration.md
Button 与 IconButtonbutton-component-rules.md
Card、Shell、浮层与材质card-surface-materials.md
生成站点的公开质量标准generated-site-quality.md
契约变化与升级记录changelog.md

公开契约

  • 组件结构、属性和可访问性行为由共享组件维护;
  • Skin 只改变 class 槽和 CSS 变量,不改变业务行为;
  • 语义 Token 在浅色、深色和生成站点主题中保持同一职责;
  • 破坏性变更必须记录在 Changelog,并提供迁移说明;
  • 文档与代码存在差异时,以已发布组件 API 为准,并在同一版本修正文档。

本页目录