Skip to content

Vizel API / core/src / setVizelIconRenderer

Function: setVizelIconRenderer()

ts
function setVizelIconRenderer(renderer): void;

Defined in: packages/core/src/icons/types.ts:341

Set the icon renderer function. Called by framework packages (react, vue, svelte) to inject their Iconify-based implementation.

Parameters

ParameterType
rendererVizelIconRendererWithOptions

Returns

void

Example

typescript
// In @vizel/react
import { setVizelIconRenderer, vizelDefaultIconIds } from "@vizel/core";
import { iconToSVG, getIconData } from "@iconify/utils";
import lucideIcons from "@iconify-json/lucide";

setVizelIconRenderer((name, options) => {
  const iconId = vizelDefaultIconIds[name];
  const [, iconName] = iconId.split(":");
  const data = getIconData(lucideIcons, iconName);
  if (!data) return "";
  const svg = iconToSVG(data, { width: options?.width, height: options?.height });
  return `<svg ...>${svg.body}</svg>`;
});

Released under the MIT License.