Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

<kbd> : l'élément de saisie clavier

Baseline Widely available

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis ⁨juillet 2015⁩.

L'élément HTML <kbd> représente une portion de texte en ligne désignant une saisie de texte de l'utilisateur·ice à partir d'un clavier, d'une commande vocale ou de tout autre dispositif de saisie de texte. Par convention, l'agent utilisateur affiche le contenu d'un élément <kbd> en utilisant sa police monospace par défaut, bien que cela ne soit pas imposé par la norme HTML.

Exemple interactif

<p>
  Veuillez appuyer sur <kbd>Ctrl</kbd> + <kbd>Maj</kbd> + <kbd>R</kbd> pour
  réactualiser une page MDN.
</p>
kbd {
  background-color: #eeeeee;
  border-radius: 3px;
  border: 1px solid #b4b4b4;
  box-shadow:
    0 1px 1px rgb(0 0 0 / 0.2),
    0 2px 0 0 rgb(255 255 255 / 0.7) inset;
  color: #333333;
  display: inline-block;
  font-size: 0.85em;
  font-weight: bold;
  line-height: 1;
  padding: 2px 4px;
  white-space: nowrap;
}

<kbd> peut être imbriqué de différentes façons avec l'élément HTML <samp> (résultat d'exemple) pour représenter diverses formes de saisie ou de sortie selon les indices visuels.

Attributs

Cet élément inclut uniquement les attributs universels.

Notes d'utilisation

D'autres éléments peuvent être utilisés en association avec <kbd> afin de représenter certains scénarios plus spécifiques :

  • Imbriquer un élément <kbd> dans un autre élément <kbd> représente une touche ou une unité de saisie au sein d'une saisie plus grande. Cf. Représenter les frappes de touches dans une saisie ci-après.
  • Imbriquer un élément <kbd> dans un élément <samp> permet d'indiquer que la saisie a été restituée (echo) à l'utilisateur·ice. Cf. Saisie restituée, ci-après.
  • Imbriquer un élément <samp> dans un élément <kbd> permet de représenter des saisies basées sur le texte présenté par le système (cela peut être le nom de menus, d'éléments de menu ou le nom de bouttons affichés à l'écran). Cf. Représenter les options de saisies à l'écran ci-après.

Note : Il est possible de définir un style pour surcharger la mise en forme par défaut du navigateur pour l'élément <kbd>. À ce titre, on gardera à l'esprit que les préférences et feuilles de style de l'utilisateur·ice peuvent surcharger la mise en forme du site.

Exemples

Exemple simple

html
<p>
  Utilisez la commande <kbd>help macommande</kbd> afin de consulter la
  documentation pour la commande "macommande".
</p>

Résultat

Représenter les frappes de touches dans une saisie

Afin de décrire une saisie constituée de plusieurs touches, on imbriquera plusieurs élément <kbd> dans un élément <kbd> englobant qui représente la saisie dans son ensemble. Chaque frappe clavier qui le constitue sera représentée par son propre élément <kbd>.

Sans mise en forme

Commençons par analyser le code HTML.

HTML
html
<p>
  Vous pouvez également créer un nouveau document en utilisant le raccourci
  clavier
  <kbd><kbd>Ctrl</kbd>+<kbd>N</kbd></kbd
  >.
</p>

On voit ici que l'ensemble de la combinaison de touches est contenue dans un élément <kbd> et que chaque touche possèe son propre élément.

Note : Il n'est pas nécessaire d'imbriquer tous ces éléments ; vous pouvez choisir de simplifier en omettant l'élément <kbd> externe. En d'autres termes, simplifier ceci en <kbd>Ctrl</kbd>+<kbd>N</kbd> serait parfaitement valide.

Cependant, selon votre feuille de style, il peut être utile d'utiliser ce type d'imbrication.

Résultat

Sans mise en forme particulière, voici le résultat obtenu :

Avec mise en forme

On peut alors ajouter un peu de CSS :

CSS

On ajoute un règle pour les les éléments <kbd> avec la classe "key" afin de représenter les touches d'un clavier :

css
kbd > kbd {
  border-radius: 3px;
  padding: 1px 2px 0;
  border: 1px solid black;
}
HTML

On met à jour le code HTML afin d'utiliser cette classe :

html
<p>
  Vous pouvez également créer un nouveau document en utilisant le raccourci
  clavier <kbd><kbd>Ctrl</kbd>+<kbd>N</kbd></kbd
  >.
</p>
Résultat

Saisie restituée

En imbriquant un élément <kbd> dans un élément <samp>, on peut représenter une saisie qui est restituée à l'utilisateur (à la façon d'un écho).

HTML

html
<p>
  S'il se produit une erreur de syntaxe, cet outil affichera la commande
  initialement saisie pour que vous la revoyez&nbsp;:
</p>
<blockquote>
  <samp><kbd>custom-git ad mon-nouveau-fichier.cpp</kbd></samp>
</blockquote>

Résultat

Représenter les options de saisies à l'écran

Imbriquer un élément <samp> dans un élément <kbd> représente une saisie basée sur du texte affiché par le système (par exemple des noms de menu, d'éléments de menu, des noms de boutons affichés à l'écran, etc.).

HTML

Ainsi, si on souhaite expliquer comment choisir l'option "Nouveau document" dans le menu "Fichier" avec un document HTML, on pourra écrire :

html
<p>
  Pour créer un nouveau fichier, sélectionner l'option
  <kbd
    ><kbd><samp>Fichier</samp></kbd
    >⇒<kbd><samp>Nouveau document</samp></kbd></kbd
  >
  dans le menu.
</p>

<p>
  N'oubliez pas de cliquer sur le bouton
  <kbd><samp>OK</samp></kbd> afin de confirmer que vous avez saisi le nom du
  nouveau fichier.
</p>

On voit ici différentes imbrications. La description de l'option du menu est incluse dans un élément <kbd> qui contient le menu et le nom de l'élément du menu dans des éléments <kbd> et <samp>, indiquant que la saisie se fera par l'intermédiaire de quelque chose présenté à l'écran.

Résultat

Résumé technique

Catégories de contenu Contenu de flux, contenu phrasé, contenu tangible.
Contenu autorisé Contenu phrasé.
Omission de balises Aucune, la balise d'ouverture et la balise de fermeture sont obligatoires.
Parents autorisés Tout élément qui accepte du contenu phrasé.
Rôle ARIA implicite Pas de rôle correspondant (angl.)
Rôles ARIA autorisés Tous les rôles sont autorisés.
Interface DOM HTMLElement

Spécifications

Specification
HTML
# the-kbd-element

Compatibilité des navigateurs

Voir aussi