Skip to main content
Utilisez le composant Variation pour afficher ou masquer du contenu selon la variation choisie par le lecteur dans le menu déroulant de variations. Les variations sont utiles quand la même page doit décrire une audience, une région, un niveau d’offre ou une cible de déploiement différents sans dupliquer la page.
Les variations sont disponibles sur le thème Willow. Sur les autres thèmes, la configuration et le sélecteur sont ignorés.

​
Configurer les variations

Ajoutez un objet variations à votre docs.json avec les options entre lesquelles vous voulez que les lecteurs puissent basculer. La première option est la valeur par défaut.
docs.json
​
array
requis
Options de variation dans l’ordre d’affichage. La première option est la valeur par défaut. Chaque option nécessite :
  • id : Un identifiant stable et unique utilisé dans le composant Variation et dans l’URL.
  • label : Le nom affiché dans le menu déroulant de variations.
Quand variations est configuré, un menu déroulant Variation apparaît au-dessus du sélecteur de vue existant dans la barre latérale de la table des matières, les panneaux latéraux, les filtres du changelog et en ligne sur mobile.

​
Utiliser le composant

Enveloppez le contenu conditionnel dans un composant Variation et définissez is sur l’id de l’option qui doit le révéler. Le contenu hors d’un bloc Variation est toujours affiché.
Pour partager du contenu entre plusieurs variations, passez un tableau à is :

​
Comment les lecteurs changent de variation

  • Les lecteurs choisissent une variation dans le menu déroulant de la barre latérale de la table des matières.
  • La sélection est enregistrée dans le stockage local par projet, ce qui permet aux lecteurs de conserver leur variation en naviguant entre les pages.
  • La variation active est reflétée dans l’URL sous la forme ?variation=<id>, ce qui facilite le partage d’un lien vers une variation précise.

​
Comportement de la table des matières

Les titres à l’intérieur d’un bloc Variation sont automatiquement filtrés de la table des matières quand une autre variation est active. Les titres en dehors de tout bloc Variation apparaissent toujours. Les blocs Variation imbriqués se croisent : un bloc interne ne s’affiche que si sa valeur is est compatible avec tous les blocs englobants.

​
Propriétés

​
string ou string[]
requis
L’id de variation (ou le tableau d’ids) qui doit révéler le contenu enveloppé. Les ids doivent correspondre à une option définie dans variations.options dans docs.json.