Use ícones do Font Awesome, Lucide, SVGs, URLs externas ou arquivos do seu projeto para enriquecer sua documentação.
Icon example
<Icon icon="flag" size={32} />

​
Ícones inline

Ícones são colocados inline quando usados dentro de um parágrafo. A documentação que você deseja, sem esforço.
Inline example
<Icon icon="flag" iconType="solid" /> A documentação que você deseja, sem esforço.

​
Propriedades

​
icon
string
required
O ícone a ser exibido.Opções:
  • nome do ícone Font Awesome
  • nome do ícone Lucide
  • código SVG compatível com JSX, entre chaves
  • URL para um ícone hospedado externamente
  • caminho para um arquivo de ícone no seu projeto
Para ícones SVG personalizados:
  1. Converta seu SVG usando o conversor SVGR.
  2. Cole seu código SVG no campo de entrada de SVG.
  3. Copie o elemento completo <svg>...</svg> do campo de saída em JSX.
  4. Coloque o código SVG compatível com JSX entre chaves: icon={<svg ...> ... </svg>}.
  5. Ajuste height e width conforme necessário.
​
iconType
string
O estilo do ícone do Font Awesome. Usado apenas com ícones do Font Awesome.Opções: regular, solid, light, thin, sharp-solid, duotone, brands.
​
color
string
A cor do ícone em código hexadecimal (por exemplo, #FF5733).
​
size
number
O tamanho do ícone em pixels.