Skip to content

Abbreviation

Gives a term a one-line explanation the reader can open with a mouse, the keyboard or a tap.

Use it for an acronym or a term the reader may not know, where one line is enough. Write the full form in the prose the first time as well; the tip reminds, it does not define. Leave out terms the reader uses every day, because a page full of dotted underlines is noise.

When the explanation needs links or more than one sentence, use a footnote.

Astro can also render pages on request, which is :term[SSR]{note="Server-Side Rendering"}.

Only the places you mark get the underline; the same term elsewhere in the post stays plain.

The term, with a dotted hairline underline, and a tip on the inverse surface above it: dark on a light page, light on a dark one.

Closed, and open. It opens 120ms after a mouse rests on the term, at once on keyboard focus or a tap, and closes when the mouse leaves, focus moves on, Escape is pressed or the reader taps elsewhere. The tip fades in and out; with reduced motion it appears at once.

The term is a real <abbr> that takes keyboard focus, and the tip is linked to it with aria-describedby, so a screen reader reads the explanation after the term. The browser’s own title bubble is left off, because it would open on top of the tip and never opens for the keyboard or a tap.

Abbreviation.astro, which uses Tooltip.astro. It keeps the handoff’s props. The tap and the missing title are the two changes.

A footnote, for explanations that need more than one line.