<dl> : l'élément de liste de descriptions

L'élément HTML <dl> représente une liste de descriptions sous la forme d'une liste de paires associant des termes (fournis par des éléments <dt>) et leurs descriptions ou définitions (fournies par des éléments <dd>). On utilisera par exemple cet élément pour implémenter un glossaire.

Exemple interactif

Catégories de contenu Contenu de flux et, si les éléments enfants de <dl> incluent une paire avec un nom et une valeur, du contenu tangible.
Contenu autorisé

Zéro ou plusieurs groupes composés d'un ou plusieurs éléments <dt>, chacun suivi par un ou plusieurs éléments <dd> entre lesquels on pourra éventuellement avoir des éléments <script> et <template>.

Selon le WHATWG : un ou plusieurs éléments <div> éventuellement entrecoupés d'éléments <script> ou <template>.

Omission de balises Aucune, la balise d'ouverture et la balise de fermeture sont obligatoires.
Parents autorisés Tout élément acceptant du contenu de flux.
Rôle ARIA implicite Pas de rôle correspondant
Rôles ARIA autorisés group, list (en-US), none, presentation
Interface DOM HTMLDListElement (en-US)

Attributs

Cet élément inclut les attributs universels.

Exemples

Un seul terme et une seule définition

<dl>
  <dt>Firefox</dt>
  <dd>
    Un navigateur Web libre, open-source, multi-plateforme
    dévelopé par la Mozilla Corporation et des centaines de
    volontaires.
  </dd>
  <!-- D'autres termes et leurs descriptions -->
</dl>

Plusieurs termes avec une même définition

<dl>
  <dt>Firefox</dt>
  <dt>Mozilla Firefox</dt>
  <dt>Fx</dt>
  <dd>
    Un navigateur Web libre, open-source, multi-plateforme
    dévelopé par la Mozilla Corporation et des centaines de
    volontaires.
  </dd>
  <!-- D'autres termes et leurs définitions -->
</dl>

Un seul terme avec plusieurs définitions

<dl>
  <dt>Firefox</dt>
  <dd>
    Un navigateur Web libre, open-source, multi-plateforme
    dévelopé par la Mozilla Corporation et des centaines de
    volontaires.
  </dd>
  <dd>
    Le petit panda, panda roux, panda fuligineux ou panda
    éclatant (Ailurus fulgens), est un mammifère originaire
    de l'Himalaya et de la Chine méridionale.
  </dd>
  <!-- D'autres termes et leurs définitions -->
</dl>

Termes et descriptions multiples

Il est également possible de définir plusieurs termes avec plusieurs descriptions correspondantes, en combinant les exemples ci-dessus.

Métadonnées

Les listes de définitions sont utiles lorsqu'on souhaite afficher des métadonnées sous forme d'une liste de clés-valeurs.

<dl>
  <dt>Nom</dt>
  <dd>Godzilla</dd>
  <dt>Né le</dt>
  <dd>1952</dd>
  <dt>Lieu de naissance</dt>
  <dd>Japon</dd>
  <dt>Couleur</dt>
  <dd>Vert</dd>
</dl>

Conseil : il peut être pratique de définir un séparateur clé-valeur dans le CSS, par exemple :

dt::after {
  content: ": ";
}

Intégration de groupes nom-valeur dans les éléments <div>.

WHATWG HTML permet d'envelopper chaque groupe nom-valeur d'un élément <dl> dans un élément <div>. Cela peut être utile lors de l'utilisation de microdonnées, ou lorsque les attributs universels s'appliquent à un groupe entier, ou encore à des fins de style.

<dl>
  <div>
    <dt>Nom</dt>
    <dd>Godzilla</dd>
  </div>
  <div>
    <dt>Né le</dt>
    <dd>1952</dd>
  </div>
  <div>
    <dt>Lieu de naissance</dt>
    <dd>Japon</dd>
  </div>
  <div>
    <dt>Couleur</dt>
    <dd>Vert</dd>
  </div>
</dl>

Notes

Cet élément ne doit pas être utilisé (de même que les éléments <ul>), dans le seul but de créer une indentation sur la page. Bien que cela fonctionne parfaitement, c'est une pratique déconseillée qui mêle mise en forme et sémantique. Cela modifie le rôle que doivent avoir les listes de définitions.

Pour changer l'indentation de la définition d'un terme, il faut utiliser la propriété CSS margin.

Accessibilité

Les lecteurs d'écran annoncent <dl> de façon différente. À partir d'iOS 14, VoiceOver annoncera que le contenu de <dl> est une liste lors de la navigation au curseur (mais pas via la lecture générale). Il faut donc s'assurer que la relation entre les éléments de la liste est bien communiquée grâce aux contenus des éléments.

Spécifications

Specification
HTML Standard
# the-dl-element

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi