Barre de recherche (Search)
Utilisez la barre de recherche pour lancer une recherche textuelle dans une page ou une application.
attention
Ce composant nécessite une licence Pro valide en production.
| Information | Valeur |
|---|---|
| Niveau | Pro |
| Composants Twig | dsfr:search:bar |
Usage
- Le libellé reste présent pour les technologies d’assistance.
- Le mode large correspond à la variante DSFR de recherche principale.
Modes d'utilisation
- Exemple principal
- Attributs HTML
Barre de recherche · exemple principal
<twig:dsfr:search:bar
id="main-search"
label="Rechercher un dossier"
name="q"
placeholder="Nom, référence ou commune"
large
/>
Ajoutez vos attributs applicatifs directement sur le composant quand ils concernent le nœud racine rendu par le template.
Attributs pass-through
<twig:dsfr:search:bar
id="barre-de-recherche-example"
class="fr-mt-2w"
data-controller="barre-de-recherche"
/>
API publique
| Composant | Rôle |
|---|---|
dsfr:search:bar | 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. |
label | string | Requis | Libellé visible du contrôle. |
name | string|null | null | Nom du champ de recherche. |
placeholder | string|null | null | Aide de saisie courte. |
value | string|null | null | Valeur initiale. |
buttonLabel | string | Rechercher | Libellé du bouton. |
large | bool | false | Active la variante large 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:search:bar. |
| Documentation DSFR | Consultez aussi la bibliothèque officielle : Système de Design de l'État. |
Barre de recherche : options, accessibilité et rendu DSFR
Variantes de barre de recherche
- barre de recherche avec attributs HTML pass-through pour
id,class,data-*etaria-*quand le template le permet.
Points de contrôle propres à ce composant
- Le libellé reste présent pour les technologies d’assistance.
- Le mode large correspond à la variante DSFR de recherche principale.
Accessibilité formulaire
- Chaque champ doit avoir un
label,legendou 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,erroretvalidpour refléter le vrai statut métier.
Intégration Symfony/Twig pour dsfr:search:bar
- Ajoutez vos attributs applicatifs (
data-controller,data-action,aria-*,class) surdsfr:search:barquand ils concernent son nœud racine. - Gardez des
idprévisibles pourdsfr:search:bar, 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. |