Skip to content

pantoken / plugins/pantoken/simple-icons/src / simpleIcons

Fonction: simpleIcons()

simpleIcons(options?): PantokenPlugin

Bêta

Créer le plugin Simple Icons.

Paramètres

options?

SimpleIconsOptions = {}

SimpleIconsOptions. Passez un registry pour éviter l'import paresseux (par ex. dans l'utilisation token-stage, où les hooks sont synchrones).

Renvoie

PantokenPlugin

Un PantokenPlugin avec des hooks tokens et rehype.

Exemples

Émettre les glyphes de marque en tant que tokens <image>

ts
import { buildTokens } from "@pantoken/core/build";
import { simpleIcons } from "@pantoken/plugin-simple-icons";
import * as registry from "simple-icons";

buildTokens({
  theme: "rebrand",
  plugins: [simpleIcons({ registry, slugs: ["github", "react"] })],
});
// adds --instui-icon-github, --instui-icon-react as <image> tokens

Résoudre les codes :brand: lors du rendu (couche rehype)

ts
import { simpleIcons } from "@pantoken/plugin-simple-icons";
import * as registry from "simple-icons";

const { resolve } = simpleIcons({ registry }).rehype!({ resolve: () => undefined });
resolve("github"); // { name, path, svg, viewBox, source: "simple-icons" }