Qokit デザインガイド
プラットフォーム統合、拡張開発、コンポーネント使用のための公開設計規約。
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>
);
}接続時は以下の順序で機能を選択してください:
@qokit/components/uiから Button、Card、Dialog などの基本コンポーネントを選択します;@qokit/components/patternsから安定した製品組み合わせを選択します;@qokit/components/skins/platform、site、またはadminを使用して対象インターフェースに適応します;- 共有 CSS Token を使用し、コンポーネントの基本スタイルをコピーしないようにします;
- デスクトップ、モバイル、キーボード、長文の各状態を検証します。
ガイドラインマップ
| 必要な知識 | ドキュメント |
|---|---|
| ブランドカラー、フォント、間隔、Token | foundations.md |
| レスポンシブ、キーボード、アクセシビリティ | accessibility.md |
| コンポーネントのインポート、Skeleton/Skin の共通契約とアップグレード方法 | component-integration.md |
| Button と IconButton | button-component-rules.md |
| Card、Shell、フローティングレイヤー、マテリアル | card-surface-materials.md |
| 生成サイトの公開品質基準 | generated-site-quality.md |
| 契約の変更とアップグレード記録 | changelog.md |
公開契約
- コンポーネント構造、属性、アクセシビリティ動作は共有コンポーネントによって維持されます;
- Skin は class スロットと CSS 変数のみを変更し、ビジネスロジックは変更しません;
- セマンティック Token はライトテーマ、ダークテーマ、生成サイトテーマにおいて同じ役割を維持します;
- 破壊的変更は Changelog に記録され、移行手順が提供されます;
- ドキュメントとコードに差異がある場合は、公開済みコンポーネントの API を優先し、同一バージョン内でドキュメントを修正します。
