Tooltip

Ready Added in 2.0.0

Easily create a nice looking tooltip.

Usage

To apply this component, add the gls-tooltip attribute to an element. You also need to add the title: TEXT option to the attribute, whose value will represent your tooltip’s text.

<div gls-tooltip="title: Hello World"></div>

If title is the only option in the attribute value, you can also use gls-tooltip="TEXT"

<div gls-tooltip="Hello World"></div>

<button class="gls-button gls-button-default" gls-tooltip="Hello World">Hover</button>

Alignment

Add one of the following options to the gls-tooltip attribute to adjust the tooltip’s alignment.

<button gls-tooltip="title: Hello World; pos: top-left"></button>

Attribute	Description
`pos: top`	Aligns the tooltip to the top.
`pos: top-left`	Aligns the tooltip to the top left.
`pos: top-right`	Aligns the tooltip to the top right.
`pos: bottom`	Aligns the tooltip to the bottom.
`pos: bottom-left`	Aligns the tooltip to the bottom left.
`pos: bottom-right`	Aligns the tooltip to the bottom right.
`pos: left`	Aligns the tooltip to the left.
`pos: right`	Aligns the tooltip to the right.

<p gls-margin>
    <button class="gls-button gls-button-default" gls-tooltip="Hello World">Top</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: top-left">Top Left</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: top-right">Top Right</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: bottom">Bottom</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: bottom-left">Bottom Left</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: bottom-right">Bottom Right</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: left">Left</button>
    <button class="gls-button gls-button-default" gls-tooltip="title: Hello World; pos: right">Right</button>
</p>

Delay

If you want the tooltip to appear with a little delay, just add the delay option to the gls-tooltip attribute with your value in milliseconds.

<div gls-tooltip="title: Hello World; delay: 500"></div>

<button class="gls-button gls-button-default" gls-tooltip="title: Hello World; delay: 500">Hover</button>

Component options

Any of these options can be applied to the component attribute. Separate multiple options with a semicolon. Learn more

Option	Value	Default	Description
`title`	String	``	Tooltip text.
`pos`	String	`top`	Tooltip position.
`offset`	Number	`false`	Tooltip offset.
`animation`	String	`gls-animation-scale-up`	The space separated names of animations to use. Comma separate for animation out.
`duration`	Number	`100`	The animation duration.
`delay`	Number	`0`	The show delay.
`cls`	String	`gls-active`	The active class.
`container`	String	`body`	Define a target container via a selector to specify where the tooltip should be appended in the DOM.

title is the Primary option and its key may be omitted, if it’s the only option in the attribute value.

<span gls-tooltip="Hello World"></span>

JavaScript

Learn more about JavaScript components.

Initialization

Gloss.tooltip(element, options);

Events

The following events will be triggered on elements, which are injected by this component:

Name	Description
`beforeshow`	Fires before an item is shown. Can prevent showing by calling `preventDefault()` on the event.
`show`	Fires after an item is shown.
`shown`	Fires after the item’s show animation has completed.
`beforehide`	Fires before an item is hidden. Can prevent hiding by calling `preventDefault()` on the event.
`hide`	Fires after an item’s hide animation has started.
`hidden`	Fires after an item is hidden.

Example

Gloss.util.on(document, 'show', '.gls-tooltip.gls-active', function() {
  // do something
});

Methods

The following methods are available for the component:

Show

Gloss.tooltip(element).show();

Shows the Tooltip.

Hide

Gloss.tooltip(element).hide();

Hides the Tooltip.