Skip to content

Commit

Permalink
docs: update title props description to explain usage (#473)
Browse files Browse the repository at this point in the history
* docs: update title props description to explain usage

* docs: update title props description to explain usage
  • Loading branch information
melaniebmn authored Feb 6, 2025
1 parent 035ab60 commit ced0997
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/en/components/card/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion src/en/components/notice/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}

Expand Down
12 changes: 6 additions & 6 deletions src/fr/composants/avis/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@ date: "git Last Modified"

## Créer un avis

Utilisez le composant davis pour transmettre aux gens des messages importants et propres au contexte. Lavis communique divers niveaux durgence et différents messages à laide 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 davis
### Définir le type d'avis

Utilisez lattribut `type` pour classer lavis dans les catégories `info` (Information), `warning` (Avertissement), `danger` (Danger) ou `success` (Succès). Ce choix détermine le style visuel de lavis et communique lurgence ou limportance 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 len-tête de lavis
### Précisez le titre et le niveau de l'en-tête de l'avis

- Utilisez lattribut `notice-title` pour créer un titre clair et informatif pour lavis. Veillez à ce que le titre transmette lobjectif 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 dassistance.
- 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" %}

Expand Down
2 changes: 1 addition & 1 deletion src/fr/composants/carte/code.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit ced0997

Please sign in to comment.