Skip to Content
Projektowanie

Przewodnik po designie Qokit

Publiczny kontrakt projektowy dla integracji platformy, rozszerzeń deweloperskich i używania komponentów.

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

Wytyczne projektowe Qokit

Wytyczne projektowe Qokit są przeznaczone dla przyszłych integratorów platformy, deweloperów rozszerzeń oraz zespołów frontendowych. Publikują one podstawy marki, interfejsy komponentów, hierarchię wizualną, wymagania responsywne i strategie kompatybilności, na których można polegać w długim terminie.

Opisuje tu "co mogą obsługiwać deweloperzy", nie zawierając wewnętrznych kierunków produktu, podpowiedzi AI, procesów decyzyjnych repozytorium ani nieujawnionych rozwiązań implementacyjnych.

Szybkie rozpoczęcie

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

Podczas integracji wybieraj możliwości w następującej kolejności:

  1. Wybierz podstawowe komponenty, takie jak Button, Card, Dialog z @qokit/components/ui;
  2. Wybierz stabilne zestawy produktów z @qokit/components/patterns;
  3. Dostosuj docelowy interfejs za pomocą @qokit/components/skins/platform, site lub admin;
  4. Używaj udostępnionych tokenów CSS, nie kopiuj podstawowych stylów komponentów;
  5. Zweryfikuj stany na pulpicie, urządzeniach mobilnych, klawiaturze i przy długich tekstach.

Mapa przewodnia

Co musisz wiedziećDokumentacja
Kolory marki, czcionki, odstępy i Tokenyfoundations.md
Responsywność, klawiatura i dostępnośćaccessibility.md
Import komponentów, publiczne kontrakty Skeleton/Skin oraz sposoby aktualizacjicomponent-integration.md
Button i IconButtonbutton-component-rules.md
Card, Shell, nakładki i materiałycard-surface-materials.md
Publiczne standardy jakości generowanych witryngenerated-site-quality.md
Zmiany kontraktu i historia aktualizacjichangelog.md

Kontrakt publiczny

  • Struktura komponentu, właściwości i zachowanie dotyczące dostępności są utrzymywane przez udostępnione komponenty;
  • Skin zmienia tylko sloty klas i zmienne CSS, nie zmieniając zachowania biznesowego;
  • Semantyczne Tokeny zachowują ten sam zakres obowiązków w jasnym, ciemnym i wygenerowanym motywie witryny;
  • Zmiany łamiące zgodność muszą być odnotowane w Changelogu i zawierać instrukcje migracji;
  • W przypadku różnic między dokumentacją a kodem, decydujący jest opublikowany interfejs API komponentu, a dokumentacja musi zostać poprawiona w tej samej wersji.

Na tej stronie