Tooltip

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 library loading which contains Popper.js in order for tooltips to work!
• 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 ` to avoid this behavior.
• Tooltips must be hidden before their corresponding elements have been removed from the DOM.

Example: Enable tooltips everywhere

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

<script src="https://cdn.jsdelivr.net/npm/@engie-group/fluid-design-system@latest/lib/components/tooltip/index.js"></script>

<script>
const tooltips = document.querySelectorAll('[data-toggle="tooltip"]');
for (let i = 0; i < tooltips.length; i++) {
  new Tooltip(tooltips[i], {container:tooltips[i]});
}
</script>

Or with full library

import '@engie-group/fluid-design-system'
import '@engie-group/fluid-design-system/lib/auto-init'

Examples

<div style="display: grid; justify-content: center; gap: 48px; padding: 56px;">
  <button type="button" class="nj-btn" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
    Tooltip on top
  </button>
  <button type="button" class="nj-btn" data-toggle="tooltip" data-placement="right" title="Tooltip on right">
    Tooltip on right
  </button>
  <button type="button" class="nj-btn" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">
    Tooltip on bottom
  </button>
  <button type="button" class="nj-btn" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
    Tooltip on left
  </button>
  <button type="button" class="nj-btn" data-arrow="false" data-toggle="tooltip" data-placement="bottom" title="Tooltip without arrow">
    Tooltip without arrow
  </button>
  <button type="button" class="nj-btn" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
    Tooltip with HTML
  </button>
</div>

Inverse

For darker surfaces, we provide an inverse variant with data-variant="inverse"

<div style="display: grid; justify-content: center; background: var(--nj-color-palette-ultramarine-800); gap: 48px; padding: 56px;">
  <button type="button" class="nj-btn nj-btn--inverse" data-toggle="tooltip" data-variant="inverse" data-placement="top" title="Tooltip on top">
    Tooltip on top
  </button>
  <button type="button" class="nj-btn nj-btn--inverse" data-toggle="tooltip" data-variant="inverse" data-placement="right" title="Tooltip on right">
    Tooltip on right
  </button>
  <button type="button" class="nj-btn nj-btn--inverse" data-toggle="tooltip" data-variant="inverse" data-placement="bottom" title="Tooltip on bottom">
    Tooltip on bottom
  </button>
  <button type="button" class="nj-btn nj-btn--inverse" data-toggle="tooltip" data-variant="inverse" data-placement="left" title="Tooltip on left">
    Tooltip on left
  </button>
  <button type="button" class="nj-btn nj-btn--inverse" data-arrow="false" data-toggle="tooltip" data-variant="inverse" data-placement="bottom" title="Tooltip without arrow">
    Tooltip without arrow
  </button>
  <button type="button" class="nj-btn nj-btn--inverse" data-toggle="tooltip" data-variant="inverse" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
    Tooltip with HTML
  </button>
</div>

Usage

The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.

Trigger the tooltip via JavaScript:

new Tooltip(document.getElementById('tooltip'), options);

Overflow auto and scroll

Tooltip position attempts to automatically change when a parent container has overflow: auto or overflow: scroll, but still keeps the original placement’s positioning. To resolve, set the boundary option to anything other than default value, 'scrollParent', such as 'window':

new Tooltip(document.getElementById('tooltip'), { boundary: 'window' });

Markup

The required markup for a tooltip is only a data attribute and title on the HTML element you wish to have a tooltip. The generated markup of a tooltip is rather simple, though it does require a position (by default, set to top by the plugin).

<!-- HTML to write -->

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


<!-- Generated markup by the plugin -->
<div class="tooltip nj-tooltip--top" role="tooltip">
  <div class="nj-tooltip__arrow"></div>
  <div class="nj-tooltip__inner">
    Some tooltip text!
  </div>
</div>

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 <span>) 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. In addition, 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.

Disabled elements

Elements with the disabled attribute aren’t interactive, meaning users cannot focus, hover, or click them to trigger a tooltip (or popover). As a workaround, you’ll want to trigger the tooltip from a wrapper <div> or <span>, ideally made keyboard-focusable using tabindex=”0”, and override the pointer-events on the disabled element.

<span class="d-inline-block" tabindex="0" data-toggle="tooltip" title="Disabled tooltip">
  <button class="nj-btn" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".

Methods

Events

document.querySelector('#myTooltip').addEventListener('hidden.nj.tooltip', () => {
  // do something...
});