Skip to content

Commit 6b0d6ed

Browse files
committed
docs: 📝 ajoute la doc de DsfrTag
1 parent 2aa6a5e commit 6b0d6ed

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

src/components/DsfrTag/DsfrTag.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Tag - `DsfrTag`
2+
3+
## 🌟 Introduction
4+
5+
Le tag catégorise/classe/organise les contenus à l'aide de mots-clés. Il aide les utilisateurs à rechercher et à trouver facilement une information.
6+
7+
Le tag peut être utilisé dans deux contextes :
8+
9+
- Dans le contenu (carte, en-tête, liste) : il catégorise le contenu auquel il est apposé. Il peut être cliquable ou non cliquable ;
10+
11+
- En tant que filtre (dans une page de résultats de recherche par exemple). Dans ce cas il peut-être :
12+
13+
- activable comme filtre en place à sélectionner/désélectionner ;
14+
- supprimable, il sert de rappel à un filtre qui a été coché dans une sidebar ou une liste déroulante.
15+
16+
🏅 La documentation sur l’alerte sur le [DSFR](https://www.systeme-de-design.gouv.fr/elements-d-interface/composants/tag)
17+
18+
<VIcon name="vi-file-type-storybook" /> La story sur l’alerte sur le storybook de [VueDsfr](https://vue-dsfr.netlify.app/?path=/docs/composants-dsfrtags--docs)
19+
20+
## 📐 Structure
21+
22+
Il se compose des éléments suivants :
23+
24+
- un libellé obligatoire : soit en utilisant la prop `label` soit en utilisant le slot par défaut ;
25+
- une icône optionnelle : avec la prop `icon` qui peut être soit le nom d’une classe correspondant à une icône du DSFR (elle commence par `'fr-icon-'`), soit le nom d’une icône de `oh-vue-icons` (il faut qu’elle soit enregistrée au préalable, cf. la [documentation sur les icônes](/icones)).

0 commit comments

Comments
 (0)