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

​
Icônes d’image personnalisées

Utilisez la prop src pour afficher une image personnalisée en guise d’icône. L’image peut être un fichier de votre projet ou une URL hébergée en externe.
Custom image examples
<Icon src="/images/mon-icone.svg" />

<Icon src="https://example.com/icon.png" />

​
Icônes en ligne

Les icônes sont placées en ligne lorsqu’elles sont utilisées dans une phrase, un paragraphe ou un titre. Utilisez les icônes pour la décoration ou pour renforcer l’accent visuel.
Inline example
Les icônes sont placées en ligne lorsqu'elles sont utilisées dans une phrase, un paragraphe ou un titre. <Icon icon="flag" iconType="solid" /> Utilisez des icônes pour décorer ou ajouter un accent visuel.

​
Propriétés

Vous devez fournir icon ou src.
​
icon
string
Icône à afficher depuis une bibliothèque d’icônes.Options :
  • Nom d’icône Font Awesome si vous avez la propriété icons.library définie sur fontawesome dans votre docs.json
  • Nom d’icône Lucide si vous avez la propriété icons.library définie sur lucide dans votre docs.json
  • Nom d’icône Tabler si vous avez la propriété icons.library définie sur tabler dans votre docs.json
​
src
string
Chemin ou URL d’une image à utiliser comme icône. Utilisez src à la place de icon lorsque vous souhaitez utiliser une image personnalisée plutôt qu’une icône d’une bibliothèque.Options :
  • Chemin vers un fichier image dans votre projet (par exemple, /images/mon-icone.svg)
  • URL vers une image hébergée en externe (par exemple, https://example.com/icon.png)
​
iconType
string
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.
​
className
string
Nom de classe CSS personnalisé à appliquer à l’icon.