Usa íconos de Font Awesome, Lucide, SVG, URL externas o archivos de tu proyecto para mejorar tu documentación.
Icon example
<Icon icon="flag" size={32} />

Iconos en línea

Los iconos se colocan en línea cuando se usan dentro de un párrafo. La documentación que quieres, sin esfuerzo.
Inline example
<Icon icon="flag" iconType="solid" /> La documentación que quieres, sin esfuerzo.

Propiedades

icon
string
required
El icono que se mostrará.Opciones:
  • nombre del icono de Font Awesome
  • nombre del icono de Lucide
  • Código SVG compatible con JSX envuelto entre llaves
  • URL de un icono alojado externamente
  • Ruta a un archivo de icono en tu proyecto
Para iconos SVG personalizados:
  1. Convierte tu SVG con el convertidor SVGR.
  2. Pega tu código SVG en el campo de entrada de SVG.
  3. Copia el elemento completo <svg>...</svg> del campo de salida JSX.
  4. Envuelve el código SVG compatible con JSX entre llaves: icon={<svg ...> ... </svg>}.
  5. Ajusta height y width según sea necesario.
iconType
string
El estilo del icono de Font Awesome. Solo se usa con iconos de Font Awesome.Opciones: regular, solid, light, thin, sharp-solid, duotone, brands.
color
string
El color del ícono como código hexadecimal (por ejemplo, #FF5733).
size
number
El tamaño del ícono en píxeles.