Tooltip

Hover me

Tooltips are GUI user-triggered elements consisting of message boxes with additional and non-essential information about pages or features. These elements appear when the user interacts with items (buttons, icons, images, links) on a page, by hovering over them while on a desktop or tapping on them while on mobile systems. The message inside a tooltip should be brief yet informative. The information included should be contextual, helpful and non-essential while providing that extra ability to communicate and give clarity to a user.

UX/UI Guidelines

Check the design documentation of the component in ZeroHeight.

Implementations

The component Tooltip is available in the following technologies:

CSS Components

Web Components

Parameters

Parameters

Parameters are the attributes that can be used to customize the component when using it in a project. They apply to the WebComponents implementation and wrappers and to the Vue and React CSS implementations. Some parameters names change between the implementations, in order to follow the conventions of each technology and framework.

For example, the param model is named ngModel in Angular, modelValue in Vue, but stays as model in React.

By default, all the parameters are optional or can be set in different, except for the ones marked as required

The parametrization of the component can be done with the following custom params or properties:

Name	Type	Slottable	Description
text [required]	string		The text to be displayed inside the tooltip.
config	string		The main parameter has three components following the pattern: <side><?:size>. side: The position of the tooltip. Can be top, top-right, top-left, bottom, bottom-right or bottom-left. size: The size of the tooltip. Can be xs, s ,m or l.
content	string	✅	The text to be hovered
custom	object		A record of key-value pairs to set the CSS custom tokens. It's a complex attribute set as an JS object in stringified JSON format. Example: <z-tooltip custom='{"fill":"#06e7a3"}' />
custom-str	string		The stringified version of the custom property. It follows the pattern key:value;key:value;, with the possibility of setting multiple values and spaces between the punctuation characters. Example: <z-tooltip custom-str="fill:#06e7a3" />
z-theme	string		Sets the theme of the component. The possible values are light and dark. <z-tooltip z-theme="dark" />

From Figma to code

You can check the Figma implementation here.

Customization

INFO

Check everything about the customization mechanics in the "How it works" documentation.

CSS Variable	Type	Description
--z-tooltip--color	color	Font color
--z-tooltip--bg	color	Background color

Both background color and text color can be customized using the --z-tooltip--bg and --z-tooltip--color CSS variables.

Hover me

Hover me

Related components