From ced09971a1735516da4932e7a92e694324ba7aa7 Mon Sep 17 00:00:00 2001 From: Melanie Boeckmann Date: Thu, 6 Feb 2025 08:30:32 -0800 Subject: [PATCH] docs: update title props description to explain usage (#473) * docs: update title props description to explain usage * docs: update title props description to explain usage --- src/en/components/card/code.md | 2 +- src/en/components/notice/code.md | 2 +- src/fr/composants/avis/code.md | 12 ++++++------ src/fr/composants/carte/code.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/en/components/card/code.md b/src/en/components/card/code.md index 0c3be7095..ebcbd28d8 100644 --- a/src/en/components/card/code.md +++ b/src/en/components/card/code.md @@ -16,7 +16,7 @@ Use the `card-title` attribute to add a short and descriptive title to the card. ### Select the correct heading level -Set the `card-title-tag` to define the correct heading level for the card title. Follow a correct and orderly heading hierarchy to make it equal for people who use assistive technologies. +Set the `card-title-tag` to define the [correct heading level](/en/components/heading/design/#order-heading-levels-hierarchically) for the card title. While the font size remains the same regardless of the tag, setting the correct heading level maintains proper hierarchy and accessibility for assistive technologies. ### Add a `description` to provide more information diff --git a/src/en/components/notice/code.md b/src/en/components/notice/code.md index 59dfa92c1..7aef3c5b9 100644 --- a/src/en/components/notice/code.md +++ b/src/en/components/notice/code.md @@ -19,7 +19,7 @@ Use the `type` attribute to categorize the notice as `info`, `warning`, `danger` ### Specify the notice title and heading level - Use the `notice-title` attribute to create a clear and informative heading for the notice. Ensure the title conveys the message’s purpose. -- Set the `notice-title-tag` to define the [correct heading level](/en/components/heading/design/#order-heading-levels-hierarchically) for the notice title. Follow a correct and orderly heading hierarchy to make it equal for people who use assistive technologies. +- Set the `notice-title-tag` to define the [correct heading level](/en/components/heading/design/#order-heading-levels-hierarchically) for the notice title. While the font size remains the same regardless of the tag, setting the correct heading level maintains proper hierarchy and accessibility for assistive technologies. {% include "partials/getcode.njk" %} diff --git a/src/fr/composants/avis/code.md b/src/fr/composants/avis/code.md index 3ae6a5b43..e602edbfe 100644 --- a/src/fr/composants/avis/code.md +++ b/src/fr/composants/avis/code.md @@ -8,18 +8,18 @@ date: "git Last Modified" ## Créer un avis -Utilisez le composant d’avis pour transmettre aux gens des messages importants et propres au contexte. L’avis communique divers niveaux d’urgence et différents messages à l’aide de contenu et d’éléments visuels. +Utilisez le composant d'avis pour transmettre aux gens des messages importants et propres au contexte. L'avis communique divers niveaux d'urgence et différents messages à l'aide de contenu et d'éléments visuels. ## Accessibilité et lignes directrices relatives au code -### Définir le type d’avis +### Définir le type d'avis -Utilisez l’attribut `type` pour classer l’avis dans les catégories `info` (Information), `warning` (Avertissement), `danger` (Danger) ou `success` (Succès). Ce choix détermine le style visuel de l’avis et communique l’urgence ou l’importance du message au public. +Utilisez l'attribut `type` pour classer l'avis dans les catégories `info` (Information), `warning` (Avertissement), `danger` (Danger) ou `success` (Succès). Ce choix détermine le style visuel de l'avis et communique l'urgence ou l'importance du message au public. -### Précisez le titre et le niveau de l’en-tête de l’avis +### Précisez le titre et le niveau de l'en-tête de l'avis -- Utilisez l’attribut `notice-title` pour créer un titre clair et informatif pour l’avis. Veillez à ce que le titre transmette l’objectif du message. -- Utilisez `notice-title-tag` pour définir [le bon niveau](/fr/composants/titre/design/#classez-les-niveaux-de-titre-de-maniere-hierarchique) de titre pour l'avis. Suivez une hiérarchie correcte et ordonnée pour fournir une expérience équitable aux personnes utilisant des technologies d’assistance. +- Utilisez l'attribut `notice-title` pour créer un titre clair et informatif pour l'avis. Veillez à ce que le titre transmette l'objectif du message. +- Utilisez `notice-title-tag` pour définir [le bon niveau](/fr/composants/titre/design/#classez-les-niveaux-de-titre-de-maniere-hierarchique) de titre pour l'avis. La définition du niveau adapté pour le titre n'a pas d'incidence sur la taille de la police, mais elle permet de maintenir la bonne hiérarchie et l'accessibilité pour les technologies d'assistance. {% include "partials/getcode.njk" %} diff --git a/src/fr/composants/carte/code.md b/src/fr/composants/carte/code.md index 20b1fa21c..4ae3a6c3d 100644 --- a/src/fr/composants/carte/code.md +++ b/src/fr/composants/carte/code.md @@ -18,7 +18,7 @@ Utilisez l'attribut `card-title` pour ajouter un titre court et descriptif à la ### Sélectionnez le bon niveau de titre -Utilisez `card-title-tag` pour définir le bon niveau de titre pour la carte. Suivez une hiérarchie correcte et ordonnée pour fournir une expérience équitable aux personnes utilisant des technologies d'assistance. +Utilisez `card-title-tag` pour définir [le bon niveau](/fr/composants/titre/design/#classez-les-niveaux-de-titre-de-maniere-hierarchique) de titre pour la carte. La définition du niveau adapté pour le titre n'a pas d'incidence sur la taille de la police, mais elle permet de maintenir la bonne hiérarchie et l'accessibilité pour les technologies d'assistance. ### Ajoutez une `description` pour fournir plus d'informations