<input type="search">

Les éléments <input> dont l'attribut type vaut search permettent à un utilisateur de saisir des termes de recherche.

La valeur de l'attribut value contient une chaîne de caractères (DOMString) qui représente la valeur du champ de recherche. En JavaScript, on peut récupérer cette information grâce à la propriété HTMLInputElement.value.

maRecherche.value;

Si aucune contrainte de validation n'est imposée (cf. Validation pour plus de détails), la valeur peut être un texte ou une chaîne de caractères vide.

En complément des attributs communs à l'ensemble des éléments <input>, les champs de recherche prennent en charge les attributs suivants :

Le nombre maximum de caractères (exprimé en nombre de points de code UTF-16) que l'utilisateur peut saisir dans le champ. Cette valeur doit êtrer un entier positif ou nul. Si aucune valeur n'est fournie pour maxlength ou qu'une valeur invalide est fournie, il n'y a pas de contrainte de taille maximale. La valeur indiquée par cet attribut doit être supérieure à minlength.

Le champ ne sera pas valide si la longueur du texte dépasse maxlength en nombre de points de code UTF-16. Les contraintes de validation sont uniquement appliquées lorsque la valeur est modifiée par l'utilisateur.

Le nombre minimal de caractères (exprimé en nombre de points de code UTF-16) que l'utilisateur peut saisir dans le champ. Cette valeur doit êtrer un entier positif ou nul. Si aucune valeur n'est fournie pour minlength ou qu'une valeur invalide est fournie, il n'y a pas de contrainte de taille minimale. La valeur indiquée par cet attribut doit être inférieur à maxlength.

Le champ ne sera pas valide si la longueur du texte est inférieure à minlength en nombre de points de code UTF-16. Les contraintes de validation sont uniquement appliquées lorsque la valeur est modifiée par l'utilisateur.

