Skip to main content
Version: Next

@editora/react-icons

React icon component layer for the Editora icon catalog.

Installation

npm i @editora/react-icons @editora/icons

API Surface

SurfaceTypeNotes
IconComponent exportDynamic icon renderer by name
createIconFactory exportBuild icon components programmatically
IconContext, IconProvider, useIconContext, defaultIconContextContext exportsProvider and hook for shared defaults
Icons, icons, iconNames, getIconComponentRegistry exportsCatalog and dynamic component lookup
export * from './icons'Component exportsNamed icon components
IconBaseProps, IconComponent, IconContextValue, IconFlip, IconProps, NamedIconProps, IconNameType exportsComponent + context typing

Usage Example

import { IconProvider, Icon, CheckIcon } from "@editora/react-icons";

export function ToolbarStatus() {
return (
<IconProvider value={{ size: 18, variant: "outline" }}>
<CheckIcon ariaLabel="Success" />
<Icon name="x" ariaLabel="Close" />
</IconProvider>
);
}

Best Practices

  • Use named components for static icon usage.
  • Use Icon + name for dynamic icon selection.
  • Apply provider defaults at layout/app-shell level.

Accessibility

Provide labels for icon-only actions (aria-label or visible text).

Performance Notes

Avoid creating component factories in render paths; use static imports or memoized lookup.