Skip to main content
Version: Next

@editora/react-icons

React icon components and provider strategy for Editora apps.

Installation

npm i @editora/react-icons

Quick Start

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

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

Usage

Use named icon components for static UI and <Icon name="..." /> for dynamic rendering.

Examples

  • Component-level icon props
  • Provider default overrides
  • Dynamic icon rendering from server-driven names

API Reference

SurfaceTypeNotes
IconComponent exportGeneric renderer by icon name
createIcon(name, displayName?)Factory exportCreates React icon components
IconProvider, IconContext, useIconContext, defaultIconContextContext exportsProvider + context utilities
Icons, icons, iconNames, getIconComponentRegistry exportsProgrammatic icon component access
export * from './icons'Component exportsAll generated named icon components
IconBaseProps, IconProps, NamedIconProps, IconContextValue, IconNameType exportsTyped prop/context contracts

Best Practices

  • Prefer named imports for static icon usage.
  • Use provider defaults to keep icon styling consistent.
  • Validate icon contrast across theme modes.

Accessibility

For icon-only buttons, set aria-label on the button or icon component.

Performance Notes

Avoid creating icon components in render loops; use static imports or memoized getIconComponent lookups.