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 को प्राथमिकता दी जाती है, और दस्तावेज़ को उसी संस्करण में ठीक किया जाता है।
