Skip to content

Tag - DsfrTag

🌟 Introduction

Le tag catégorise/classe/organise les contenus à l'aide de mots-clés. Il aide les utilisateurs à rechercher et à trouver facilement une information.

Le tag peut être utilisé dans deux contextes :

  • Dans le contenu (carte, en-tête, liste) : il catégorise le contenu auquel il est apposé. Il peut être cliquable ou non cliquable ;

  • En tant que filtre (dans une page de résultats de recherche par exemple). Dans ce cas il peut-être :

    • activable comme filtre en place à sélectionner/désélectionner ;
    • supprimable, il sert de rappel à un filtre qui a été coché dans une sidebar ou une liste déroulante.

🏅 La documentation sur le tag sur le DSFR

La story sur le tag sur le storybook de VueDsfr

📐 Structure

Il se compose des éléments suivants :

  • un libellé obligatoire : soit en utilisant la prop label soit en utilisant le slot par défaut ;
  • 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).

🛠️ Props

NomTypeDéfautObligatoireDescription
labelStringundefinedLe texte affiché sur l'étiquette.
linkStringundefinedURL pour un lien externe. Détermine aussi le type de balise (a ou RouterLink).
tagNameString'p'Nom de la balise utilisée pour l'étiquette.
iconStringundefinedNom de l'icône (depuis OhVueIcon) à afficher sur l'étiquette.
disabledBooleanfalseDésactive l'étiquette si elle est un bouton.
smallBooleanfalseRéduit la taille de l'étiquette.
iconOnlyBooleanfalseAffiche uniquement l'icône, sans texte.

📡 Évenements

Pas d'événements personnalisés pour ce composant. Il se repose sur les événements natifs de ses balises sous-jacentes.

🧩 Slots

NomDescription
defaultSlot par défaut pour ajouter du contenu supplémentaire à côté du label ou de l'icône.

📝 Exemples

  1. Étiquette Basique :
html
<DsfrTag label="Bonjour VueDsfr !" />

Affiche une simple étiquette avec le texte "Bonjour VueDsfr !".

  1. Étiquette avec icône :
html
<DsfrTag label="Vue Power" icon="fr-icon-success-line" />