Navigation principale (Navigation)
Utilisez la navigation principale pour les grandes rubriques du site.
attention
Ce composant nécessite une licence Pro valide en production.
| Information | Valeur |
|---|---|
| Niveau | Pro |
| Composants Twig | dsfr:nav, dsfr:nav:item, dsfr:nav:menu, dsfr:nav:mega |
Usage
- L’élément actif porte
aria-current. - Les menus déroulants doivent contenir des liens.
Modes d'utilisation
- Exemple principal
- Composition
- Données
- Attributs HTML
Navigation principale · exemple principal
<twig:dsfr:nav>
<twig:dsfr:nav:item label="Accueil" href="/" active />
<twig:dsfr:nav:menu label="Dossiers" id="nav-files">
<twig:dsfr:nav:item label="Tous les dossiers" href="/dossiers" />
<twig:dsfr:nav:item label="Créer un dossier" href="/dossiers/nouveau" />
</twig:dsfr:nav:menu>
<twig:dsfr:nav:mega
id="nav-services"
label="Services"
:categories="[
{label: 'Démarches', items: [
{label: 'État civil', href: '/services/etat-civil'},
{label: 'Urbanisme', href: '/services/urbanisme'}
]}
]"
/>
</twig:dsfr:nav>
Cette page expose aussi les sous-composants publics suivants : dsfr:nav:item, dsfr:nav:menu, dsfr:nav:mega. Utilisez-les quand vous devez contrôler précisément la structure Twig au lieu de passer un tableau de données.
astuce
Préférez les sous-composants publics aux include, macros ou copies de templates internes. Cela garde votre code aligné avec les évolutions du bundle.
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:nav :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:nav
id="navigation-principale-example"
class="fr-mt-2w"
data-controller="navigation-principale"
/>
API publique
| Composant | Rôle |
|---|---|
dsfr:nav | Composant principal de cette page. |
dsfr:nav:item | Sous-composant public utilisable en composition Twig. |
dsfr:nav:menu | Sous-composant public utilisable en composition Twig. |
dsfr:nav:mega | Sous-composant public utilisable en composition Twig. |
Configuration
| Option | Type | Défaut / requis | Valeurs et usage |
|---|---|---|---|
id | string | Selon composant | Identifiant HTML, normalisé et utilisé par aria-controls quand nécessaire. |
ariaLabel | string | Menu principal | Libellé accessible de la navigation. |
items | array|string | [] | Items simples ou menus. |
dsfr:nav:item | props | href, active, target, icon | Lien direct. |
dsfr:nav:menu | props + slot | id, label, active, expanded | Menu déroulant dont le contenu est composé avec des liens dsfr:nav:item. |
dsfr:nav:mega | props + slot | id, label, active, expanded, categories, leader | Méga-menu DSFR pour les navigations riches. |
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:nav, dsfr:nav:item, dsfr:nav:menu, dsfr:nav:mega. |
| Documentation DSFR | Consultez aussi la bibliothèque officielle : Système de Design de l'État. |
Navigation principale : composition Twig et données items
Variantes de navigation principale
- navigation principale avec attributs HTML pass-through pour
id,class,data-*etaria-*quand le template le permet.
Points de contrôle propres à ce composant
- L’élément actif porte
aria-current. - Les menus déroulants doivent contenir des liens.
- Vérifiez un cas vide, un cas avec plusieurs entrées et un cas avec données dynamiques pour
items. - Testez la composition avec
dsfr:nav:item,dsfr:nav:menu,dsfr:nav:megasans copier les templates internes.
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:nav
- Passez
itemsavec la syntaxe:pour conserver le type tableau ::items="items". - Composez avec les sous-composants publics
dsfr:nav:item,dsfr:nav:menu,dsfr:nav:megaquand le rendu doit être plus précis que les props. - Ajoutez vos attributs applicatifs (
data-controller,data-action,aria-*,class) surdsfr:navquand ils concernent son nœud racine. - Gardez des
idprévisibles pourdsfr:nav, 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. |