Tooltips

Examples and documentation for adding custom UX4G tooltips in CSS and JavaScript utilizing data-bs-attributes for local title storage and CSS3 animations.

Overview #

Tooltip placement is handled by the third-party library Popper.

Developer must use one UX4G .bundle.min.js that contains Popper or include popper .min.js before UX4G.js.
Tooltips rely on the third party library Popper for positioning. You must include popper.min.js before UX4G.js, or use one UX4G.bundle.min.js which contains Popper.
For performance concerns, tooltips are opt-in, therefore it is must to initialize them manually.
Tooltips with titles of zero length are never shown.
To prevent rendering issues in more complicated components (like the input groups, button groups, etc.), use container: 'body'.
Tooltips won't activate on hidden elements.
Tip boxes for wrapper element must trigger .disabled or disabled elements.
Tooltips will be centered when they are activated by hyperlinks that cross several lines. To prevent this, use white-space: nowrap; on your <a>s.
Before their related elements are deleted from the DOM, tooltips must first be hidden.
An element inside a shadow DOM can cause tooltips to appear.

Got all that? Great, let's see how they work with some examples.

By default, this component uses the built-in content sanitizer, which strips out any HTML elements that are not explicitly allowed. See the sanitizer section in our JavaScript documentation for more details.

The animation effect of this component is dependent on the prefers-reduced-motion media query. See the reduced motion section of our accessibility documentation.

Examples #

Enable tooltips #

As it is already indicated, tooltips need to be initialized before being utilized. A method to pick all tooltips on a page based on their data-bs-toggle attribute is as follows:

const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new ux4g.Tooltip(tooltipTriggerEl))

Tooltips on links #

Hover over the links below to see tooltips:

<p class="muted">Placeholder text to demonstrate some <a href="#" data-bs-toggle="tooltip" data-bs-title="Default tooltip">inline links</a> with tooltips. This is now just filler, no killer. Content placed here just to mimic the presence of <a href="#" data-bs-toggle="tooltip" data-bs-title="Another tooltip">real text</a>. And all that just to give you an idea of how tooltips would look when used in real-world situations. So hopefully you've now seen how <a href="#" data-bs-toggle="tooltip" data-bs-title="Another one here too">these tooltips on links</a> can work in practice, once you use them on <a href="#" data-bs-toggle="tooltip" data-bs-title="The last tip!">your own</a> site or project.
</p>

RESULT

Placeholder text to demonstrate some inline links with tooltips. This is now just filler, no killer. Content placed here just to mimic the presence of real text. And all that just to give you an idea of how tooltips would look when used in real-world situations. So hopefully you've now seen how these tooltips on links can work in practice, once you use them on your own site or project.

Feel free to use either title or data-bs-title in your HTML. When title is used, Popper will replace it automatically with data-bs-title when the element is rendered.

Custom tooltips #

Added in v1.0.1

Using CSS variables, developer can alter how tooltips look. To scope the customized appearance, it is set to a custom class with data-bs-custom-class="custom-tooltip" and utilize it to replace a local CSS variable.

.custom-tooltip {
  --bs-tooltip-bg: var(--bs-primary);
}

.custom-tooltip {  --bs-tooltip-bg: var(--bs-primary);}
<button type="button" class="btn btn-secondary"
data-bs-toggle="tooltip" data-bs-placement="top"
data-bs-custom-class="custom-tooltip"
data-bs-title="This top tooltip is themed via CSS variables.">
Custom tooltip
</button>

RESULT

Directions #

The four tooltip directions are top, right, bottom, and left. Hover over the buttons below to view them. When using UX4G in RTL, directions are mirrored.

<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="top" data-bs-title="Tooltip on top">
  Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="right" data-bs-title="Tooltip on right">
  Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-title="Tooltip on bottom">
  Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="left" data-bs-title="Tooltip on left">
  Tooltip on left
</button>

RESULT

And with custom HTML added:

<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-html="true" data-bs-title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
  Tooltip with HTML
</button>

With an SVG:

CSS #

Variables #

Added in v1.0.1

