Path: blob/main/files/en-us/web/html/element/abbr/index.md
6532 views
------{{HTMLSidebar}}
The <abbr> HTML element represents an abbreviation or acronym.
When including an abbreviation or acronym, provide a full expansion of the term in plain text on first use, along with the <abbr> to mark up the abbreviation. This informs the user what the abbreviation or acronym means.
The optional {{htmlattrxref("title")}} attribute can provide an expansion for the abbreviation or acronym when a full expansion is not present. This provides a hint to user agents on how to announce/display the content while informing all users what the abbreviation means. If present, title must contain this full description and nothing else.
{{EmbedInteractiveExample("pages/tabbed/abbr.html", "tabbed-shorter")}}
Attributes
This element only supports the global attributes. The {{htmlattrxref("title")}} attribute has a specific semantic meaning when used with the <abbr> element; it must contain a full human-readable description or expansion of the abbreviation. This text is often presented by browsers as a tooltip when the mouse cursor is hovered over the element.
Each <abbr> element you use is independent of all others; providing a title for one does not automatically attach the same expansion text to others with the same content text.
Usage notes
Typical use cases
It's certainly not required that all abbreviations be marked up using <abbr>. There are, though, a few cases where it's helpful to do so:
When an abbreviation is used and you want to provide an expansion or definition outside the flow of the document's content, use
<abbr>with an appropriate {{htmlattrxref("title")}}.To define an abbreviation which may be unfamiliar to the reader, present the term using
<abbr>and inline text providing the definition. Include atitleattribute only when the inline expansion or definition is not available.When an abbreviation's presence in the text needs to be semantically noted, the
<abbr>element is useful. This can be used, in turn, for styling or scripting purposes.You can use
<abbr>in concert with {{HTMLElement("dfn")}} to establish definitions for terms which are abbreviations or acronyms. See the example Defining an abbreviation below.
Grammar considerations
In languages with grammatical number (that is, languages where the number of items affects the grammar of a sentence), use the same grammatical number in your title attribute as inside your <abbr> element. This is especially important in languages with more than two numbers, such as Arabic, but is also relevant in English.
Default styling
The purpose of this element is purely for the convenience of the author and all browsers display it inline ({{cssxref('display')}}: inline) by default, though its default styling varies from one browser to another:
Some browsers add a dotted underline to the content of the element. Others add a dotted underline while converting the contents to small caps. Others may not style it differently than a {{HTMLElement("span")}} element. To control this styling, use {{cssxref('text-decoration')}} and {{cssxref('font-variant')}}.
Examples
Marking up an abbreviation semantically
To mark up an abbreviation without providing an expansion or description, use <abbr> without any attributes, as seen in this example.
HTML
Result
{{EmbedLiveSample("Marking_up_an_abbreviation_semantically")}}
Styling abbreviations
You can use CSS to set a custom style to be used for abbreviations, as seen in this simple example.
HTML
CSS
Result
{{EmbedLiveSample("Styling_abbreviations")}}
Providing an expansion
Adding a {{htmlattrxref("title")}} attribute lets you provide an expansion or definition for the abbreviation or acronym.
HTML
Result
{{EmbedLiveSample("Providing_an_expansion")}}
Defining an abbreviation
You can use <abbr> in tandem with {{HTMLElement("dfn")}} to more formally define an abbreviation, as shown here.
HTML
Result
{{EmbedLiveSample("Defining_an_abbreviation", 600, 120)}}
Accessibility concerns
Spelling out the acronym or abbreviation in full the first time it is used on a page is beneficial for helping people understand it, especially if the content is technical or industry jargon.
Only include a title if expanding the abbreviation or acronym in the text is not possible. Having a difference between the announced word or phrase and what is displayed on the screen, especially if it's technical jargon the reader may not be familiar with, can be jarring.
Example
This is especially helpful for people who are unfamiliar with the terminology or concepts discussed in the content, people who are new to the language, and people with cognitive concerns.
Technical summary
| Content categories | Flow content, phrasing content, palpable content |
|---|---|
| Permitted content | Phrasing content |
| Tag omission | {{no_tag_omission}} |
| Permitted parents | Any element that accepts phrasing content |
| Implicit ARIA role | No corresponding role |
| Permitted ARIA roles | Any |
| DOM Interface | {{domxref("HTMLElement")}} |
Specifications
{{Specifications}}
Browser compatibility
{{Compat}}