diff --git a/doc/components.md b/doc/components.md index 14a119b72db369feeabd3d5a76cca791deb6ea2f..1ed5dc3fa24c3abd8b5b578dbd0630661a4590c6 100644 --- a/doc/components.md +++ b/doc/components.md @@ -16,9 +16,15 @@ Le composant **TextRight** sert à afficher une image à la gauche de son bloc e Le composant **Carousel** permet de générer un carrousel en utilisant le _slider_ de [React Slick] (https://react-slick.neostack.com/). +Le composant peut recevoir 5 props. `name` (optionel) sera le texte affiché sous l'image, `link` (optionel) permet de rendre l'image cliquable pour ouvrir un lien dans un nouvel onglet, `alt` sera le texte alternatif à l'image ou au svg. +Concernant l'image, il peut s'agir d'un fichier (png, svg, jpeg...) avec le props `img` ou de svg inline en html avec le props `svg` (ne pas mettre de chemin vers un fichier svg avec le props `svg`!). Si les deux arguments sont fournis, seul `img` sera pris en compte. + ### CarouselLibre.js -Le composant **CarouselLibre** est utilisé sur la page d'accueil pour afficher un carrousel des logiciels libres utilisés par Froggit, il utilise le composant générique **Carousel** +Le composant **CarouselLibre** est utilisé sur la page d'accueil pour afficher un carrousel des logiciels libres (FLOSS) utilisés par Froggit, il utilise le composant générique **Carousel** + +Afin que les logos de FLOSS unis (par exemple blancs ou noirs) restent bien visibles peu importe le thème, les intégrer en SVG inline dans le props `svg` et penser à supprimer les valeurs "fill". Cela leur permettra de prendre la couleur du texte selon le thème. + ### HomepagePromises.js @@ -31,5 +37,3 @@ Les éléments **Promise** de la liste sont affichés en colonne et sont compos ### HomepageFeatures.js Le composant **HomepageFeatures** affiche les fonctionnalités de Froggit sur la page d'accueil. - -