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

Icônes en ligne

Les icônes sont intégrées en ligne lorsqu’elles sont utilisées dans un paragraphe. La documentation dont vous avez besoin, sans effort.
Exemple d’icône en ligne
<Icon icon="flag" iconType="solid" /> La documentation que vous souhaitez, sans effort.

Propriétés

icon
string
required
L’icône à afficher.Options :
  • Nom de l’icône Font Awesome
  • Nom de l’icône Lucide
  • Code SVG compatible JSX entre accolades
  • URL d’une icône hébergée en externe
  • Chemin vers un fichier d’icône dans votre projet
Pour les 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. Entourez le code SVG compatible JSX d’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
Couleur de l’icône en code hexadécimal (par exemple : #FF5733).
size
number
Taille de l’icône en pixels.