Add tooltips built entirely in CSS to nearly any element.
Tooltips as a UI pattern should be our last resort for conveying information because it is hidden by default and often with zero or little visual indicator of its existence.
Before adding a tooltip, please consider: Is this information essential and necessary* Can the UI be made clearer? Can the information be shown on the page by default?
Attention: we use
aria-label for tooltip contents, because it is crucial that they are accessible to screen reader users. However,
aria-label replaces the text content of an element in screen readers, so only use
.tooltipped on elements with no existing text content, or consider using
title for supplemental information.
Note: Tooltip classes will conflict with Octicon styles, and as such, must be applied to the parent element instead of the icon.
Specify the direction of a tooltip with north, south, east, and west directions:
Align tooltips to the left or right of an element, combined with a directional class to specify north or south. Use a modifier of
2 to choose how much the tooltip's arrow is indented.
.tooltipped-multiline when you have long content. This style has some limitations: you cannot pre-format the text with newlines, and tooltips are limited to a max-width of
By default the tooltips have a slight delay before appearing. This is to keep multiple tooltips in the UI from being distracting. There is a
.tooltipped-no-delay modifier class you can use to override this.