Skip to Content
Design

Qokit Design Guide

Public design contracts for platform integration, extension development, and component usage.

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 Design Guidelines

The Qokit Design Guidelines are intended for future platform integrators, extension developers, and frontend teams, publicly specifying the brand foundations, component interfaces, visual hierarchy, responsive requirements, and compatibility strategies that can be relied upon long-term.

This describes "what developers can rely on" and does not include internal product roadmaps, AI prompts, repository decision processes, or unreleased implementation details.

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

When integrating, select capabilities in the following order:

  1. Select basic components like Button, Card, and Dialog from @qokit/components/ui;
  2. Select stable product combinations from @qokit/components/patterns;
  3. Use @qokit/components/skins/platform, site, or admin to adapt to the target interface;
  4. Use shared CSS Tokens; do not copy component base styles;
  5. Verify desktop, mobile, keyboard, and long-text states.

Guide Map

What you need to knowDocumentation
Brand colors, fonts, spacing, and Tokensfoundations.md
Responsive, keyboard, and accessibilityaccessibility.md
Component import, Skeleton/Skin public contracts, and upgrade methodscomponent-integration.md
Button and IconButtonbutton-component-rules.md
Card, Shell, overlays, and materialscard-surface-materials.md
Public quality standards for generated sitesgenerated-site-quality.md
Contract changes and upgrade recordschangelog.md

Public Contracts

  • Component structure, attributes, and accessible behaviors are maintained by shared components;
  • Skin only changes class slots and CSS variables, not business behavior;
  • Semantic Tokens maintain the same responsibility across light, dark, and generated site themes;
  • Breaking changes must be recorded in the Changelog with migration instructions;
  • In case of discrepancies between documentation and code, the published component API prevails, and the documentation is corrected in the same version.

On this page