Tooltips

Show content in tooltips on elements, by hovering over an element.

Similar to popovers, tooltips provide a tooltip of content, such as text, on top of another element. This can be used to provide users with additional information when they hover over an element.

Tooltips rely on the 3rd party library Popper.js for positioning. Be sure to include it as a resource.
Tooltips are opt-in for performance reasons, so you must initialize them yourself.
Specify container: ‘body' to avoid rendering problems in more complex components (like input groups, button groups, etc).
Tooltips for .disabled or disabled elements must be triggered on a wrapper element.
When triggered from anchors that wrap across multiple lines, tooltips will be centered between the anchors’ overall width. Use .text-nowrap on your <a>s to avoid this behavior.
Tooltips must be hidden before their corresponding elements have been removed from the DOM.

Usage

Specify an element that may trigger a tooltip, by setting data-toggle="tooltip", data-placement="top" and title="Tooltip on top"


<button type="button" class="btn btn-danger" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
	Hover to show tooltip
</button>

and to initialize all tooltips:


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

Customizing tooltips

Placement

Change the location of the tooltip using data-placement="“ with options top, right, bottom and left.


<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
 	Tooltip on top
</button>

<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">
 	Tooltip on right
</button>

<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">
 	Tooltip on bottom
</button>

<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
	Tooltip on left
</button>

With HTML

You can also add custom HTML as content, by specifying data-html="true"


<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" data-placement="top" title="<b>Look!</b> <i>it's</i> <u>HTML!</u>">
 	Tooltip on top
</button>

JavaScript behavior

Enable tooltips via JavaScript as follows:


$('#example').tooltip(options)

Options

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

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: `container: ‘body'`. 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.
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: `delay: { “show”: 500, “hide”: 100 }`
html	boolean	false	Allow HTML into the tooltip. If true, HTML tags in the tooltip’s `title` will be rendered in the tooltip. If false, jQuery’s `text` method will be used to insert content into the DOM. If false, jQuery’s `text` method will be used to insert content into the DOM. Use text if you’re worried about XSS attacks.
placement	string, function	‘top’	How to position the tooltip - `auto`, `top`, `bottom`, `left`, `right`. When `auto` 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 `this` context is set to the tooltip instance.
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 tooltips added.
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 `title` will be injected into the `.tooltip-inner`. `.arrow` will become the tooltip’s arrow. The outermost wrapper element should have the `.tooltip` class and `role="tooltip"`.
title	string, element, function	'’	Default title value if `title` attribute isn’t present. If a function is given, it will be called with its `this` reference set to the element that the tooltip is attached to.
trigger	string	‘hover focus’	How tooltip is triggered: `click`, `hover`, `focus`, `manual`. You may pass multiple triggers; separate them with a space. `manual` indicates that the tooltip will be triggered programmatically via the `.tooltip(‘show’)`, `.tooltip(‘hide’)` and `.tooltip(‘toggle’)` methods; this value cannot be combined with any other trigger. `hover` 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.
offset	number, string, function	0	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.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.
sanitize	boolean	true	Enable or disable the sanitization. If activated `'template'` and `'title'` options will be sanitized.
whiteList	object	Default value of Bootstrap sanitizer	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.

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.

Method	Description
`$().tooltip(options)`	Activates your content as a tooltip. Accepts an optional options `object`.
`$().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-lenght titles are never displayed.
`$().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.
`$().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.
`$().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.
`$().tooltip('enable')`	Gives an element’s tooltip the ability to be shown. Tooltips are enabled by default.
`$().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.
`$().tooltip('toggleEnabled')`	Toggles the ability for an element’s tooltip to be shown or hidden.
`$().tooltip('update')`	Updates the position of an element’s tooltip.

Events

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...
});

Toasts Utilities