Tooltip

Tooltips are floating labels that briefly explain the function of a user interface element. They can be triggered when merchants hover, focus, tap, or click.

Examples

Use only when necessary to provide an explanation for an interface element.

Result

Properties

React

HTML

Props

activatorWrapper

string

The element type to wrap the activator in

active

boolean

Toggle whether the tooltip is visible

True

False

children

React.ReactNode

The element that will activate to tooltip

contentRequired

string

The content to display within the tooltip

light

boolean

Display tooltip with a light background

True

False

preferredPosition

"above" | "below" | "mostSpace"

The direction the tooltip tries to display

Best practices

Tooltips should:

Provide useful, additional information or clarification.
Succinctly describe or expand on the element they point to.
Be provided for icon-only buttons or a button with an associated keyboard shortcut.
Not be used to communicate critical information, including errors in forms or other interaction feedback.
Not contain any links or buttons.
Be used sparingly. If you’re building something that requires a lot of tooltips, work on clarifying the design and the language in the experience.

Content guidelines

Basic tooltips

Tooltips should:

Be written in sentence case
Be concise and scannable
Not be used to communicate error messages or important account information

Do

Post reach is the number of people who have seen your post in their News Feed.

Don’t

To continue using Shopify, this amount must be paid immediately.