sections.md

Créer des sections

Docusaurus étant un Framework de la librairie React, on y retrouve la même logique.

L'affichage d'une page web est un ensemble de composants réutilisables, que l'on peux assembler.

Nous allons nous appuyer sur l'utilisation de ces Composants pour créer nos différentes sections d'affichage, notamment pour gérer le rendu visuel de la page d'accueil du site index.js.

Chaque section de pages va être définie dans un Composant enfant dans le dossier ./src/components/, puis importée dans un Composant parent dans le dossier ./src/pages/.

Un composant (Componant) contient: des données qui constituent un état (state), des comportements et un rendu (l'affichage), ces trois notions vont interagir entre elles.

Création du composant

Pour l'exemple, nous allons expliquer comment nous avons créer la section chargée d'afficher les fonctionnalités (Features) de Froggit.

Dans le dossier src/components/, nous avons créé un fichier React HomepageFeatures.js.

Nous avons choisi de nommer notre fichier HomepageFeatures, en PascalCase, car ce composent est destiné à être affiché, dans la Homepage (page d'Accueil) et doit afficher les Features (fonctionnalités) de Froggit.

Ce fichier est composé de 3 parties:

• une pour gérer les données de notre section ;
• une pour définir les comportements que nous attendons en utilisant différentes fonctions ;
• une pour définir l'affichage. Nous utilisons le JSX pour cette partie, voir l' introduction au JSX sur la doc de React pour des explications sur cette extension syntaxique du JavaScript.

Les données de notre section

Nous allons créer un tableau d'objets JavaScript pour définir les données à afficher dans notre section. Il y a 3 objets pour chaque élément du tableau :

1. Un titre, de type chaîne de charactère (String), donc entouré de guillements simples ' ou doubles ").
2. Une description, que nous définissons en tant qu' Element JSX. Nous pouvons ainsi lui donner un template de rendu comme valeur, avec les balises HTML de notre choix, juste un paragraphe dans notre cas. Pour cela, nous devons définir sa valeur entre des parenthèses et à l'intérieur d' une balise parent, pouvant être une div, ou comme nous utilisons ci-dessous, avec une simple balise vide.
3. Une image, que nous définissons en tant que Composant React, afin de simplifier la syntaxe de notre code dans les prochaines étapes notemment pour définir notre affichage. Comme cette image est un composant, nous la nommons Svg en PascalCase. Enfin, nous utilisons ici le format SVG, mais nous pouvons utiliser d'autres formats tels que le PNG, GIF et JPG. Mais dans ce cas il faudra installer le plugin officiel de gestion d' images pour les formats PNG ou JPG.

Nous appelons notre tableau featuresList car c'est la liste des fonctionnalités.

const FeatureList = [
  {
    title: "Le Lab 🧪",   
    Svg: require("../../static/img/chemistry.svg").default,
    description: (
      <>
        Le laboratoire vous permet d’héberger votre code et de collaborer dessus avec Git. C&apos;est plus qu&apos;un serveur Git puisque vous pouvez gérer un projet complet dessus. Le Lab est le cœur de Froggit et il sert aussi de base centrale pour l’authentification unique (SSO) des autres services.
      </>
    ), 
  },     
  {
    title: "La CI 🔁",  
    Svg: require("../../static/img/rainbow.svg").default,
    description: (
      <>
        Fournir un outil de collaboration de code sans Intégration Continue n&apos;était pas pensable pour nous. C&apos;est pour cela que nous avons mis en place une CI avec un serveur et un débordement élastique dans Kubernetes.
      </>
    ), 
  },
  {
    title: "Le Chat 💬",  
    Svg: require("../../static/img/selfie.svg").default,
    description: (
      <>
        Pour collaborer les équipes ont besoin de communiquer. Qu&apos;elles soient physiquement au même endroit ou non une communication asynchrone est importante. C&apos;est pour cela que Froggit inclut un chat avec le service. Vous pourrez même faire remonter vos alertes et messages venant du Lab. L&apos;authentification se fera grâce au Lab, vous n&apos;aurez qu&apos;un seul compte pour tous les services de Froggit. Vous pourrez abandonner Slack sans crainte !
      </>
    ),
  },
  {
    title: "Les Pages 🔖",  
    Svg: require("../../static/img/read-smile.svg").default,
    description: (
      <>
        Vous avez besoin de créer des sites statiques pour vos documentations. C&apos;est pour cela que nous mettons en place les GitLab pages qui vous permettent d&apos;héberger des sites statiques.
      </>
    ),
  },
];  

Notre section affichera les 4 éléments, chacune avec un titre, une description et une image en Svg.

Affichage

Il faut maintenant définir l'affichage que nous souhaitons que ce composant renvoie.

Nous avons créé une fonction qui renvoie le rendu, grâce à un template.

L'utilisation du JSX simplifie cette tâche, nous avons trois parties qui sont les clés issues de notre tableau à afficher.

Tous élément JavaScript doit alors être affiché entre accolade: {---} afin d'être correctement interprété.

Notre affichage doit impérativement être entouré de balises parents, telle une div.

Nous passons comme argument les clés de notre tableau (Svg, title, description) à notre fonction

function Feature({Svg, title, description}) {
  return (
    <div className="sectionsReverse row">    
      <div className="col col--5 text--center">
        <Svg className={styles.svg} alt={title} />
      </div>
      <div className="col col--5">
        <h3>{title}</h3>
        <p>{description}</p>
      </div>      
    </div>
    
  );
}

Ainsi, notre composant va renvoyer notre Svg en image, le titre en h3 et la description en paragraphe.

Réutilisation du composant

Nous devons également importer certains utilitaires, selon nos besoins (la librairie React, les modules CSS), puis exporter notre composant, pour qu'il puisse être réutilisé. Il est nécessaire d'utiliser le système d'import/export de modules JavaScript.

Définition des Comportements

Nous itérons sur chaque élément de notre tableau, en utilisant la méthode JavaScript .map, qui est très souvent utilisé dans les Composants React.

La méthode map() crée un nouveau tableau avec les résultats de chaque élément du tableau. Voici un tutoriel expliquant cette méthode.

export default function HomepageFeatures() {
  return (
    <section className="sections container" id="features">      
      <h2 className={clsx("text--center text--uppercase", styles.title)}>Fonctionnalités</h2>
      <div>
        {FeatureList.map((props, idx) => (
          <Feature key={idx} {...props} />
        ))}
      </div>
    </section>
  );
}

Nous utilisons grâce à une fonction fléchée, une fonction de Callback pour boucler sur notre tableau, qui prend 2 paramètres, les props qui représentent les valeurs du tableau, et idx, les clés. les ... est un Spread Operator.

Notre Composant HomepageFeatures est également exporté au début de la déclaration de la fonction avec export default.

Utilisation du composant

Nous pouvons désormais utiliser notre composant dans un composant parent.

Dans notre cas, ce composant parent est la page d'accueil du site src/pages/index.js.

Il suffit d'importer notre composant enfant, que nous venons de créer, et de le mettre, comme une balise, dans la partie return de la fonction Home. La fonction Home retourne la vue de notre page :

import React from "react";
import HomepagePromises from "../components/HomepagePromises";
import HomepageFeatures from "../components/HomepageFeatures";

//    (...)

export default function Home() {
  return (
    <Layout>
      <HomepageHeader />
      <main>
        <HomepagePromises />
        <HomepageFeatures />
      </main>
    </Layout>
  );
}

Entre nos balises Layout, nous retrouvons 3 composants enfants, d'abord l'entête (header) nommé qui a été créé à l'intérieur même de ce composant.

Puis nous retrouvons 2 Composants, qui ont été importé depuis le dossier src/components/:

1. , pour la section des promesses
2. , pour la section des fonctionnalités

Feuille de style CSS

Un Composant peut avoir sa propre feuille de style CSS. Nous donnons le même nom que le fichier de composant au fichier CSS suivi du suffixe .module.css.

Un composant peut également utiliser la feuille de style générale custom.css. Ce fichier regroupe les attributs de styles standard commun à tous le site.

Chaque feuille de style que l'on souhaite utiliser doit être importé dans le Composant.