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 を優先し、同一バージョン内でドキュメントを修正します。

このページの内容