Cases à cocher
<gcds-checkboxes>

Autres noms : liste de contrôle, liste de vérification.

Les cases à cocher offrent un ensemble d'options pour les réponses multiples.

• GitHub
• Figma

Codage et accessibilité des icônes

Appliquer les attributs requis

Pour que les cases à cocher fonctionnent correctement, utilisez toujours les attributs suivants avec gcds-checkbox :

• name
• options

Utiliser l'attribut options avec les cases à cocher

L'attribut options utilise un tableau d'objets pour rendre chaque case à cocher. Voici en exemple l'un de ces objets :

{
  'id'!: '',
  'label'!: '',
  'value'?: '',
  'checked'?: '',
  'hint'?: '',
}

À l'intérieur de l'attribut options, utilisez toujours les propriétés id et label de l'objet pour chaque case à cocher. Les autres propriétés sont facultatives.

Utiliser l'attribut value

• L'attribut value fournit une référence rapide aux valeurs des cases cochées à l'intérieur du composant gcds-checkboxes.
• L'attribut value est formaté comme un tableau de chaînes. Exemple : [“checkboxOneValue”, checkboxTwoValue”]

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.

Pour un groupe de cases à cocher

• Utilisez l'attribut legend lorsque vous passez plus d'un objet à l'attribut options. Lorsqu'il y a plus d'une case à cocher, il faut définir l'attribut legend pour que le composant gcds-checkboxes puisse afficher son rendu.
• Utilisez les attributs hint et error-message pour ajouter des renseignements supplémentaires au jeu de champs intégré à gcds-checkboxes.

Pour une seule case à cocher

• Passez un seul objet à l'attribut options pour afficher une seule case à cocher sans jeu de champs.
• Utilisez les attributs hint et error-message pour ajouter des renseignements supplémentaires à la case à cocher.

Masquer la légende ou les étiquettes des cases à cocher

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

Obtenez votre 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.