Skip to main content
Version: 1.0.0

@editora/icons

Framework-agnostic icon registry and rendering utilities.

Install

npm install @editora/icons

Core exports

  • Registry: iconDefinitions, iconNameList, getIcon, hasIcon, listIcons
  • Mutation: registerIcon, registerIcons
  • Rendering: resolveIcon, renderIconSvg, iconToDataUri
  • Integration: registerWithEditoraUI

Render options

  • variant (outline, solid, duotone)
  • size
  • color
  • strokeWidth

Quick start

import { renderIconSvg } from "@editora/icons";

const svg = renderIconSvg("check", {
variant: "outline",
size: 16,
color: "currentColor",
strokeWidth: 1.5,
});

API Surface

  • Query: getIcon, hasIcon, listIcons
  • Register: registerIcon, registerIcons
  • Render: renderIconSvg, resolveIcon, iconToDataUri

Config Matrix

OptionTypePurpose
variant"outline" | "solid" | "duotone"Visual style
sizenumberIcon dimensions
colorstringForeground color
strokeWidthnumberStroke thickness

Validation Checklist

  • Icon lookup APIs return deterministic results
  • Variant fallback behavior is consistent
  • Render output is stable across supported browsers
  • Consumers provide accessibility labels for icon-only controls