Create custom tooltips with Bootstrap. CSS and JavaScript using CSS3 for animations and data-attributes for local title storage.
bootstrap.bundle.min.js
/ bootstrap.bundle.js
which contains Popper.js.container: 'body'
to avoid rendering problems in more complex components (like our input groups, button groups, etc)..disabled
or disabled
elements must be triggered on a wrapper element.white-space: nowrap;
on your <a>
s.Initialize all tooltips on a page with javascript $('[data-toggle="tooltip"]').tooltip() by selecting them by their data-toggle
attribute.
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
Basic example of the tooltip on text content. Hover over the links below to see tooltips
Tight pants next level keffiyeh you probably haven't heard of them. Photo booth beard raw denim letterpress vegan messenger bag stumptown. Farm-to-table seitan, mcsweeney's fixie sustainable quinoa 8-bit american apparel have a terry richardson vinyl chambray. Beard stumptown, cardigans banh mi lomo thundercats. Tofu biodiesel williamsburg marfa, four loko mcsweeney's cleanse vegan chambray. A really ironic artisan whatever keytar, scenester farm-to-table banksy Austin twitter handle freegan cred raw denim single-origin coffee viral.
You can cutomize the tooltip positions with the data-placement=* attributes by adding the values top
, right
, bottom
and left
.
And with custom HTML added:
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
Tooltip with HTML
</button>
The tooltip plugin generates content and markup on demand. By default tooltips are placed after their trigger element.
$('#example').tooltip(options)
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'
:
$('#example').tooltip({ boundary: 'window' })
Always add tooltips to HTML elements which are keyboard-focusable and interactive (such as links or form controls). Arbitrary HTML elements (such as <span>
s) can be made focusable by adding the tabindex="0"
attribute, but this will be confusing as the tab stops on non-interactive elements and also most assistive technologies do not announce the tooltip in this situation.
<!-- HTML to write -->
<a href="#" data-toggle="tooltip" title="Some tooltip text!">Hover over me</a>
<!-- Generated markup by the plugin -->
<div class="tooltip bs-tooltip-top" role="tooltip">
<div class="arrow"></div>
<div class="tooltip-inner">
Some tooltip text!
</div>
</div>
Elements with the disabled
attribute are non interactive where users cannot focus, hover, or click them to trigger a tooltip (or popover). So you must 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.
You can set the options via data attributes or JavaScript. For data attributes, append the option name to data-
, as in data-animation=""
.
For individual tooltips you can set options data attribute.
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: |
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 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 | false | false | If a selector is provided, tooltip objects will be delegated to the specified targets. In practice, this is used to enable dynamic HTML content to have popovers added. See this and an informative example. |
template | string | '<div class="tooltip" role="tooltip"><div class="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 | number | string | 0 | Offset of the tooltip relative to its target. For more information refer to Popper.js's offset docs. |
fallbackPlacement | string | array | 'flip' | Allow to specify which position Popper will use on fallback. For more information refer to Popper.js's behavior docs |
boundary | string | element | 'scrollParent' | Overflow constraint boundary of the tooltip. Accepts the values of 'viewport' , 'window' , 'scrollParent' , or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's preventOverflow docs. |
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.
$().tooltip(options)
Attaches a tooltip handler to an element collection.
.tooltip('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.
$('#element').tooltip('show')
.tooltip('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.
$('#element').tooltip('hide')
.tooltip('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.
$('#element').tooltip('toggle')
.tooltip('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.
$('#element').tooltip('dispose')
.tooltip('enable')
Gives an element's tooltip the ability to be shown. Tooltips are enabled by default.
$('#element').tooltip('enable')
.tooltip('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.
$('#element').tooltip('disable')
.tooltip('toggleEnabled')
Toggles the ability for an element's tooltip to be shown or hidden.
$('#element').tooltip('toggleEnabled')
.tooltip('update')
Updates the position of an element's tooltip.
$('#element').tooltip('update')
Event Type | Description |
---|---|
show.bs.tooltip | This event fires immediately when the show instance method is called. |
shown.bs.tooltip | This event is fired when the tooltip has been made visible to the user (will wait for CSS transitions to complete). |
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 tooltip 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. |
$('#myTooltip').on('hidden.bs.tooltip', function () {
// do something…
})