Passer au contenu principal
Utilisez des icônes provenant de Font Awesome, Lucide, de SVG (Scalable Vector Graphics), d’URL externes ou de fichiers de votre projet pour enrichir votre documentation.
Icon example
<Icon icon="flag" size={32} />

Icônes en ligne

Les icônes sont intégrées lorsqu’elles sont utilisées dans un paragraphe. La documentation que vous voulez, en toute simplicité.
Inline example
<Icon icon="flag" iconType="solid" /> La documentation que vous souhaitez, sans effort.

Propriétés

icon
string
required
L’icône à afficher.Options :
  • Nom d’icône Font Awesome
  • Nom d’icône Lucide
  • Code SVG compatible JSX, entouré d’accolades
  • URL d’une icône hébergée en externe
  • Chemin vers un fichier d’icône dans votre projet
Pour des icônes SVG personnalisées :
  1. Convertissez votre SVG avec le convertisseur SVGR.
  2. Collez votre code SVG dans le champ de saisie SVG.
  3. Copiez l’élément complet <svg>...</svg> depuis le champ de sortie JSX.
  4. Enveloppez le code SVG compatible JSX dans des accolades : icon={<svg ...> ... </svg>}.
  5. Ajustez height et width si nécessaire.
iconType
string
Le style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.Options : regular, solid, light, thin, sharp-solid, duotone, brands.
color
string
La couleur de l’icon sous forme de code hexadécimal (par exemple « #FF5733 »).
size
number
La taille de l’icon en pixels.
I