Skip to content

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

Функция: simpleIcons()

simpleIcons(options?): PantokenPlugin

Бета

Создать плагин Simple Icons.

Параметры

options?

SimpleIconsOptions = {}

SimpleIconsOptions. Передайте registry, чтобы избежать ленивого импорта (например, при использовании в token-stage, где хуки синхронны).

Возвращаемое значение

PantokenPlugin

Плагин PantokenPlugin с хуками tokens и rehype.

Примеры

Выводить фирменные глифы как токены <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

Разрешать коды :brand: на этапе рендеринга (уровень 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" }