Zone de texte
<gcds-textarea>

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

Une zone de texte est un espace permettant de saisir une réponse détaillée à une question ou à une directive.

• GitHub
• Figma

Sur cette page

• Codage et accessibilité des zones de texte
• Exemples
• Générateur de code

Codage et accessibilité des zones de texte

Appliquez les attributs requis

Pour que la zone de texte fonctionne correctement, utilisez toujours les attributs suivants avec <gcds-textarea>:

• name
• label
• textarea-id

Adaptez la zone de texte au type de réponse

• Utilisez des zones de texte pour les réponses qui peuvent nécessiter plus de 75 caractères.
• Faites en sorte que la hauteur d'une zone de texte soit proportionnelle à la quantité de texte que vous attendez de l'utilisateur·rice. Vous pouvez définir la hauteur d'une zone de texte en spécifiant l'attribut « rows ».
• Évitez de définir une largeur inférieure à 50 % (1/2 largeur).
• Utilisez le maximum 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.

Masquer l’étiquette de la zone de texte

• 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

label

L'attribut label définit l'étiquette de la zone de texte.

<gcds-textarea textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

name

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

<gcds-textarea textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

textarea-id

L'attribut textarea-id définit l'identifiant unique de la zone de texte.

<gcds-textarea textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

autofocus

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

<gcds-textarea autofocus textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

cols

L'attribut cols définit la largeur visible de la zone de texte en nombre de caractères moyens. La largeur minimale est de 50 % de son conteneur.

<gcds-textarea cols="8" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

disabled

L'attribut disabled contrôle si la zone de texte est désactivée ou non. Par défaut, il est défini à false.

<gcds-textarea disabled textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

error-message

L'attribut error-message définit le message d'erreur à afficher pour une zone de texte invalide.

<gcds-textarea error-message="Message d'erreur" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

form

L'attribut form définit l'identifiant du formulaire auquel appartient la zone de texte.

<gcds-textarea form="form-id" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

hide-label

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

<gcds-textarea hide-label textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

hide-limit

L'attribut hide-limit contrôle si le compteur de limite de caractères est affiché ou non. Lorsqu'il est défini à true, le compteur n'est pas affiché. Par défaut, il est défini à false.

<gcds-textarea hide-limit maxlength="20" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

hint

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

<gcds-textarea hint="Texte explicatif / Exemple de message." textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

maxlength

L'attribut maxlength définit le nombre maximum de caractères acceptés par la zone de texte.

<gcds-textarea maxlength="10" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

minlength

L'attribut minlength définit le nombre minimum de caractères acceptés par la zone de texte.

<gcds-textarea minlength="5" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

required

L'attribut required contrôle si la zone de texte 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-textarea required textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

rows

L'attribut rows définit le nombre de lignes visibles dans la zone de texte, ce qui détermine sa hauteur.

<gcds-textarea rows="3" textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

validate-on

L'attribut validate-on définit l'événement de validation pour la zone de texte.

<gcds-textarea validate-on="other" required textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

value

L'attribut value définit le contenu initial de la zone de texte. Il se met à jour pour refléter la valeur saisie par l'utilisateur.

<gcds-textarea value="Contenu de la zone de texte." textarea-id="textarea-example" label="Libellé de champ" name="textarea-example">
</gcds-textarea>

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.