Skip to main content

Abbreviation

The abbreviation component displays abbreviated text or acronyms, revealing their full meaning through a tooltip on hover or focus. Use abbreviation to clarify shortened terms, initialisms, or technical language without interrupting the reading flow.

Abbreviations improve accessibility by providing expanded text for screen readers and visual tooltips for sighted customers. For general inline text styling, use text.

Support
Targets (24)

Configure the following properties on the abbreviation component.

string

A unique identifier for the element. Use this to reference the element in JavaScript, link labels to form controls, or target specific elements for styling or scripting.

Anchor to title
title
string
Default: ''

Defines the full expansion of the abbreviation or acronym. Helps user agents and users understand the meaning of the abbreviated text.

Learn more about the abbreviation element.


Anchor to Display an abbreviationDisplay an abbreviation

Define a currency abbreviation with a full-text expansion on hover. This example displays USD inside an s-abbreviation element with the title attribute set to "United States Dollar."

Display an abbreviation

An abbreviated text element with a dotted underline indicating a tooltip is available on hover.

html

<s-abbreviation title="United States Dollar">USD</s-abbreviation>

  • Set a descriptive title: Provide a title attribute that spells out the full term so hover and assistive-tech users get the expanded meaning.
  • Use for genuine abbreviations only: Reserve s-abbreviation for shortened terms, acronyms, or initialisms. For general tooltips, use tooltip.
  • Keep abbreviation text short: Limit the visible text to the actual abbreviated form so the tooltip provides real added value.

Was this page helpful?