التوثيق
ضع الأيقونات في تطبيقك باسم واحد، أو اقرأها مباشرة من API.
في تطبيقات DiceX
تسجّل مكتبة @dicex/design العنوان icons.dicex.me مزوّدًا لـ Iconify لحظة استيرادها. فتُرسم أي أيقونة من أي مجموعة باسمها: البادئة ثم نقطتان ثم الاسم.
import { Icon } from "@dicex/design";
<Icon icon="solar:home-2-linear" />الأيقونة نفسها، من هذا الخادم نفسه.
أيقونات المكتبة نفسها (DESIGN_ICONS) داخل حزمتها وتظهر في أول رسم؛ وكل الأيقونات الأخرى تأتي من هذه الخدمة. الأيقونة ذات المعنى تحتاج label، وإلا فهي زخرفية ومخفية عن قارئات الشاشة.
في أي مشروع آخر
مع عميل Iconify الرسمي أعطِه عنوان الخادم فقط ولا يتغير شيء آخر. وعملاء Iconify للأطر الأخرى يقبلون العنوان نفسه.
npm install @iconify/reactimport { addAPIProvider, Icon } from "@iconify/react";
addAPIProvider("", { resources: ["https://icons.dicex.me"] });
export const Home = () => <Icon icon="solar:home-2-linear" />;السلسلة الفارغة هي المزوّد الافتراضي. يطلب العميل فقط الأيقونات الظاهرة في الصفحة، بطلب واحد لكل مجموعة، ويحتفظ المتصفح بكل رد أسبوعًا.
عناوين SVG
كل أيقونة هي أيضًا ملف SVG، لوسم img أو CSS أو البريد أو أدوات التصميم. في img يكون currentColor أسود؛ حدّد اللون المطلوب بـ color.
بدون معاملات: ارتفاع em واحد
https://icons.dicex.me/solar/home-2-linear.svgمع حجم
https://icons.dicex.me/solar/home-2-linear.svg?height=48مع لون
https://icons.dicex.me/solar/home-2-linear.svg?height=48&color=%23e11d48مُدارة ومقلوبة
https://icons.dicex.me/solar/home-2-linear.svg?height=48&rotate=90deg&flip=horizontal
- color
- اللون؛ يحلّ محل currentColor. أي لون CSS، واكتب # في العنوان هكذا %23.
- width, height
- الحجم: رقم بأي وحدة (48، 3rem) أو auto أو unset أو none. حدّد واحدًا ويتبعه الآخر حسب نسبة الأيقونة.
- rotate
- التدوير: من 1 إلى 3 أرباع دورة، أو 90deg أو 180deg أو 270deg، أو 25% أو 50% أو 75%.
- flip
- القلب: horizontal أو vertical، أو الاثنان مفصولين بفاصلة.
- box
- مع 1 يُضاف مستطيل شفاف بحجم viewBox، للأدوات التي لا تقرأ viewBox.
- download
- مع 1 يكون الرد مرفقًا ويحفظ المتصفح الملف.
مرجع API
واجهة هذه الخدمة هي واجهة Iconify الرسمية نفسها: أي عميل يعمل معها يعمل مع هذا الخادم. الردود بصيغة JSON ما عدا SVG. تحت كل مسار طلب جاهز يُرسل من هذه الصفحة إلى هذا الخادم.
- CORS
- الردود مفتوحة لأي صفحة (Access-Control-Allow-Origin: *) ويكفي طلب GET بسيط.
- pretty
- مع pretty=1 يُكتب رد JSON بمسافات بادئة.
- التخزين المؤقت
- بيانات الأيقونات وملفات SVG تُخزَّن أسبوعًا (max-age=604800)، والقوائم والبحث ساعة واحدة (max-age=3600).
- الأخطاء
- مجموعة أو أيقونة غير معروفة تعطي 404 بالنص Not found، وطلب ناقص يعطي 400 بالنص Bad request.
GET /{prefix}.json
بيانات الأيقونات المطلوبة بصيغة JSON الخاصة بـ Iconify، وهي ما ترسم منه العملاء. الاسم الذي لا تملكه المجموعة يأتي في not_found.
- icons
- أسماء الأيقونات بدون البادئة، مفصولة بفواصل. مطلوب.
GET /collections
كل المجموعات التي يمكن تصفحها، مفهرسة بالبادئة: الاسم والمؤلف والترخيص وعدد الأيقونات والعيّنات وارتفاع الشبكة والفئة ونظام الألوان.
- prefix
- هذه المجموعة فقط، حتى لو كانت مخفية.
- prefixes
- قائمة مفصولة بفواصل. اسم ينتهي بشرطة يعني كل بادئة تبدأ به (mdi- تعني mdi-light وغيرها).
- hidden
- مع 1 تأتي المجموعات المخفية أيضًا.
GET /collection
أسماء أيقونات مجموعة واحدة حسب الفئة: uncategorized وcategories وtotal. أما aliases وhidden فتأتي فقط إن كانت للمجموعة.
- prefix
- بادئة المجموعة. مطلوبة.
- info
- مع 1 تأتي معلومات المجموعة أيضًا.
- chars
- مع 1 تأتي خريطة محارف الخط للمجموعة إن كانت لها.
GET /search
أيقونات كل المجموعات، الأنسب أولًا، بصيغة prefix:name. يجب أن تكون كل كلمة من الاستعلام في اسم الأيقونة أو في أسمائها الأخرى وفئاتها.
- query
- مطلوب، حتى 128 حرفًا. تُفصل الكلمات بمسافة أو فاصلة أو نقطتين أو شرطة أو شرطة سفلية، ولا فرق بين الأحرف الكبيرة والصغيرة.
- limit
- من 1 إلى 999؛ والافتراضي 64.
- start
- من أي نتيجة يبدأ الرد.
- prefix, prefixes
- مجموعة واحدة، أو عدة مجموعات بالصيغة التي يقبلها /collections.
- category
- مجموعات فئة واحدة من فئات Iconify فقط، مثل Emoji.
- الترتيب
- اسم يساوي الاستعلام، ثم اسم يبدأ به، ثم اسم يحتويه. وبين المتساوين يتقدّم الاسم الأقصر ومجموعات DiceX نفسها.
- total
- عدد النتائج في هذا الرد، كما في API الرسمي، وليس عدد كل المطابقات.
GET /{prefix}/{name}.svg
أيقونة واحدة كصورة. معاملاتها في قسم «عناوين SVG» أعلاه.