Aller au contenu principal

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.

InformationValeur
NiveauPro
Composants Twigdsfr: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

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
/>

API publique

ComposantRôle
dsfr:search:barComposant principal de cette page.

Configuration

OptionTypeDéfaut / requisValeurs et usage
idstringSelon composantIdentifiant HTML, normalisé et utilisé par aria-controls quand nécessaire.
labelstringRequisLibellé visible du contrôle.
namestring|nullnullNom du champ de recherche.
placeholderstring|nullnullAide de saisie courte.
valuestring|nullnullValeur initiale.
buttonLabelstringRechercherLibellé du bouton.
largeboolfalseActive la variante large DSFR.

Guide d'intégration

QuestionRéponse
Famille DSFRFormulaire
Quand l'utiliserQuand l’interface collecte, valide ou soumet une donnée utilisateur.
Quand éviterPour afficher une information non modifiable : préférez un composant de contenu ou de feedback.
API publiqueUtilisez uniquement les composants Twig listés sur cette page : dsfr:search:bar.
Documentation DSFRConsultez 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-* et aria-* 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, 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:search:bar

  • Ajoutez vos attributs applicatifs (data-controller, data-action, aria-*, class) sur dsfr:search:bar quand ils concernent son nœud racine.
  • Gardez des id prévisibles pour dsfr: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ômeCorrection
Les classes DSFR semblent incomplètesUtilisez les props du composant plutôt que des classes ajoutées à la main.
Un panneau, menu ou état actif ne fonctionne pasVérifiez que le JavaScript DSFR est chargé et que les identifiants HTML sont uniques.
Le composant rend en local mais pas en productionVérifiez la licence avec php bin/console dsfr:license:validate.