@editora/react-icons
React icon component layer for the Editora icon catalog.
Installation
npm i @editora/react-icons @editora/icons
API Surface
| Surface | Type | Notes |
|---|---|---|
Icon | Component export | Dynamic icon renderer by name |
createIcon | Factory export | Build icon components programmatically |
IconContext, IconProvider, useIconContext, defaultIconContext | Context exports | Provider and hook for shared defaults |
Icons, icons, iconNames, getIconComponent | Registry exports | Catalog and dynamic component lookup |
export * from './icons' | Component exports | Named icon components |
IconBaseProps, IconComponent, IconContextValue, IconFlip, IconProps, NamedIconProps, IconName | Type exports | Component + 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+namefor 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.