Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
By default, this component uses the built-in content sanitizer, which strips out any HTML elements that are not explicitly allowed. See the for more details.
Got all that? Great, let’s see how they work with some examples.
One way to initialize all tooltips on a page would be to select them by their
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
8 attribute:
var tooltipTriggerList = [].slice.call[document.querySelectorAll['[data-bs-toggle="tooltip"]']]
var tooltipList = tooltipTriggerList.map[function [tooltipTriggerEl] {
return new bootstrap.Tooltip[tooltipTriggerEl]
}]
Examples
Hover over the links below to see tooltips:
Placeholder text to demonstrate some with tooltips. This is now just filler, no killer. Content placed here just to mimic the presence of . 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 can work in practice, once you use them on site or project.
Hover over the buttons below to see the four tooltips directions: top, right, bottom, and left. Directions are mirrored when using Bootstrap in RTL.
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
And with custom HTML added:
Tooltip with HTML
With an SVG:
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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
Usage
The tooltip plugin generates content and markup on demand, and by default places tooltips after their trigger element.
Trigger the tooltip via JavaScript:
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
Overflow
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
9 and
Tooltip with HTML
0
Tooltip position attempts to automatically change when a parent container has
Tooltip with HTML
1 or
Tooltip with HTML
2 like our
Tooltip with HTML
3, but still keeps the original placement’s positioning. To resolve this, set the [for the flip modifier using the
Tooltip with HTML
5 option] to any HTMLElement to override the default value,
Tooltip with HTML
6, such as
Tooltip with HTML
7:
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
Markup
The required markup for a tooltip is only a
Tooltip with HTML
8 attribute and
Tooltip with HTML
9 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
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
0 by the plugin].
Making tooltips work for keyboard and assistive technology usersYou 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
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
1s] can be made focusable by adding the
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
2 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
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
3 as the trigger for your tooltip, as this will make your tooltips impossible to trigger for keyboard users.
Hover over me
Some tooltip text!
Disabled elements
Elements with the
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
5 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
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
5 or
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
1, ideally made keyboard-focusable using
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
2.
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
8, as in
$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: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
9. Make sure to change the case type of the option name from camelCase to kebab-case when passing the options via data attributes. For example, instead of using
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
0, use
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
1.
Note that for security reasons the
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
2,
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
3, and
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
4 options cannot be supplied using data attributes.
Name Type Default Description
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
5 boolean
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
6 Apply a CSS fade transition to the tooltip
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
7 string | element | false
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
8
Appends the tooltip to a specific element. Example:
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
3. 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.
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
0 number | object
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
1
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:
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
2
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
3 boolean
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
8
Allow HTML in the tooltip.
If true, HTML tags in the tooltip's
Tooltip with HTML
9 will be rendered in the tooltip. If false,
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
6 property will be used to insert content into the DOM.
Use text if you're worried about XSS attacks.
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
7 string | function
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, {
boundary: document.body // or document.querySelector['
# boundary']
}]
8
How to position the tooltip - auto | top | bottom | left | right. When
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
9 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
Hover over me
Some tooltip text!
0 context is set to the tooltip instance.
Hover over me
Some tooltip text!
1 string | false
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
8 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 [
Hover over me
Some tooltip text!
3 support]. See this and an informative example.
Hover over me
Some tooltip text!
4 string
Hover over me
Some tooltip text!
5
Base HTML to use when creating the tooltip.
The tooltip's
Tooltip with HTML
9 will be injected into the
Hover over me
Some tooltip text!
7.
Hover over me
Some tooltip text!
8 will become the tooltip's arrow.
The outermost wrapper element should have the
Hover over me
Some tooltip text!
9 class and
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
0.
Tooltip with HTML
9 string | element | function
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
2
Default title value if
Tooltip with HTML
9 attribute isn't present.
If a function is given, it will be called with its
Hover over me
Some tooltip text!
0 reference set to the element that the tooltip is attached to.
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
5 string
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
6
How tooltip is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space.
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
7 indicates that the tooltip will be triggered programmatically via the
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
8,
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
9 and
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
0 methods; this value cannot be combined with any other trigger.
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
1 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.
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
2 array
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
3 Define fallback placements by providing a list of placements in array [in order of preference]. For more information refer to Popper's
Tooltip with HTML
4 string | element
Tooltip with HTML
6 Overflow constraint boundary of the tooltip [applies only to Popper's preventOverflow modifier]. By default it's
Tooltip with HTML
6 and can accept an HTMLElement reference [via JavaScript only]. For more information refer to Popper's .
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
7 string | function
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
}]
2
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:
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
9.
You can also pass a function that should return a single string containing additional class names.
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
2 boolean
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
6 Enable or disable the sanitization. If activated
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
2 and
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
3 options will be sanitized. See the .
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
4 object Object which contains allowed attributes and tags
var exampleEl = document.getElementById['example']
var tooltip = new bootstrap.Tooltip[exampleEl, options]
3 null | function
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
6 Here you can supply your own sanitize function. This can be useful if you prefer to use a dedicated library to perform sanitization.
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
7 array | string | function
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
8
Offset of the tooltip relative to its target. You can pass a string in data attributes with comma separated values like:
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
9
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:
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
00.
For more information refer to Popper's .
Tooltip with HTML
5 null | object | function
var exampleTriggerEl = document.getElementById['example']
var tooltip = bootstrap.Tooltip.getOrCreateInstance[exampleTriggerEl] // Returns a Bootstrap tooltip instance
6
To change Bootstrap's default Popper config, see .
When a function is used to create the Popper configuration, it's called with an object that contains the Bootstrap's default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper.
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
Tooltip with HTML
5
var tooltip = new bootstrap.Tooltip[element, {
popperConfig: function [defaultBsPopperConfig] {
// var 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.
.
show
Reveals an element’s tooltip. Returns to the caller before the tooltip has actually been shown [i.e. before the
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
04 event occurs]. This is considered a “manual” triggering of the tooltip. Tooltips with zero-length titles are never displayed.
hide
Hides an element’s tooltip. Returns to the caller before the tooltip has actually been hidden [i.e. before the
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
05 event occurs]. This is considered a “manual” triggering of the tooltip.
toggle
Toggles an element’s tooltip. Returns to the caller before the tooltip has actually been shown or hidden [i.e. before the
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
04 or
Tooltip on top
Tooltip on right
Tooltip on bottom
Tooltip on left
05 event occurs]. This is considered a “manual” triggering of the tooltip.
dispose
Hides and destroys an element’s tooltip [Removes stored data on the DOM element]. Tooltips that use delegation [which are created using ] cannot be individually destroyed on descendant trigger elements.
enable
Gives an element’s tooltip the ability to be shown. Tooltips are enabled by default.
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.
toggleEnabled
Toggles the ability for an element’s tooltip to be shown or hidden.
update
Updates the position of an element’s tooltip.
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 initialised