Przewodnik po designie Qokit
Publiczny kontrakt projektowy dla integracji platformy, rozszerzeń deweloperskich i używania komponentów.
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:
- Wybierz podstawowe komponenty, takie jak Button, Card, Dialog z
@qokit/components/ui; - Wybierz stabilne zestawy produktów z
@qokit/components/patterns; - Dostosuj docelowy interfejs za pomocą
@qokit/components/skins/platform,sitelubadmin; - Używaj udostępnionych tokenów CSS, nie kopiuj podstawowych stylów komponentów;
- 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 Tokeny | foundations.md |
| Responsywność, klawiatura i dostępność | accessibility.md |
| Import komponentów, publiczne kontrakty Skeleton/Skin oraz sposoby aktualizacji | component-integration.md |
| Button i IconButton | button-component-rules.md |
| Card, Shell, nakładki i materiały | card-surface-materials.md |
| Publiczne standardy jakości generowanych witryn | generated-site-quality.md |
| Zmiany kontraktu i historia aktualizacji | changelog.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.
