Zum Inhalt springen

Dokumentation

Setzen Sie Icons mit einem Namen in eine App ein, oder lesen Sie sie direkt aus der API.

In DiceX-Apps

Die Bibliothek @dicex/design trägt icons.dicex.me beim Import als Iconify-Anbieter ein. So wird jedes Icon jedes Sets über seinen Namen gezeichnet: Präfix, Doppelpunkt, Name.

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

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

Dasselbe Icon, von genau diesem Server.

Die eigenen Icons der Bibliothek (DESIGN_ICONS) liegen in ihrem Bundle und sind schon beim ersten Rendern da; alle anderen kommen von diesem Dienst. Ein Icon mit Bedeutung braucht ein label, sonst ist es Dekoration und für Screenreader verborgen.

In jedem anderen Projekt

Mit dem offiziellen Iconify-Client geben Sie nur die Adresse des Servers an; sonst ändert sich nichts. Die Clients von Iconify für andere Frameworks nehmen dieselbe Adresse.

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" />;

Der leere String ist der Standardanbieter. Der Client fragt nur die Icons an, die auf der Seite sind, eine Anfrage je Set, und der Browser behält jede Antwort eine Woche.

SVG-Adressen

Jedes Icon ist auch eine SVG-Datei, für ein img-Tag, CSS, E-Mail oder ein Design-Tool. In einem img ist currentColor schwarz; die gewünschte Farbe geben Sie mit color an.

  • Ohne Parameter: ein em hochhttps://icons.dicex.me/solar/home-2-linear.svg
  • Mit Größehttps://icons.dicex.me/solar/home-2-linear.svg?height=48
  • Mit Farbehttps://icons.dicex.me/solar/home-2-linear.svg?height=48&color=%23e11d48
  • Gedreht und gespiegelthttps://icons.dicex.me/solar/home-2-linear.svg?height=48&rotate=90deg&flip=horizontal
color
Die Farbe; sie ersetzt currentColor. Jede CSS-Farbe, und # schreiben Sie in der Adresse als %23.
width, height
Größe: eine Zahl mit beliebiger Einheit (48, 3rem) oder auto, unset, none. Geben Sie eine an, folgt die andere den Proportionen des Icons.
rotate
Drehen: 1 bis 3 Vierteldrehungen, oder 90deg, 180deg, 270deg, oder 25%, 50%, 75%.
flip
Spiegeln: horizontal oder vertical, oder beides durch Komma getrennt.
box
Mit 1 wird ein transparentes Rechteck in der Größe der viewBox ergänzt, für Tools, die die viewBox nicht lesen.
download
Mit 1 ist die Antwort ein Anhang und der Browser speichert die Datei.

API-Referenz

Dieser Dienst spricht die offizielle Iconify-API: Jeder Client, der damit arbeitet, funktioniert auch mit diesem Server. Die Antworten sind JSON, außer bei SVG. Unter jedem Pfad steht eine fertige Anfrage, die von dieser Seite an diesen Server geschickt wird.

CORS
Die Antworten sind für jede Seite offen (Access-Control-Allow-Origin: *), ein einfaches GET genügt.
pretty
Mit pretty=1 wird die JSON-Antwort eingerückt.
Caching
Icon-Daten und SVGs werden eine Woche zwischengespeichert (max-age=604800), Listen und Suchen eine Stunde (max-age=3600).
Fehler
Ein unbekanntes Set oder Icon ergibt 404 mit dem Text Not found, eine fehlerhafte Anfrage 400 mit Bad request.

GET /{prefix}.json

Die Daten der angefragten Icons im JSON-Format von Iconify, aus dem die Clients zeichnen. Ein Name, den das Set nicht hat, steht in not_found.

icons
Icon-Namen ohne Präfix, durch Kommas getrennt. Pflicht.

GET /collections

Alle Sets, die man durchsuchen kann, nach Präfix: Name, Autor, Lizenz, Anzahl der Icons, Beispiele, Rastergröße, Kategorie und Farbigkeit.

prefix
Nur dieses Set, auch wenn es versteckt ist.
prefixes
Eine Liste mit Kommas. Ein Name, der mit einem Bindestrich endet, steht für jedes Präfix, das damit beginnt (mdi- ist mdi-light und die übrigen).
hidden
Mit 1 kommen auch versteckte Sets.

GET /collection

Die Icon-Namen eines Sets nach Kategorie: uncategorized, categories und total. aliases und hidden kommen nur, wenn das Set sie hat.

prefix
Das Präfix des Sets. Pflicht.
info
Mit 1 kommen auch die Infos zum Set.
chars
Mit 1 kommt die Zuordnung der Schriftzeichen des Sets, falls es eine hat.

GET /{prefix}/{name}.svg

Ein Icon als Bild. Seine Parameter stehen oben im Abschnitt SVG-Adressen.