Qokit Tasarım Rehberi
Platform entegrasyonu, genişletme geliştirme ve bileşen kullanımı için açık tasarım sözleşmesi.
Qokit Tasarım Rehberi
Qokit Tasarım Rehberi, gelecekteki platform entegratörleri, genişletme geliştiricileri ve ön uç ekipleri için uzun vadeli güvenilir marka temelleri, bileşen arayüzleri, görsel hiyerarşi, duyarlılık gereksinimleri ve uyumluluk stratejilerini açıkça belirtir.
Burada "geliştiricilerin neye güvenebileceği" açıklanmaktadır; iç ürün rotaları, AI ipuçları, depo karar süreçleri veya gizli uygulama yöntemleri dahil değildir.
Hızlı Başlangıç
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>
);
}Entegrasyon sırasında yetenekleri aşağıdaki sırayla seçin:
- Temel bileşenler olan Button, Card, Dialog vb. için
@qokit/components/ui'den seçim yapın; - Kararlı ürün kombinasyonları için
@qokit/components/patterns'den seçim yapın; - Hedef arayüzü uyarlamak için
@qokit/components/skins/platform,siteveyaadmin'i kullanın; - Bileşen temel stillerini kopyalamadan paylaşılan CSS Token'larını kullanın;
- Masaüstü, mobil, klavye ve uzun metin durumlarını doğrulayın.
Rehber Haritası
| Bilinmesi Gerekenler | Doküman |
|---|---|
| Marka renkleri, yazı tipleri, boşluklar ve Token'lar | foundations.md |
| Duyarlılık, klavye ve erişilebilirlik | accessibility.md |
| Bileşen içe aktarma, Skeleton/Skin ortak sözleşmesi ve yükseltme yolları | component-integration.md |
| Button ve IconButton | button-component-rules.md |
| Card, Shell, katmanlar ve malzemeler | card-surface-materials.md |
| Oluşturulan sitelerin herkese açık kalite standartları | generated-site-quality.md |
| Sözleşme değişiklikleri ve yükseltme kayıtları | changelog.md |
Herkese Açık Sözleşme
- Bileşen yapısı, özellikleri ve erişilebilirlik davranışları paylaşılan bileşenler tarafından korunur;
- Skin yalnızca class yuvalarını ve CSS değişkenlerini değiştirir, işlevsel davranışı değiştirmez;
- Anlamsal Token'lar açık, koyu ve oluşturulan site temalarında aynı sorumluluğu taşır;
- Kırıcı değişiklikler Changelog'da kaydedilmeli ve geçiş talimatları sağlanmalıdır;
- Doküman ile kod arasında fark olduğunda, yayınlanmış bileşen API'si esas alınmalı ve doküman aynı sürümde düzeltilmelidir.
