Champ de saisie
<gcds-input>

Autres noms : saisie de texte, zone d'entrée.

Un champ de saisie est un espace permettant de saisir une courte réponse à une question ou à une directive.

• GitHub
• Figma

Sur cette page

• Codage et accessibilité des champs de saisie
• Exemples
• Générateur de code

Codage et accessibilité des champs de saisie

Appliquez les attributs requis

Pour que le champ de saisie fonctionne correctement, utilisez toujours les attributs suivants avec <gcds-input>:

• name
• label
• input-id

Adaptez le champ de saisie au type de réponse

• Définissez l'attribut size pour les réponses dont vous connaissez la longueur précise (taille "50" = 50 caractères). Par exemple, 6 caractères pour un code postal ou 10 caractères pour un numéro de téléphone.
• Réglez la saisie de manière à ce qu'elle couvre presque tout le conteneur, par exemple à 90 %, lorsque vous ne savez pas la longueur exacte de la réponse.
• Utilisez le maximum de 75 caractères pour les réponses sans longueur fixe.

Traiter les messages d'erreur et la validation

• Utilisez l'attribut required pour activer le valideur de champ obligatoire. La validation s'effectuera par défaut pendant l'évènement onBlur. Une réponse manquante ou non valide affichera un message d'erreur intercalé prédéfini.

• Si vous devez modifier l'évènement de validation, utilisez l'attribut validate-on. La validation peut se produire pendant l'évènement onBlur, lorsque l'élément perd son état ciblé, ou de façon manuelle avec la méthode validate().

• Utilisez l'attribut required pour les champs qui doivent obligatoirement être remplis. La mention « obligatoire » sera alors ajoutée à la fin de l'étiquette.

• Utilisez l'attribut error-message pour inclure un message d'erreur pour tous les champs de saisie obligatoires. Évitez d'utiliser des messages d'erreur pour les champs de saisie facultatifs.

• Pour les champs facultatifs, évitez d'ajouter l'attribut error-message.

• Pour un champ facultatif nécessitant une validation qui dépend de ce que l'utilisateur a saisi (par exemple pour valider un format d'adresse courriel), ajoutez plutôt une validation et un message d'erreur personnalisés.

Ajouter un texte explicatif pour favoriser la réussite des tâches

• Utilisez l'attribut hint pour ajouter un texte explicatif qui aidera la personne à fournir une valeur complète dans le champ de saisie, évitant ainsi d'obtenir un état d'erreur.

• Évitez d'ajouter un texte explicatif directement dans le champ (ce qu'on appelle aussi du texte fictif) qui disparaîtra une fois que le champ est sélectionné ou qu'une réponse commence à être saisie.

Utiliser l’attribut inputmode

• Utilisez l’attribut inputmode pour suggérer un clavier virtuel approprié sur les appareils mobiles, sans modifier la façon dont la valeur est validée.
• Utilisez inputmode=”numeric” avec type=”text” pour les nombres ne pouvant pas être incrémentés, tels que les numéros de compte, les numéros de carte de crédit ou les codes d’authentification. Le clavier numérique s’ouvrira sur les appareils mobiles.

Masquer l’étiquette du champ de saisie

• Définissez l’attribut hide-label à true afin de masquer visuellement l’étiquette, tout en la conservant pour les technologies d’assistance.
• Évitez d’ajouter du texte explicatif lorsque vous masquez l’étiquette. Vous pouvez également fournir une chaîne vide pour le texte explicatif.

Dans cette section

• Attributs essentiels
• Attributs facultatifs

input-id

L'attribut input-id définit l'identifiant unique du champ de saisie.

<gcds-input input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

label

L'attribut label définit l'étiquette du champ de saisie.

<gcds-input input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

name

L'attribut name identifie le champ de saisie dans le formulaire. Il permet de récupérer la valeur saisie après la soumission.

<gcds-input input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

autocomplete

L'attribut autocomplete contrôle si le navigateur peut suggérer des valeurs précédemment saisies pour le champ.

