คู่มือการออกแบบ 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>
);
}เมื่อผสานรวม ให้เลือกความสามารถตามลำดับต่อไปนี้:
- เลือกคอมโพเนนต์พื้นฐานเช่น Button, Card, Dialog จาก
@qokit/components/ui; - เลือกชุดผลิตภัณฑ์ที่เสถียรจาก
@qokit/components/patterns; - ใช้
@qokit/components/skins/platform,siteหรือadminเพื่อปรับให้เข้ากับอินเทอร์เฟซเป้าหมาย; - ใช้ Shared CSS Token อย่าคัดลอกสไตล์พื้นฐานของคอมโพเนนต์;
- ตรวจสอบสถานะบนเดสก์ท็อป มือถือ คีย์บอร์ด และข้อความยาว
แผนที่คู่มือ
| สิ่งที่จำเป็นต้องรู้ | เอกสาร |
|---|---|
| สีแบรนด์ ฟอนต์ ระยะห่าง และ Token | foundations.md |
| การตอบสนองต่อขนาดหน้าจอ คีย์บอร์ด และการเข้าถึงได้ | accessibility.md |
| การนำเข้าคอมโพเนนต์ สัญญาสาธารณะของ Skeleton/Skin และวิธีการอัปเกรด | component-integration.md |
| Button และ IconButton | button-component-rules.md |
| Card, Shell, Floating Layer และ Material | card-surface-materials.md |
| มาตรฐานคุณภาพสาธารณะสำหรับไซต์ที่สร้างโดย AI | generated-site-quality.md |
| การเปลี่ยนแปลงสัญญาและบันทึกการอัปเกรด | changelog.md |
สัญญาสาธารณะ
- โครงสร้างคอมโพเนนต์ คุณสมบัติ และพฤติกรรมการเข้าถึงได้ถูกดูแลโดยคอมโพเนนต์ร่วม;
- Skin เปลี่ยนเฉพาะ slot ของ class และตัวแปร CSS ไม่เปลี่ยนพฤติกรรมทางธุรกิจ;
- Semantic Token รักษาหน้าที่เดียวกันในธีมแสง ธีมมืด และธีมไซต์ที่สร้างโดย AI;
- การเปลี่ยนแปลงที่ทำลายความเข้ากันได้ต้องบันทึกไว้ใน Changelog และให้คำแนะนำในการย้าย;
- เมื่อเอกสารและโค้ดมีความขัดแย้ง ให้ยึดตาม API ของคอมโพเนนต์ที่เผยแพร่แล้ว และแก้ไขเอกสารในเวอร์ชันเดียวกัน
