Sommaire (Summary)

Utilisez un sommaire pour lister les sections d’une page longue.

attention

Ce composant nécessite une licence Pro valide en production.

Information	Valeur
Niveau	Pro
Composants Twig	dsfr:summary

Usage

• Les ancres doivent exister dans la page.
• Gardez des libellés identiques ou proches des titres ciblés.

Modes d'utilisation

Exemple principal

Sommaire · exemple principal

<twig:dsfr:summary :links="[
  {label: 'Informations générales', href: '#informations-generales'},
  {label: 'Pièces justificatives', href: '#pieces-justificatives'}
]" />

Données

La prop links 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:summary :links="links" />

Attributs HTML

Ajoutez vos attributs applicatifs directement sur le composant quand ils concernent le nœud racine rendu par le template.

Attributs pass-through

<twig:dsfr:summary
  id="sommaire-example"
  class="fr-mt-2w"
  data-controller="sommaire"
/>

API publique

Composant	Rôle
dsfr:summary	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	Sommaire	Titre du sommaire.
links	array|string	[]	Liens { label, href }.

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:summary.
Documentation DSFR	Consultez aussi la bibliothèque officielle : Système de Design de l'État.

Sommaire : données typées via links

Variantes de sommaire

• sommaire avec attributs HTML pass-through pour id, class, data-* et aria-* quand le template le permet.

Points de contrôle propres à ce composant

• Les ancres doivent exister dans la page.
• Gardez des libellés identiques ou proches des titres ciblés.
• Vérifiez un cas vide, un cas avec plusieurs entrées et un cas avec données dynamiques pour links.

Accessibilité navigation

• Le libellé de navigation doit être explicite avec ariaLabel ou un titre visible.
• La page courante doit être indiquée avec active, current ou aria-current selon le composant.
• Les panneaux contrôlés par JavaScript DSFR doivent avoir des id uniques et stables.

Intégration Symfony/Twig pour dsfr:summary

• Passez links avec la syntaxe : pour conserver le type tableau : :links="links".
• Ajoutez vos attributs applicatifs (data-controller, data-action, aria-*, class) sur dsfr:summary quand ils concernent son nœud racine.
• Gardez des id prévisibles pour dsfr:summary, surtout dans les listes ou formulaires répétés.

Checklist de recette

• navigation clavier complète
• état actif visible
• liaison aria-controls vers 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 links ne sont pas prises en compte	Ajoutez : devant la prop Twig : :links.
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.