Interrupteur (Toggle)

Utilisez un interrupteur pour activer ou désactiver une option immédiate.

attention

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

Information	Valeur
Niveau	Pro
Composants Twig	dsfr:toggle, dsfr:toggle:group

Usage

• Le libellé doit décrire l’état contrôlé.
• Ajoutez une aide si l’effet n’est pas évident.

Modes d'utilisation

Exemple principal

Interrupteur · exemple principal

<twig:dsfr:toggle:group>
  <twig:dsfr:toggle
  id="notifications"
  name="notifications"
  label="Recevoir les notifications"
  checked
  />
</twig:dsfr:toggle:group>

Composition

Cette page expose aussi les sous-composants publics suivants : dsfr:toggle:group. 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.

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:toggle
  id="interrupteur-example"
  class="fr-mt-2w"
  data-controller="interrupteur"
/>

API publique

Composant	Rôle
dsfr:toggle	Composant principal de cette page.
dsfr:toggle:group	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.
label	string	Requis	Libellé visible du contrôle.
name	string|null	null	Nom du champ.
checked	bool	false	État actif initial.
labelChecked / labelUnchecked	string	Activé / Désactivé	Libellés d’état.
hint	string|null	null	Texte d’aide DSFR.
disabled	bool	false	Désactive le contrôle. Accepte aussi 0/1 ou chaînes booléennes.
required	bool	false	Rend le champ obligatoire côté HTML.
bordered / labelLeft	bool	false	Bordure et position du libellé.
dsfr:toggle:group	slot	Aucune prop dédiée	Groupe plusieurs interrupteurs dans une liste DSFR.

Guide d'intégration

Question	Réponse
Famille DSFR	Formulaire
Quand l'utiliser	Quand l’interface collecte, valide ou soumet une donnée utilisateur.
Quand éviter	Pour afficher une information non modifiable : préférez un composant de contenu ou de feedback.
API publique	Utilisez uniquement les composants Twig listés sur cette page : dsfr:toggle, dsfr:toggle:group.
Documentation DSFR	Consultez aussi la bibliothèque officielle : Système de Design de l'État.

Interrupteur : composition avec 1 sous-composant

Variantes de interrupteur

• état désactivé avec disabled quand l’action existe mais n’est pas disponible.

Points de contrôle propres à ce composant

• Le libellé doit décrire l’état contrôlé.
• Ajoutez une aide si l’effet n’est pas évident.
• Testez la composition avec dsfr:toggle:group sans copier les templates internes.

Accessibilité formulaire

• Chaque champ doit avoir un label, legend ou titre de groupe compréhensible.
• Les aides et erreurs doivent rester reliées au champ avec les identifiants générés.
• Utilisez required, disabled, error et valid pour refléter le vrai statut métier.

Intégration Symfony/Twig pour dsfr:toggle

• Composez avec les sous-composants publics dsfr:toggle:group quand le rendu doit être plus précis que les props.
• Ajoutez vos attributs applicatifs (data-controller, data-action, aria-*, class) sur dsfr:toggle quand ils concernent son nœud racine.
• Gardez des id prévisibles pour dsfr:toggle, surtout dans les listes ou formulaires répétés.

Checklist de recette

• label visible ou accessible
• message erreur lu par technologie d’assistance
• valeurs conservées après erreur de validation
• 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 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.