Skip to main content

Tooltips

Tooltips provide a short description of a page element or control.

Overview

Things to know when using the tooltip plugin:

  • Tooltips rely on the 3rd party library Popper.js for positioning. You must include popper.min.js before bootstrap.js or use bootstrap.bundle.min.js which contains Popper.js in order for tooltips to work!
  • If you’re building our JavaScript from source, it requires util.js.
  • Tooltips are opt-in for performance reasons, so you must initialize them yourself.
  • Tooltips with zero-length titles are never displayed.
  • Specify container: 'body' to avoid rendering problems in more complex components (like our input groups, button groups, etc).
  • Triggering tooltips on hidden elements will not work.
  • Tooltips for .disabled or disabled elements must be triggered on a wrapper element.
  • When triggered from hyperlinks that span multiple lines, tooltips will be centered. Use white-space: nowrap; on your <a>s to avoid this behavior.
  • Tooltips must be hidden before their corresponding elements have been removed from the DOM.
  • Tooltips can be triggered thanks to an element inside a shadow DOM.

Enable Tooltips Everywhere

One way to initialize all tooltips on a page would be to select them by their data-toggle attribute: 

$(function () {
  $('[data-toggle="tooltip"]').tooltip();
});

Hide Tooltips on Escape 

// Hide Bootstrap tooltips when user presses Escape
document.addEventListener('keyup', function (event) {
  if (event.which === 27) {
    const tooltipTriggerList = document.querySelectorAll('[data-toggle="tooltip"]');
    tooltipTriggerList.forEach(function (tooltipTriggerEl) {
      $(tooltipTriggerEl).tooltip('hide');
    });
  }
});

Tooltip Examples

Tooltips can be used with a variety of different components.

Clifford
settings

Tooltips can even be used with text 

<button class="btn btn-primary" data-toggle="tooltip" data-placement="top" title="Button Tooltip">
  Button
</button>

<div class="chip chip-solid chip-input ml-3" data-toggle="tooltip" data-placement="top" title="Chip Tooltip">
  <div class="chip-thumbnail"><img src="/docs/v1/img/headshot.png" alt=""></div>
  <div class="chip-text">Clifford</div>
  <div class="chip-delete-right"><i class="modus-icons notranslate" aria-hidden="true">close</i></div>
</div>

<i class="modus-icons ml-3" data-toggle="tooltip" data-placement="top" title="Icon Tooltip">settings</i>

<p class="ml-3 mb-0">
  Tooltips can even be used with
  <strong data-toggle="tooltip" data-placement="top" title="Text Tooltip">text</strong>
</p>

Tooltip Placement

Use the data-placement attribute to specify the tooltip’s location.

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

Tooltips with HTML

To use custom HTML inside a tooltip, enable data-html="true" and place your HTML in the title attribute.

<button type="button" class="btn btn-primary" data-toggle="tooltip" data-html="true" data-placement="top" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
  Tooltip with HTML
</button>
On this page
More Information