Tooltips
Bootstrap 5 Tooltip component
Bootstrap Tooltip displays informative text when users hover, focus, or tap an element. They display text tips next to the element in question.
Documentation and examples for adding custom tooltips with CSS and JavaScript using CSS3 for animations and data-mdb-attributes for local title storage.
Note: Read the API tab to find all available options and advanced customization
*
*
UMD autoinits are enabled
by default. This means that you don't need to initialize
the component manually. However if you are using MDBootstrap ES format then you should pass
the required components to the initMDB
method.
Basic example
Hover over the links below to see tooltips.
Hover the link to see the tooltip
<p>
Hover the link to see the
<a href="#" data-mdb-tooltip-init title="Hi! I'm tooltip">tooltip</a>
</p>
// Initialization for ES Users
import { Tooltip, initMDB } from "mdb-ui-kit";
initMDB({ Tooltip });
Overview
Things to know when using the tooltip plugin:
- 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
ordisabled
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.
Four directions
Hover over the buttons below to see the four tooltips directions: top, right, bottom, and left.
<button type="button" class="btn btn-secondary" data-mdb-ripple-init data-mdb-tooltip-init data-mdb-placement="top" title="Tooltip on top">
Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-mdb-ripple-init data-mdb-tooltip-init data-mdb-placement="right" title="Tooltip on right">
Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-mdb-ripple-init data-mdb-tooltip-init data-mdb-placement="bottom" title="Tooltip on bottom">
Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-mdb-ripple-init data-mdb-tooltip-init data-mdb-placement="left" title="Tooltip on left">
Tooltip on left
</button>
// Initialization for ES Users
import { Tooltip, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Tooltip, Ripple });
And with custom HTML added:
<button
type="button"
class="btn btn-secondary"
data-mdb-ripple-init
data-mdb-tooltip-init
data-mdb-html="true"
title="<em>Tooltip</em> <u>with</u> <b>HTML</b>"
>
Tooltip with HTML
</button>
// Initialization for ES Users
import { Tooltip, Ripple, initMDB } from "mdb-ui-kit";
initMDB({ Tooltip, Ripple });
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-mdb-tooltip-init title="Disabled tooltip">
<button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>
// Initialization for ES Users
import { Tooltip, initMDB } from "mdb-ui-kit";
initMDB({ Tooltip });
Tooltips - API
Import
Importing components depends on how your application works. If you intend to use the MDBootstrap ES
format, you must
first import the component and then initialize it with the initMDB
method. If you are going to use the UMD
format,
just import the mdb-ui-kit
package.
import { Tooltip, initMDB } from "mdb-ui-kit";
initMDB({ Tooltip });
import "mdb-ui-kit"
Usage
Via data attributes:
Using the Datatable component doesn't require any additional JavaScript code - simply add
data-mdb-tooltip-init
attribute to
an element
and use other data attributes to set all options.
For ES
format, you must first import and call the initMDB
method.
<button type="button" class="btn btn-secondary" data-mdb-ripple-init data-mdb-tooltip-init title="Tooltip on top">
Tooltip on top
</button>
Via JavaScript:
const element = document.querySelector('.tooltip');
const instance = new Tooltip(element)
const element = document.querySelector('.tooltip');
const instance = new mdb.Tooltip(element)
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, set the boundary
option to anything other than default value,
'scrollParent'
, such as 'window'
:
const exampleEl = document.getElementById('example');
const tooltip = new Tooltip(exampleEl, {
boundary: 'window'
});
const exampleEl = document.getElementById('example');
const tooltip = new mdb.Tooltip(exampleEl, {
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).
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
<span>
s) 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-mdb-tooltip-init 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>
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to
data-mdb-
, as in data-mdb-placement="top"
.
Note: For security reasons the sanitize
,
sanitizeFn
and allowList
options cannot be supplied using data
attributes.
Name | Type | Default | Description |
---|---|---|---|
animation |
boolean | true |
Apply a CSS fade transition to the tooltip |
container |
string | element | false | false |
Appends the tooltip to a specific element. Example:
|
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: 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) - does not apply to manual trigger type If a number is supplied, delay is applied to both hide/show Object structure is: |
html |
boolean | false |
Allow HTML in the tooltip.
If true, HTML tags in the tooltip's Use text if you're worried about XSS attacks. |
placement |
string | function | 'top' |
How to position the tooltip - auto | top | bottom | left | right.
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
|
selector |
string | selector | 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
and
an informative example.
|
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
The outermost wrapper element should have the
|
title |
string | element | function | '' |
Default title value if
If a function is given, it will be called with its
|
trigger |
string | 'hover focus' |
How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
|
offset |
array | string | function | [0, 6] |
Offset of the tooltip relative to its target. When a function is used to determine the offset, it is called with an object containing the offset data as its first argument. The function must return an object with the same structure. The triggering element DOM node is passed as the second argument. For more information refer to Popper's offset docs. |
fallbackPlacement |
string | array | ['top', 'right', 'bottom', 'left'] |
Allow to specify which position Popper will use on fallback. For more information refer to Popper's behavior docs |
boundary |
string | element | 'clippingParents' |
Overflow constraint boundary of the tooltip (applied only for the preventOverflow
modifier of the Popper). Accepts the values of
'viewport' , 'window' , 'scrollParent' , or an
HTMLElement reference (via JavaScript only). For more information refer to Popper's
detectOverflow docs.
|
sanitize |
boolean | true |
Enable or disable the sanitization. If activated
'template' and 'title' options will be sanitized.
|
allowList |
object | DefaultAllowlist |
Object which contains allowed attributes and tags. |
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. |
popperConfig |
null | object | function | null |
To change Bootstrap's default Popper config, see Popper's configuration |
Data attributes for individual tooltips:
Options for individual tooltips can alternatively be specified through the use of data
attributes, as explained above.
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.
Name | Description | Example |
---|---|---|
show |
Reveals an element’s tooltip.
Returns to the caller before the tooltip has actually been shown
(i.e. before the shown.mdb.tooltip event occurs). This is considered a
“manual” triggering of the tooltip. tooltips whose title and content are both zero-length
are never displayed.
|
instance.show() |
hide |
Hides an element’s tooltip.
Returns to the caller before the tooltip has actually been hidden
(i.e. before the hidden.mdb.tooltip event occurs). This is considered a
“manual” triggering of the tooltip.
|
instance.hide() |
toggle |
Toggles an element’s tooltip.
Returns to the caller before the tooltip has actually been shown or hidden
(i.e. before the shown.mdb.tooltip or hidden.mdb.tooltip event
occurs). This is considered a “manual” triggering of the tooltip.
|
instance.toggle() |
dispose |
Hides and destroys an element’s tooltip. tooltips that use delegation (which are created
using
the selector option) cannot be
individually destroyed on descendant trigger elements.
|
instance.dispose() |
getInstance |
Static method which allows you to get the tooltip instance associated to a DOM element. | Tooltip.getInstance() |
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. | Tooltip.getOrCreateInstance() |
enable |
Gives an element’s tooltip the ability to be shown. tooltips are enabled by default. | instance.enable() |
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. | instance.disable() |
toggleEnabled |
Toggles the ability for an element’s tooltip to be shown or hidden. | instance.toggleEnabled() |
update |
Updates the position of an element’s tooltip. | instance.update() |
const tooltipEl = document.getElementById('tooltip');
const tooltip = new Tooltip(tooltipEl);
tooltip.show();
const tooltipEl = document.getElementById('tooltip');
const tooltip = new mdb.Tooltip(tooltipEl);
tooltip.show();
Events
Event type | Description |
---|---|
show.mdb.tooltip |
This event fires immediately when the show instance method is called.
|
shown.mdb.tooltip |
This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete). |
hide.mdb.tooltip |
This event is fired immediately when the hide instance method has been
called.
|
hidden.mdb.tooltip |
This event is fired when the tooltip has finished being hidden from the user (will wait for CSS transitions to complete). |
inserted.mdb.tooltip |
This event is fired after the show.mdb.tooltip event when the tooltip
template has been added to the DOM.
|
const tooltipEl = document.getElementById('tooltip');
tooltipEl.addEventListener('hidden.mdb.tooltip', () => {
// do something...
});
CSS variables
As part of MDB’s evolving CSS variables approach, tolltips now use local CSS variables on
.tooltip
for enhanced real-time customization. Values for the CSS variables are
set via Sass, so Sass customization is still supported, too.
// .tooltip
--#{$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};
--#{$prefix}tooltip-font-size: #{$tooltip-font-size};
SCSS variables
$tooltip-max-width: 200px;
$tooltip-opacity: 0.9;
$tooltip-margin: null;
$tooltip-arrow-width: 0.8rem;
$tooltip-arrow-height: 0.4rem;
$tooltip-arrow-color: null;
$tooltip-color: var(--#{$prefix}surface-inverted-color);
$tooltip-padding-y: 6px;
$tooltip-padding-x: 16px;
$tooltip-font-size: 14px;
$tooltip-bg: var(--#{$prefix}surface-inverted-bg);
$tooltip-border-radius: 0.25rem;