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를 기준으로 하며 동일한 버전 내에서 문서를 수정합니다.
