Menu latéral (Sidemenu)
Utilisez un menu latéral pour naviguer dans une rubrique ou une documentation dense.
attention
Ce composant nécessite une licence Pro valide en production.
| Information | Valeur |
|---|---|
| Niveau | Pro |
| Composants Twig | dsfr:sidemenu |
Usage
- Indiquez l’item actif.
- Le menu peut contenir des sous-items.
Modes d'utilisation
- Exemple principal
- Données
- Attributs HTML
Menu latéral · exemple principal
<twig:dsfr:sidemenu title="Paramètres" :items="[
{label: 'Profil', href: '/settings/profile', active: true},
{label: 'Sécurité', href: '/settings/security'}
]" />
La prop items accepte un tableau PHP/Twig. En Twig, préfixez la prop par : pour transmettre une vraie structure de données.
Syntaxe typée Twig Component
{# Le préfixe : garde le type tableau/booléen/numérique. #}
<twig:dsfr:sidemenu :items="items" />
Ajoutez vos attributs applicatifs directement sur le composant quand ils concernent le nœud racine rendu par le template.
Attributs pass-through
<twig:dsfr:sidemenu
id="menu-lateral-example"
class="fr-mt-2w"
data-controller="menu-lateral"
/>
API publique
| Composant | Rôle |
|---|---|
dsfr:sidemenu | Composant principal de cette page. |
Configuration
| Option | Type | Défaut / requis | Valeurs et usage |
|---|---|---|---|
id | string | Selon composant | Identifiant HTML, normalisé et utilisé par aria-controls quand nécessaire. |
title | string | Requis ou défaut selon composant | Titre visible du composant. |
items | array|string | [] | Items { label, href?, active?, children? }. |
Guide d'intégration
| Question | Réponse |
|---|---|
| Famille DSFR | Navigation |
| Quand l'utiliser | Quand l’usager doit se repérer, changer de section ou parcourir une liste de pages. |
| Quand éviter | Pour déclencher une action métier immédiate : utilisez plutôt un bouton. |
| API publique | Utilisez uniquement les composants Twig listés sur cette page : dsfr:sidemenu. |
| Documentation DSFR | Consultez aussi la bibliothèque officielle : Système de Design de l'État. |
Menu latéral : données typées via items
Variantes de menu latéral
- menu latéral avec attributs HTML pass-through pour
id,class,data-*etaria-*quand le template le permet.
Points de contrôle propres à ce composant
- Indiquez l’item actif.
- Le menu peut contenir des sous-items.
- Vérifiez un cas vide, un cas avec plusieurs entrées et un cas avec données dynamiques pour
items.
Accessibilité navigation
- Le libellé de navigation doit être explicite avec
ariaLabelou un titre visible. - La page courante doit être indiquée avec
active,currentouaria-currentselon le composant. - Les panneaux contrôlés par JavaScript DSFR doivent avoir des
iduniques et stables.
Intégration Symfony/Twig pour dsfr:sidemenu
- Passez
itemsavec la syntaxe:pour conserver le type tableau ::items="items". - Ajoutez vos attributs applicatifs (
data-controller,data-action,aria-*,class) surdsfr:sidemenuquand ils concernent son nœud racine. - Gardez des
idprévisibles pourdsfr:sidemenu, surtout dans les listes ou formulaires répétés.
Checklist de recette
- navigation clavier complète
- état actif visible
- liaison
aria-controlsvers un élément existant - rendu vérifié en thème clair et sombre ;
- rendu vérifié sur mobile, tablette et desktop ;
- aucune erreur dans le profiler DSFR ni dans l'inspecteur d'accessibilité du navigateur.
Erreurs fréquentes
| Symptôme | Correction |
|---|---|
Les données items ne sont pas prises en compte | Ajoutez : devant la prop Twig : :items. |
| Les classes DSFR semblent incomplètes | Utilisez les props du composant plutôt que des classes ajoutées à la main. |
| Un panneau, menu ou état actif ne fonctionne pas | Vérifiez que le JavaScript DSFR est chargé et que les identifiants HTML sont uniques. |
| Le composant rend en local mais pas en production | Vérifiez la licence avec php bin/console dsfr:license:validate. |