The top, right, bottom, and left tooltip directions are available. To see the buttons below, hover rhe cursor over them. In RTL, directions are mirrored when using UX4G.

  --#{$prefix}tooltip-zindex: #{$zindex-tooltip};
  --#{$prefix}tooltip-max-width: #{$tooltip-max-width};
  --#{$prefix}tooltip-padding-x: #{$tooltip-padding-x};
  --#{$prefix}tooltip-padding-y: #{$tooltip-padding-y};
  --#{$prefix}tooltip-margin: #{$tooltip-margin};
  @include rfs($tooltip-font-size, --#{$prefix}tooltip-font-size);
  --#{$prefix}tooltip-color: #{$tooltip-color};
  --#{$prefix}tooltip-bg: #{$tooltip-bg};
  --#{$prefix}tooltip-border-radius: #{$tooltip-border-radius};
  --#{$prefix}tooltip-opacity: #{$tooltip-opacity};
  --#{$prefix}tooltip-arrow-width: #{$tooltip-arrow-width};
  --#{$prefix}tooltip-arrow-height: #{$tooltip-arrow-height};

Sass variables #

$tooltip-font-size:                 $font-size-sm;
$tooltip-max-width:                 200px;
$tooltip-color:                     $white;
$tooltip-bg:                        $black;
$tooltip-border-radius:             $border-radius;
$tooltip-opacity:                   .9;
$tooltip-padding-y:                 $spacer * .25;
$tooltip-padding-x:                 $spacer * .5;
$tooltip-margin:                    null; 

$tooltip-arrow-width:               .8rem;
$tooltip-arrow-height:              .4rem;
// fusv-disable
$tooltip-arrow-color:               null; 
// fusv-enable

Usage #

By default, the tooltip plugin places tooltips after their trigger element and generates text and markup as needed.

Trigger the tooltip via JavaScript:

const exampleEl = document.getElementById('example')
const tooltip = new ux4g.Tooltip(exampleEl, options)

Overflow `auto` and `scroll`

Tooltip position attempts to automatically change when a parent container has overflow: auto or overflow: scroll like our .table-responsive, but still keeps the original placement’s positioning. To resolve this, set the boundary option (for the flip modifier using the popperConfig option) to any HTMLElement to override the default value, 'clippingParents', such as document.body:

  const tooltip = new UX4G.Tooltip('#example', {
  boundary: document.body // or document.querySelector('#boundary')})

Markup #

Only a data property and title on the HTML element developer intend to have a tooltip on are necessary for markup to function. A tooltip's generated HTML is quite straightforward, although it does call for a position, which the plugin by default sets to the top.

Making tooltips work for keyboard and assistive technology users

You should only add tooltips to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as spans) can be made focusable by adding the tabindex="0" attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users, and most assistive technologies currently do not announce the tooltip in this situation. Additionally, do not rely solely on hover as the trigger for your tooltip, as this will make your tooltips impossible to trigger for keyboard users.

<!-- HTML to write -->
<a href="#" data-bs-toggle="tooltip" data-bs-title="Some tooltip text!">Hover over me</a>

<!-- Generated markup by the plugin -->
<div class="tooltip bs-tooltip-top" role="tooltip">
  <div class="tooltip-arrow"></div>
  <div class="tooltip-inner">
    Some tooltip text!
  </div>
</div>

Disabled elements #

Users cannot concentrate, hover over, or click non-interactive elements with the disabled property to launch a tooltip (or popover) since they are not interactive. Developer should use a wrapper <div> or <span> that is ideally made keyboard-focusable using tabindex="0" to activate the tooltip as a workaround.

<span class="d-inline-block" tabindex="0" data-bs-toggle="tooltip" data-bs-title="Disabled tooltip">
  <button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

RESULT

Options #

Data-bs-animation can have an option name appended to it, for example, data-bs-animation="{value}" since options can be provided through data attributes or JavaScript. When sending the choices via data attributes, be sure to modify the case type of the option name from "camelCase" to "kebab-case." Use data-bs-custom-class="beautifier" as opposed to data-bs-customClass="beautifier," for instance.

Since UX4G 1.0.0, all components are compatible with the experimental reserved data attribute data-bs-config, which can store a JSON string for basic component setting. When an element has the data-bs-config='{"delay":0, "title":123}' and data-bs-title="456" attributes, the final title value will be 456 and the individual data attributes will take precedence over the values specified on the data-bs-config. Additionally, JSON variables like data-bs-delay='{"show":0,"hide":150}' can be stored in existing data attributes.

Note that for security reasons the sanitize, sanitizeFn, and allowList options cannot be supplied using data attributes.

Name	Type	Default	Description
`allowList`	object	Default value	Object which contains allowed attributes and tags.
`animation`	boolean	`true`	Apply a CSS fade transition to the tooltip.
`boundary`	string, element	`'clippingParents'`	Overflow constraint boundary of the tooltip (applies only to Popper’s preventOverflow modifier). By default, it’s `'clippingParents'` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper’s detectOverflow docs.
`container`	string, element, false	`false`	Appends the tooltip to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the tooltip in the flow of the document near the triggering element - which will prevent the tooltip from floating away from the triggering element during a window resize.
`customClass`	string, function	`''`	Add classes to the tooltip when it is shown. Note that these classes will be added in addition to any classes specified in the template. To add multiple classes, separate them with spaces: `'class-1 class-2'`. You can also pass a function that should return a single string containing additional class names.
`delay`	number, object	`0`	Delay showing and hiding the tooltip (ms)—doesn’t apply to manual trigger type. If a number is supplied, delay is applied to both hide/show. Object structure is: `delay: { "show": 500, "hide": 100 }`.
`fallbackPlacements`	array	`['top', 'right', 'bottom', 'left']`	Define fallback placements by providing a list of placements in array (in order of preference). For more information refer to Popper’s behavior docs.
`html`	boolean	`false`	Allow HTML in the tooltip. If true, HTML tags in the tooltip’s `title` will be rendered in the tooltip. If false, `innerText` property will be used to insert content into the DOM. Use text if you’re worried about XSS attacks.
`offset`	array, string, function	`[0, 0]`	Offset of the tooltip relative to its target. You can pass a string in data attributes with comma separated values like: `data-bs-offset="10,20"`. When a function is used to determine the offset, it is called with an object containing the popper placement, the reference, and popper rects as its first argument. The triggering element DOM node is passed as the second argument. The function must return an array with two numbers: skidding, distance. For more information refer to Popper’s offset docs.
`placement`	string, function	`'top'`	How to position the tooltip: auto, top, bottom, left, right. When `auto` is specified, it will dynamically reorient the tooltip. When a function is used to determine the placement, it is called with the tooltip DOM node as its first argument and the triggering element DOM node as its second. The `this` context is set to the tooltip instance.
`popperConfig`	null, object, function	`null`	To change UX4G default Popper config, see Popper’s configuration. When a function is used to create the Popper configuration, it’s called with an object that contains the UX4G default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper.
`sanitize`	boolean	`true`	Enable or disable the sanitization. If activated `'template'`, `'content'` and `'title'` options will be sanitized.
`sanitizeFn`	null, function	`null`	Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.
`selector`	string, false	`false`	If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to also apply tooltips to dynamically added DOM elements (`jQuery.on` support). See this issue and an informative example. Note: `title` attribute must not be used as a selector.
`template`	string	`'<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'`	Base HTML to use when creating the tooltip. The tooltip’s `title` will be injected into the `.tooltip-inner`. `.tooltip-arrow` will become the tooltip’s arrow. The outermost wrapper element should have the `.tooltip` class and `role="tooltip"`.
`title`	string, element, function	`''`	Default title value if `title` attribute isn’t present. If a function is given, it will be called with its `this` reference set to the element that the popover is attached to.
`trigger`	string	`'hover focus'`	How tooltip is triggered: click, hover, focus, manual. You may pass multiple triggers; separate them with a space. `'manual'` indicates that the tooltip will be triggered programmatically via the `.tooltip('show')`, `.tooltip('hide')` and `.tooltip('toggle')` methods; this value cannot be combined with any other trigger. `'hover'` on its own will result in tooltips that cannot be triggered via the keyboard, and should only be used if alternative methods for conveying the same information for keyboard users is present.

Data attributes for individual tooltips

Options for individual tooltips can alternatively be specified through the use of data attributes, as explained above.

Using function with `popperConfig` #

const tooltip = new ux4g.Tooltip(element, {
  popperConfig(defaultBsPopperConfig) {
    // const newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})

Methods #

Asynchronous methods and transitions

All API methods are asynchronous and start a transition. They return to the caller as soon as the transition is started but before it ends. In addition, a method call on a transitioning component will be ignored.

Method	Description
`disable`	Removes the ability for an element’s tooltip to be shown. The tooltip will only be able to be shown if it is re-enabled.
`dispose`	Hides and destroys an element’s tooltip (Removes stored data on the DOM element). Tooltips that use delegation (which are created using the `selector` option) cannot be individually destroyed on descendant trigger elements.
`enable`	Gives an element’s tooltip the ability to be shown. Tooltips are enabled by default.
`getInstance`	Static method which allows you to get the tooltip instance associated with a DOM element, or create a new one in case it wasn’t initialized.
`getOrCreateInstance`	Static method which allows you to get the tooltip instance associated with a DOM element, or create a new one in case it wasn’t initialized.
`hide`	Hides an element’s tooltip. Returns to the caller before the tooltip has actually been hidden (i.e. before the `hidden.bs.tooltip` event occurs). This is considered a “manual” triggering of the tooltip.
`setContent`	Gives a way to change the tooltip’s content after its initialization.
`show`	Reveals an element’s tooltip. Returns to the caller before the tooltip has actually been shown (i.e. before the `shown.bs.tooltip` event occurs). This is considered a “manual” triggering of the tooltip. Tooltips with zero-length titles are never displayed.
`toggle`	Toggles an element’s tooltip. Returns to the caller before the tooltip has actually been shown or hidden (i.e. before the `shown.bs.tooltip` or `hidden.bs.tooltip` event occurs). This is considered a “manual” triggering of the tooltip.
`toggleEnabled`	Toggles the ability for an element’s tooltip to be shown or hidden.
`update`	Updates the position of an element’s tooltip.

const tooltip = UX4G.Tooltip.getInstance('#example') // Returns a UX4G tooltip instance
// setContent example
tooltip.setContent({ '.tooltip-inner': 'another title' })

The setContent method accepts an object argument, where each property-key is a valid string selector within the popover template, and each related property-value can be string | element | function | null

Events #

Event	Description
`hide.bs.tooltip`	This event is fired immediately when the `hide` instance method has been called.
`hidden.bs.tooltip`	This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
`inserted.bs.tooltip`	This event is fired after the `show.bs.tooltip` event when the tooltip template has been added to the DOM.
`show.bs.tooltip`	This event fires immediately when the `show` instance method is called.
`shown.bs.tooltip`	This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).

const myTooltipEl = document.getElementById('myTooltip')
const tooltip = bootstrap.Tooltip.getOrCreateInstance(myTooltipEl)

myTooltipEl.addEventListener('hidden.bs.tooltip', () => {
  // do something...
})

tooltip.hide()

Overview
Examples
- Enable tooltips
- Tooltips on links
Custom tooltips
Directions
CSS
- Variables
Sass variables
Usage
Markup
Disabled elements
Options
Using function with popperConfig
Methods
Events

Demo

Demo

Previous « Toasts

Next Helpers »

Tooltips

Overview #

Examples #

Enable tooltips #

Tooltips on links #

RESULT

Custom tooltips #

RESULT

Directions #

RESULT

CSS #

Variables #

Sass variables #

Usage #

Overflow auto and scroll

Markup #

Making tooltips work for keyboard and assistive technology users

Disabled elements #

RESULT

Options #

Data attributes for individual tooltips ​

Using function with popperConfig #

Methods #

Asynchronous methods and transitions

Events #

Accessibility options by UX4G

Overflow `auto` and `scroll`

Data attributes for individual tooltips

Using function with `popperConfig` #