| layout | title | description | group | toc |
|---|---|---|---|---|
docs |
Popovers |
Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site. |
components |
true |
Things to know when using the popover plugin:
- Popovers rely on the 3rd party library Popper.js for positioning. You must include [popper.min.js]({{< param "cdn.popper" >}}) before bootstrap.js or use
bootstrap.bundle.min.js/bootstrap.bundle.jswhich contains Popper.js in order for popovers to work! - Popovers require the [tooltip plugin]({{< docsref "/components/tooltips" >}}) as a dependency.
- Popovers are opt-in for performance reasons, so you must initialize them yourself.
- Zero-length
titleandcontentvalues will never show a popover. - Specify
container: 'body'to avoid rendering problems in more complex components (like our input groups, button groups, etc). - Triggering popovers on hidden elements will not work.
- Popovers for
.disabledordisabledelements must be triggered on a wrapper element. - When triggered from anchors that wrap across multiple lines, popovers will be centered between the anchors' overall width. Use
.text-nowrapon your<a>s to avoid this behavior. - Popovers must be hidden before their corresponding elements have been removed from the DOM.
- Popovers can be triggered thanks to an element inside a shadow DOM.
{{< callout info >}} {{< partial "callout-info-prefersreducedmotion.md" >}} {{< /callout >}}
Keep reading to see how popovers work with some examples.
One way to initialize all popovers on a page would be to select them by their data-toggle attribute:
{{< highlight js >}} var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-toggle="popover"]')) var popoverList = popoverTriggerList.map(function (popoverTriggerEl) { return new bootstrap.Popover(popoverTriggerEl) }) {{< /highlight >}}
When you have some styles on a parent element that interfere with a popover, you'll want to specify a custom container so that the popover's HTML appears within that element instead.
{{< highlight js >}} var popover = new bootstrap.Popover(document.querySelector('.example-popover'), { container: 'body' }) {{< /highlight >}}
{{< example >}} Click to toggle popover {{< /example >}}
Four options are available: top, right, bottom, and left aligned.
{{< highlight html >}} Popover on top
Popover on rightPopover on bottom
Popover on left {{< /highlight >}}Use the focus trigger to dismiss popovers on the user's next click of a different element than the toggle element.
{{< callout danger >}}
For proper cross-browser and cross-platform behavior, you must use the <a> tag, not the <button> tag, and you also must include a tabindex attribute.
{{< /callout >}}
{{< example >}} Dismissible popover {{< /example >}}
{{< highlight js >}} var popover = new bootstrap.Popover(document.querySelector('.popover-dismiss'), { trigger: 'focus' }) {{< /highlight >}}
Elements with the disabled attribute aren't interactive, meaning users cannot hover or click them to trigger a popover (or tooltip). As a workaround, you'll want to trigger the popover from a wrapper <div> or <span> and override the pointer-events on the disabled element.
For disabled popover triggers, you may also prefer data-trigger="hover" so that the popover appears as immediate visual feedback to your users as they may not expect to click on a disabled element.
{{< example >}} Disabled button {{< /example >}}
Enable popovers via JavaScript:
{{< highlight js >}} var exampleEl = document.getElementById('example') var popover = new bootstrap.Popover(exampleEl, options) {{< /highlight >}}
{{< callout warning >}}
To allow keyboard users to activate your popovers, you should only add them 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 popover's content in this situation. Additionally, do not rely solely on hover as the trigger for your popovers, as this will make them impossible to trigger for keyboard users.
While you can insert rich, structured HTML in popovers with the html option, we strongly recommend that you avoid adding an excessive amount of content. The way popovers currently work is that, once displayed, their content is tied to the trigger element with the aria-describedby attribute. As a result, the entirety of the popover's content will be announced to assistive technology users as one long, uninterrupted stream.
Additionally, while it is possible to also include interactive controls (such as form elements or links) in your popover (by adding these elements to the allowList of allowed attributes and tags), be aware that currently the popover does not manage keyboard focus order. When a keyboard user opens a popover, focus remains on the triggering element, and as the popover usually does not immediately follow the trigger in the document's structure, there is no guarantee that moving forward/pressing TAB will move a keyboard user into the popover itself. In short, simply adding interactive controls to a popover is likely to make these controls unreachable/unusable for keyboard users and users of assistive technologies, or at the very least make for an illogical overall focus order. In these cases, consider using a modal dialog instead.
{{< /callout >}}
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".
{{< callout warning >}}
Note that for security reasons the sanitize, sanitizeFn, and allowList options cannot be supplied using data attributes.
{{< /callout >}}
| Name | Type | Default | Description |
|---|---|---|---|
animation |
boolean | true |
Apply a CSS fade transition to the popover |
container |
string | element | false | false |
Appends the popover to a specific element. Example: |
content |
string | element | function | '' |
Default content value if If a function is given, it will be called with its |
delay |
number | object | 0 |
Delay showing and hiding the popover (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 |
Insert HTML into the popover. If false, innerText property will be used to insert content into the DOM. Use text if you're worried about XSS attacks. |
placement |
string | function | 'right' |
How to position the popover - auto | top | bottom | left | right. When a function is used to determine the placement, it is called with the popover 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, popover 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="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
Base HTML to use when creating the popover. The popover's The popover'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 | 'click' |
How popover is triggered - click | hover | focus | manual. You may pass multiple triggers; separate them with a space. manual cannot be combined with any other trigger. |
offset |
number | string | 0 |
Offset of the popover 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 popover. 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', 'content' and 'title' options will be sanitized. |
allowList |
object | }}">Default value | 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 | null |
To change Bootstrap's default Popper.js config, see Popper.js's configuration |
{{< callout info >}}
Options for individual popovers can alternatively be specified through the use of data attributes, as explained above. {{< /callout >}}
{{< callout danger >}} {{< partial "callout-danger-async-methods.md" >}} {{< /callout >}}
Reveals an element's popover. Returns to the caller before the popover has actually been shown (i.e. before the shown.bs.popover event occurs). This is considered a "manual" triggering of the popover. Popovers whose title and content are both zero-length are never displayed.
{{< highlight js >}}myPopover.show(){{< /highlight >}}
Hides an element's popover. Returns to the caller before the popover has actually been hidden (i.e. before the hidden.bs.popover event occurs). This is considered a "manual" triggering of the popover.
{{< highlight js >}}myPopover.hide(){{< /highlight >}}
Toggles an element's popover. Returns to the caller before the popover has actually been shown or hidden (i.e. before the shown.bs.popover or hidden.bs.popover event occurs). This is considered a "manual" triggering of the popover.
{{< highlight js >}}myPopover.toggle(){{< /highlight >}}
Hides and destroys an element's popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using the selector option) cannot be individually destroyed on descendant trigger elements.
{{< highlight js >}}myPopover.dispose(){{< /highlight >}}
Gives an element's popover the ability to be shown. Popovers are enabled by default.
{{< highlight js >}}myPopover.enable(){{< /highlight >}}
Removes the ability for an element's popover to be shown. The popover will only be able to be shown if it is re-enabled.
{{< highlight js >}}myPopover.disable(){{< /highlight >}}
Toggles the ability for an element's popover to be shown or hidden.
{{< highlight js >}}myPopover.toggleEnabled(){{< /highlight >}}
Updates the position of an element's popover.
{{< highlight js >}}myPopover.update(){{< /highlight >}}
Static method which allows you to get the popover instance associated with a DOM element
{{< highlight js >}} var exampleTriggerEl = document.getElementById('example') var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance {{< /highlight >}}
| Event type | Description |
|---|---|
| show.bs.popover | This event fires immediately when the show instance method is called. |
| shown.bs.popover | This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete). |
| hide.bs.popover | This event is fired immediately when the hide instance method has been called. |
| hidden.bs.popover | This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete). |
| inserted.bs.popover | This event is fired after the show.bs.popover event when the popover template has been added to the DOM. |
{{< highlight js >}} var myPopoverTrigger = document.getElementById('myPopover') myPopoverTrigger.addEventListener('hidden.bs.popover', function () { // do something... }) {{< /highlight >}}