<gcds-input autocomplete="given-name" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

autofocus

L'attribut autofocus contrôle si le champ de saisie est ciblé automatiquement au chargement de la page. Par défaut, il est défini à false. Lorsqu'il est défini à true, le champ est ciblé à l'affichage.

<gcds-input autofocus input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

disabled

L'attribut disabled contrôle si le champ de saisie est désactivé ou non. Par défaut, il est défini à false.

<gcds-input disabled input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

error-message

L'attribut error-message définit le message d'erreur à afficher pour un champ invalide.

<gcds-input error-message="Message d'erreur" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

form

L'attribut form définit l'identifiant du formulaire auquel appartient le champ de saisie.

<gcds-input form="form-id" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

hide-label

L'attribut hide-label contrôle si l'étiquette est masquée ou non.

<gcds-input hide-label input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

hint

L'attribut hint définit le texte explicatif affiché sous l'étiquette.

<gcds-input hint="Texte explicatif / Exemple de message." input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

inputmode

L'attribut inputmode définit l'apparence du clavier virtuel sur les appareils mobiles. Les options sont :

• decimal
• email
• none
• numeric
• search
• tel
• text
• url

<gcds-input inputmode="numeric" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

max

L'attribut max définit la valeur maximale acceptée par le champ. Il s'applique uniquement au type de saisie numérique.

<gcds-input max="100" type="number" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

maxlength

L'attribut maxlength définit le nombre maximum de caractères acceptés par le champ de saisie.

<gcds-input maxlength="10" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

min

L'attribut min définit la valeur minimale acceptée par le champ de saisie. Il s'applique uniquement au type de saisie numérique.

<gcds-input min="22" type="number" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

minlength

L'attribut minlength définit le nombre minimum de caractères acceptés par le champ de saisie.

<gcds-input minlength="5" type="number" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

pattern

L'attribut pattern définit l'expression régulière à laquelle la valeur du champ doit correspondre.

<gcds-input pattern="[A-Z]+" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

readonly

L'attribut readonly contrôle si le champ peut être modifié ou non. Lorsqu'il est défini à true, le champ est en lecture seule.

<gcds-input readonly value="Readonly" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

required

L'attribut required contrôle si le champ de saisie est obligatoire ou non. Lorsqu'il est défini à true, il ajoute « obligatoire » après l'étiquette et active le validateur de champ obligatoire.

<gcds-input required input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

size

L'attribut size définit la taille du champ de saisie pour indiquer visuellement la longueur de texte attendue.

<gcds-input size="6" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

step

L'attribut step définit la granularité à laquelle la valeur doit se conformer. Utilisez-le avec le type de saisie numérique.

<gcds-input step="10" type="number" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

suggestions

L'attribut suggestions définit un tableau (array) d'options de suggestions.

<gcds-input suggestions='[{ "label": "Suggestion A"}, { "label": "Suggestion B"}, { "label": "Suggestion C"}]' input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

type

L'attribut type définit le type de saisie. Les options sont :

• email
• number
• password
• search
• tel
• text
• url

<gcds-input type="email" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

validate-on

L'attribut validate-on définit l'événement de validation pour le champ de saisie.

<gcds-input validate-on="other" required input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

value

L'attribut value définit la valeur initiale affichée dans le champ de saisie. Il reflète la valeur actuelle au fil des modifications de l'utilisateur.

<gcds-input value="Texte" input-id="input-example" label="Étiquette de champ" name="input-example">
</gcds-input>

Générateur de code

Générez une version du composant dont vous avez besoin en sélectionnant les propriétés de code correspondantes ou explorez les possibilités en choisissant différentes valeurs de code.

1. Choisissez des valeurs de code pour obtenir l'élément que vous voulez.

2. Obtenez le code et intégrez-le dans votre environnement.

3. Ajoutez tout contenu nécessaire au composant (comme le texte du libellé).

Remarque : Conformément à la pratique courante, le générateur de code utilise l'anglais pour tous les éléments de code.