Tooltips identify elements or provide additional, useful information about the referring elements.
- Container: Wraps the content.
- Text: Concisely describes the referring element or its purpose.
- Tip: Points to the referring element.
When to use
- Show the same data in a different format, such as date or timestamps.
- Display a full string of text that is shortened with an ellipsis (
- Provide context for unlabeled items such as icon buttons, except for certain cases.
When not to use
- For icon buttons that may be universally understood, like a closing action using the close icon.
Consider using a popover for the following scenarios:
- Display information required for task completion, such as password formatting hints.
- Display more than a single line of information or dimensional data, such as user name or status.
- Display a sophisticated layout and formatting.
- Offer simple controls and/or actions that are closely tied to the element or object, such as searchable list, links, or buttons.
- By default, tooltips are placed on top of the referring element.
- When there isn’t enough space in the viewport, the tooltip is moved to the side or below as needed.
- If it blocks related content, the preferred tooltip placement can be manually set.
- Should have no space (0px) between themselves and their target.
- Remain in place while the cursor moves within the target.
- Should never obscure the target element.
- Content within a tooltip uses center-alignment.
- Wraps when the content is wider than the max-width.
- Fades in upon hover or focus on the trigger element.
- Remains open until the cursor moves outside of itself or the trigger, or focus is moved away from the trigger.
Similar to popovers, a tooltip has a default delay of
show to help confirm hover intent and ensure that:
- A user doesn’t accidentally hover an element with a tooltip, which might cover an adjacent element they intended to select.
- The UI isn't constantly showing tooltips when a user is moving their mouse over the page.
show delay for a tooltip is strongly discouraged for the reasons above, but there are useful circumstances for a tooltip to appear instantly. For example, pipeline icons that are visually the same, but have unique tooltip text that a user relies on to determine the pipeline status. Here, a delay would make it cumbersome to decipher the pipeline while hovering from one icon to the next. To shorten the delay in these cases, utilize
ds### in the tooltip directive, where
### is the milliseconds of delay.
Here's an example of a tooltip directive with a
0ms delay (instant) on
<gl-button v-gl-tooltip.ds0 ... />
- Should be short and concise.
- Shouldn’t repeat information that is shown near the referring element.
Last updated at: