رفتن به محتوا

مستندات

آیکون‌ها را با یک نام در برنامه بنشانید، یا مستقیم از API بخوانید.

در برنامه‌های DiceX

کتابخانهٔ ⁦@dicex/design⁩ نشانی icons.dicex.me را همان لحظه که import می‌شود به‌عنوان ارائه‌دهندهٔ Iconify ثبت می‌کند. پس هر آیکون هر مجموعه‌ای را با نامش می‌کشید: پیشوند، دونقطه، نام.

tsx
import { Icon } from "@dicex/design";

<Icon icon="solar:home-2-linear" />

همین آیکون، از همین سرور.

آیکون‌های خود کتابخانه (DESIGN_ICONS) داخل بسته‌اند و در نخستین بارگذاری هستند؛ بقیه از این سرویس می‌آیند. آیکونی که معنایی دارد label می‌خواهد، وگرنه تزئینی است و از صفحه‌خوان پنهان می‌ماند.

در پروژه‌های دیگر

با کلاینت رسمی Iconify فقط نشانی سرور را بدهید؛ چیز دیگری عوض نمی‌شود. کلاینت‌های Iconify برای فریم‌ورک‌های دیگر هم همین نشانی را می‌گیرند.

bash
npm install @iconify/react
tsx
import { 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
چرخش: ۱ تا ۳ ربع دور، یا ⁦90deg⁩، ⁦180deg⁩، ⁦270deg⁩، یا ⁦25%⁩، ⁦50%⁩، ⁦75%⁩.
flip
برعکس کردن: horizontal یا vertical، یا هر دو با ویرگول.
box
با ۱، مستطیلی شفاف به اندازهٔ viewBox اضافه می‌شود، برای ابزارهایی که viewBox را نمی‌خوانند.
download
با ۱، پاسخ پیوست است و مرورگر فایل را ذخیره می‌کند.

مرجع API

رابط این سرویس همان API رسمی Iconify است؛ هر کلاینتی که با آن کار می‌کند با این سرور هم کار می‌کند. پاسخ‌ها JSON‌اند، به‌جز SVG. زیر هر مسیر درخواستی آماده هست که از همین صفحه به همین سرور فرستاده می‌شود.

CORS
پاسخ‌ها برای هر صفحه‌ای باز است (⁦Access-Control-Allow-Origin: *⁩) و یک GET ساده کافی است.
pretty
با pretty=1 پاسخ JSON با تورفتگی نوشته می‌شود.
ذخیره‌سازی
داده و SVG آیکون یک هفته (max-age=604800) و فهرست‌ها و جست‌وجو یک ساعت (max-age=3600) می‌مانند.
خطاها
مجموعه یا آیکون ناشناخته ۴۰۴ با متن Not found است؛ درخواست ناقص ۴۰۰ با متن Bad request.

GET /{prefix}.json

داده‌های آیکون‌های خواسته‌شده به قالب JSON در Iconify، همان که کلاینت‌ها از آن می‌کشند. نامی که مجموعه ندارد در not_found می‌آید.

icons
نام آیکون‌ها بدون پیشوند، با ویرگول جدا شده. الزامی.

GET /collections

همهٔ مجموعه‌هایی که می‌شود گشت، به نام پیشوندشان: نام، نویسنده، مجوز، تعداد آیکون، نمونه‌ها، اندازهٔ شبکه، دسته و رنگ‌بندی.

prefix
فقط همین مجموعه، حتی اگر پنهان باشد.
prefixes
فهرستی با ویرگول. نامی که به خط تیره ختم شود هر پیشوندی است که با آن شروع می‌شود (⁦mdi-⁩ یعنی mdi-light و بقیه).
hidden
با ۱، مجموعه‌های پنهان هم می‌آیند.

GET /collection

نام آیکون‌های یک مجموعه به تفکیک دسته: uncategorized، categories و total. aliases و hidden فقط وقتی می‌آیند که مجموعه داشته باشد.

prefix
پیشوند مجموعه. الزامی.
info
با ۱، اطلاعات مجموعه هم می‌آید.
chars
با ۱، نگاشت نویسه‌های فونت مجموعه می‌آید، اگر داشته باشد.

GET /{prefix}/{name}.svg

تصویر یک آیکون. پارامترهایش در بخش «نشانی SVG» بالاست.