Encarts
Ajoutez des composants d'encart info, note, tip, check, warning, danger ou personnalisés pour mettre en avant les informations clés de votre documentation.
Présentez les encarts sous forme de Note, Avertissement, Info, Conseil, Check, Danger, ou créez votre propre encart :
<Note>Ajoute une note dans le contenu</Note><Warning>Cela génère un avertissement à prendre en compte</Warning><Info>Met en avant des informations importantes</Info><Tip>Voici un conseil utile</Tip><Check>Cela nous donne un statut validé</Check><Danger>Ceci est une alerte de danger</Danger><Callout icon="key" color="#FFC107" iconType="regular">Ceci est un encadré personnalisé</Callout>Le composant générique Callout prend en charge les icônes et couleurs personnalisées. Les encarts typés (Note, Warning, Info, Tip, Check, Danger) utilisent des icônes et couleurs prédéfinies et n’acceptent que children.
iconstringL’icône à afficher.
Options:
- Font Awesome nom d’icône, si vous avez la propriété
icons.libraryparamètres définie surfontawesomedans votredocs.json - Lucide nom d’icône, si vous avez la propriété
icons.libraryparamètres définie surlucidedans votredocs.json - Tabler nom d’icône, si vous avez la propriété
icons.libraryparamètres définie surtablerdans votredocs.json - URL vers une icône hébergée en externe
- Chemin vers un fichier d’icône dans votre projet
- Code SVG entouré d’accolades
Pour les icônes SVG personnalisées:
- Convertissez votre SVG avec le convertisseur SVGR.
- Collez votre code SVG dans le champ d’entrée SVG.
- Copiez l’élément complet
<svg>...</svg>depuis le champ de sortie JSX. - Enveloppez le code SVG compatible JSX dans des accolades :
icon={<svg ...> ... </svg>}. - Ajustez
heightetwidthselon vos besoins.
iconTypestringLe style d’icône Font Awesome. Utilisé uniquement avec les icônes Font Awesome.
Options: regular, solid, light, thin, sharp-solid, duotone, brands.
colorstringCouleur personnalisée sous forme de code hexadécimal (par exemple, #FFC107). Définit la bordure, la teinte de fond et la couleur du texte de l’encart.