L'attribut pattern est une expression rationnelle que doit respecter la valeur (value) du champ afin d'être valide. Cette expression rationnelle doit être une expression rationnelle valide pour JavaScript (telle qu'utilisée par RegExp et telle que documentée dans ce guide). Le marqueur 'u' est fourni par le navigateur lors de la compilation de l'expression rationnelle afin que le motif soit traité comme une séquence de points de code Unicode plutôt que comme des caractères ASCII. Aucune barre oblique (/) ne devrait être utilisée autour du motif.

Si l'expression rationnelle est invalide ou que cet attribut n'est pas défini, l'attribut est ignoré.

Voir la section sur l'utilisation de cet attribut ci-après pour plus d'exemples.

{{page("/fr/docs/Web/HTML/Element/input/text", "placeholder", 0, 1, 2)}}

{{page("/fr/docs/Web/HTML/Element/input/text", "readonly", 0, 1, 2)}}

{{page("/fr/docs/Web/HTML/Element/input/text", "size", 0, 1, 2)}}

spellcheck est un attribut universel qui est utilisé afin d'indiquer si la vérification orthographique doit être utilisée pour un élément. Il peut être utilisé pour n'importe quel contenu éditable mais possède certaines spécificités pour les éléments <input>. Les valeurs autorisées pour cet attribut sont :

false

La vérification orthographique est désactivée pour cet élément.

true

La vérification orthographique est activée pour cet élément.

"" (chaîne de caractères vide) ou aucune valeur

La configuration par défaut de l'élément par rapport à la vérification orthographique sera respectée. Cette configuration par défaut peut provenir de la valeur de spellcheck pour les éléments parents ou d'autres facteurs.

Un champ de saisie peut avoir la vérification orthographique activée s'il ne possède pas l'attribut readonly et qu'il n'est pas désactivé.

La valeur renvoyée par l'attribut spellcheck peut ne pas refléter l'état réel de la vérification ortographique si certaines préférences de l'agent utilisateur surchargent le paramétrage par défaut.

Les attributs non-standard suivants sont disponibles pour les champs de recherche. Toutefois, vu leur caractère spécifique, mieux vaut ne pas les utiliser.

Un attribut spécifique à Safari, sous la forme d'une chaîne de caractères, qui indique si la correction automatique doit être appliquée lors de l'édition du champ. Les valeurs autorisées pour cet attribut sont :

on

La correction automatique et les remplacements de texte sont appliqués.

off

Toute correction automatique et tout remplacement de texte est désactivé.

Un attribut booléen spécifique à WebKit et Blink qui indique à l'agent utilisateur de traiter la recherche en continu. Lorsque cet attribut est présent et lorsque l'utilisateur édite la valeur du champ, l'agent utilisateur envoie des évènements search sur l'objet HTMLInputElement qui représente le champ de recherche. Ainsi, on peut gérer, avec du code, la mise à jour continue des résultats de recherche.

Si l'attribut incremental n'est pas indiqué, l'évènement search est uniquement envoyé lorsque l'tuilisateur déclenche la recherche (en appuyant sur la touche Entrée ou Retour à l'édition du champ).

La fréquence maximale à laquelle l'évènement search est envoyé est définie par chaque implémentation.

Un attribut spécifique à Mozilla (et plus particulièrement Firefox pour Android) qui fournit une indication quant au type d'action effectuée lorsque l'utilisateur appuie sur la touche Entrée ou Retour lors de l'édition. Cette information pourra être utilisée afin de choisir le libellé à afficher sur la touche Entrée du clavier virtuel.

Les valeurs autorisées pour cet attribut sont : go, done, next, search et send. Le navigateur décide alors, selon la valeur, quel libellé utiliser pour la touche Entrée.

L'attribut results, spécifique à Safari, est une valeur numérique qui permet de surcharger la valeur maximale du nombre de recherches précédentes affichées dans la liste déroulante des suggestions.

Cette valeur doit être un nombre positif. Si cet attribut n'est pas fourni, ou que sa valeur est invalide, ce sera le maximum fourni par le navigateur qui sera utilisé.

Les éléments <input> de type search sont semblables aux éléments <input> de type text mais sont spécifiquement destinés à la gestion des termes d'une recherche.

<form>
  <div>
    <input type="search" id="maRecherche" name="q">
    <button>Rechercher</button>
  </div>
</form>

Cet exemple produira le résultat suivant :

q est la valeur standard utilisé pour l'attribut name des champs de recherche. Lorsque le formulaire est envoyée, les données envoyées au serveur auront la forme q=termederecherche. Il est nécessaire de fournir un nom (c'est-à-dire un attribut name) à un champ, sinon aucune information ne sera envoyée lors de l'envoi du formulaire.

La différence principale est la façon dont les navigateurs gèrent cet élément. Premièrement, certains navigateurs affiche une icône de croix dans la zone de saisie qui peut être utilisée pour retirer le terme de la recherche. Voici par exemple un aperçu de la fonctionnalité sous Chrome:

De plus, les navigateurs modernes proposent souvent une auto-complétion basée sur les termes de recherche déjà utilisés sur le site. Ainsi, quand on réutilise le champ, différentes suggestions peuvent être affichées et utilisées. Voici l'aperçu de cette fonctionnalité sous Firefox :

Il est possible de fournir un texte indicatif dans le champ de recherche afin de fournir une indication quant aux recherches qu'il est possible de faire. Pour cela, on ajoutera un texte avec l'attribut placeholder. Par exemple :

<form>
  <div>
    <input type="search" id="maRecherche" name="q"
     placeholder="Rechercher sur le site…">
    <button>Rechercher</button>
  </div>
</form>

Voici le résultat obtenu avec ce fragment HTML :

Un des problèmes posé par les formulaires de recherche est leur accessibilité. En effet, dans la plupart des situations, il n'est pas nécessaire de fournir une étiquette indiquant le rôle de la recherche car le placement du champ rend son rôle clair (voici un exemple).

En revanche, pour les personnes qui utilisent des technologies assistives, cela peut être source de confusion. Une façon de résoudre ce problème sans modifier l'organisation visuelle est d'utiliser les fonctionnalités WAI-ARIA :

• Utiliser un attribut role avec la valeur search sur l'élément <form> permettra aux lecteurs d'écran d'indiquer le formulaire comme étant un formulaire de recherche.
• Si cela n'est pas suffisant, il est possible d'utiliser l'attribut aria-label sur l'élément <input>. Cet attribut peut contenir un texte descriptif qui sera lu à voix haute par un lecteur d'écran. Il s'agit d'un équivalent non-visuel de <label>.

Prenons un exemple :

<form role="search">
  <div>
    <input type="search" id="maRecherche" name="q"
     placeholder="Rechercher sur le site…"
     aria-label="Rechercher parmi le contenu du site">
    <button>Rechercher</button>
  </div>
</form>

Voici le résultat obtenu grâce à ce fragment de HTML :

Il n'y a aucune différence visuelle avec l'exemple précédent mais avec cette deuxième version, les personnes qui utilisent un lecteur d'écran disposeront de plus d'informations.

Il est possible de contrôler la taille physique du champ de saisie grâce à l'attribut size. Cet attribut permet d'indiquer le nombre de caractères qui peuvent être affichés simultanément à l'intérieur du champ. Ainsi, dans l'exemple qui suit, la zone de recherche peut contenir 20 caractères :

<form>
  <div>
    <input type="search" id="maRecherche" name="q"
    placeholder="Rechercher sur le site…" size="30">
    <button>Rechercher</button>
  </div>
</form>

Les éléments <input> de type search possèdent les mêmes fonctionnalités de validation que les éléments <input type="text">. Il existe peu de raison de contraindre les termes d'une recherche mais voici quelques cas.

Les pseudo-classes CSS :valid et :invalid permettent de mettre en forme les éléments d'un formulaire en fonction de la validité de leur contenu. Dans cette section, nous utiliserons la feuille de style suivante afin de placer une coche à côté des champs valides et une croix à côté des champs invalides.

input:invalid ~ span:after {
  content: '✖';
  padding-left: 5px;
  position: absolute;
}

input:valid ~ span:after {
  content: '✓';
  padding-left: 5px;
  position: absolute
}

Vous pouvez ici voir qu'on utilise un élément <span> placé après l'élément du formulaire, c'est cet élément <span> qui contiendra les icônes. Cet élément est nécessaire car, sur certains navigateurs, les pseudo-classes dans les éléments de saisie sont mal gérées.

Il est possible d'utiliser l'attribut required afin d'indiquer que la valeur doit obligatoirement être saisie avant d'envoyer le formulaire :

<form>
  <div>
    <input type="search" id="maRecherche" name="q"
    placeholder="Recherche sur le site…" required>
    <button>Rechercher</button>
    <span class="validity"></span>
  </div>
</form>

Voici le résultat obtenu :

De plus, si on essaie d'envoyer le formulaire sans aucun terme de recherche, le navigateur affichera un message. Voici par exemple, le résultat dans Firefox :

Différents messages peuvent être affichés selon le type d'erreur liée à la saisie.

Il est possible d'indiquer une taille minimale pour la longueur des termes de la recherche via l'attribut minlength. De même, on peut fixer la longueur maximale du texte qui peut être saisi pour la recherche grâce à l'attribut maxlength. Ces deux attributs sont exprimés en nombres de caractères.

Dans l'exemple qui suit, la valeur saisie dans le champ de recherche doit mesurer entre 4 et 8 caractères.

<form>
  <div>
    <label for="mySearch">Rechercher un utilisateur</label>
    <input type="search" id="mySearch" name="q"
    placeholder="ID de 4 à 8 char." required
    size="30" minlength="4" maxlength="8">
    <button>Rechercher</button>
    <span class="validity"></span>
  </div>
</form>

Voici le résultat obtenu avec ce fragment de code HTML :

Si vous essayez de soumettre une valeur qui est plus petite que 4 caractères, vous aurez un message d'erreur (qui peut varier selon le navigateur utilisé). De plus, le navigateur ne permettra pas de saisir un texte plus long que 8 caractères.

L'attribut pattern permet d'indiquer une expression rationnelle que doit respecter la valeur saisie pour être considérée valide (cf. Valider une valeur avec une expression rationnelle pour une introduction).

Prenons un exemple. Imaginons qu'on veuille rechercher un produit grâce à son identifiant et que les identifiants commencent par deux lettres, suivies de 4 chiffres. Dans l'exemple qui suit, le formulaire n'accepte qu'une valeur dont la taille est comprise entre 4 et 8 caractères et qui commence par deux lettres puis termine par 4 chiffres.

<form>
  <div>
    <label for="mySearch">Rechercher un produit par son code :</label>
    <input type="search" id="mySearch" name="q"
    placeholder="2 lettres puis 4 chiffres" required
    size="30" pattern="[A-z]{2}[0-9]{4}">
    <button>Rechercher</button>
    <span class="validity"></span>
  </div>
</form>

Voici le résultat obtenu avec ce fragment HTML :

Vous pouvez consulter un exemple de formulaire de recherche dans notre exemple website-aria-roles (voir la démonstration live).

• Les formulaires HTML
• <input> et l'interface HTMLInputElement DOM qu'il implémente
• <input type="text">