HTML <kbd> Tag

The HTML <kbd> tag represents user input. For example, text that the user should enter into their computer/device.

Note that the <kbd> tag is not to be confused with the <input> tag (which creates a form control for the user to provide input). The <kbd> tag is used when a document simply needs to display text that the user should enter into their keyboard (for any number of reasons). For example, the <kbd> tag could be used in a list of instructions for connecting to a network from your computer.

Syntax

The <kbd> tag is written as <kbd></kbd> with the user input text enclosed between the start and end tags.

Like this:

Examples

Basic tag usage

Nesting <kbd> & <samp> Tags

You can use the <kbd> tag along with the <samp> tag to represent both user input and sample output.

For example, in a list of instructions, you could instruct the user to click a button. The action of clicking is user input and therefore requires the <kbd> tag. The name of the button is sample output and therefore requires the <samp> tag.

Actually, the HTML5 specifications states that in this case, it would require two <kbd> elements (one nested inside the other), because it represents an actual key or other single unit of input.

However, the HTML5 specification says that such precision is optional, so the above example would be just as valid if you only used the <kbd> tag. Like this:

Attributes

Attributes can be added to an HTML element to provide more information about how the element should appear or behave.

There are 3 kinds of attributes that you can add to your HTML tags: Element-specific, global, and event handler content attributes.

The <kbd> element accepts the following attributes.

Element-Specific Attributes

This table shows the attributes that are specific to the <kbd> tag/element.

AttributeDescription
None 

Global Attributes

The following attributes are standard across all HTML5 elements. Therefore, you can use these attributes with the <kbd> tag , as well as with all other HTML tags.

For a full explanation of these attributes, see HTML 5 global attributes.

Event Handler Content Attributes

Event handler content attributes enable you to invoke a script from within your HTML. The script is invoked when a certain "event" occurs. Each event handler content attribute deals with a different event.

Below are the standard HTML5 event handler content attributes.

Again, you can use any of these with the <kbd> element, as well as any other HTML5 element.

For a full explanation of these attributes, see HTML 5 event handler content attributes.

Differences Between HTML 4 & HTML 5

None.

To see more detail on the two versions see HTML5 <kbd> Tag and HTML4 <kbd> Tag. Also check out the links to the official specifications below.

Template

Here's a template for the <kbd> tag with all available attributes for the tag (based on HTML5). These are grouped into attribute types, each type separated by a space. In many cases, you will probably only need one or two (if any) attributes. Simply remove the attributes you don't need.

Note that the <kbd> element does not actually have any local attributes (i.e. attributes that are specific to the element), but the following global attributes and event handlers are available to the element (and all other HTML elements).

For more information on attributes for this tag, see HTML5 <kbd> Tag and HTML4 <kbd> Tag.

Tag Details

For more details about the <kbd> tag, see HTML5 <kbd> Tag and HTML4 <kbd> Tag.

Specifications

Here are the official specifications for the <kbd> element.

What's the Difference?

W3C creates "snapshot" specifications that don't change once defined. So the HTML5 specification won't change once it becomes an official recommendation. WHATWG on the other hand, develops a "living standard" that is updated on a regular basis. In general, you will probably find that the HTML living standard will be more closely aligned to the current W3C draft than to the HTML5 specification.

Related