Popover

Popovers are containers used to display transient content such as menus, options, additional actions, and more in an overlay.

Contents

Bootstrap 5 Popover component

Responsive Popover built with the latest Bootstrap 5. Popovers containers used to display transient content such as menus, options, additional actions, and more in an overlay.

Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site.

Basic example

Popovers are opt-in for performance reasons, you must initialize popover yourself via js new bootstrap.Popover().

<button type="button" class="btn btn-primary" data-bs-toggle="popover" data-bs-content="Content">
  Open popover
</button>

Javascript

const element = document.querySelector("#target");
const popover = new bootstrap.popover(element);

Feel free to use either title or data-bs-title in your HTML. When title is used, Popper will replace it automatically with data-bs-title when the element is rendered.

<button type="button" class="btn btn-primary"
 data-bs-title="Popover title" data-bs-toggle="popover" 
 data-bs-content="And here's some amazing content. It's very engaging. Right?">
  Open popover with title
</button>

Overview

Things to know when using the popover plugin:

Popovers rely on the third party library Popper for positioning. You must include popper.min.js before bootstrap.js, or use one bootstrap.bundle.min.js which contains Popper.
Popovers are opt-in for performance reasons, so you must initialize them yourself.
Zero-length title and content values 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 .disabled or disabled elements 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-nowrap on 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.

Placement

There are four options are available: top, right, bottom, and left.

<button type="button" class="btn btn-primary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover">
  Popover on top
</button>
<button type="button" class="btn btn-primary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="right" data-bs-content="Right popover">
  Popover on right
</button>
<button type="button" class="btn btn-primary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-content="Bottom popover">
  Popover on bottom
</button>
<button type="button" class="btn btn-primary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover">
  Popover on left
</button>

Use the focus trigger to dismiss popovers on the user’s next click of a different element than the toggle element.

Dismissible popover

<a tabindex="0" class="btn btn-primary" role="button"
 data-bs-toggle="popover" 
 data-bs-trigger="focus" 
 data-bs-title="Dismissible popover" 
 data-bs-content="And here's some amazing content. It's very engaging. Right?">
  Dismissible popover
</a>

Specific markup required for dismiss-on-next-click

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.

Interactions

Mouse over event

Sets a data-bs-trigger="hover" attribute allows a popover will be triggered on mouse over an element. There are four options available: click, hover, focus, manual.

<button
  type="button"
  class="btn btn-primary"
  data-bs-toggle="popover"
  data-bs-trigger="hover"
  data-bs-content="I use popover.">
Hover with a Popover
</button>

Custom container

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. This is common in responsive tables, input groups, and the like.

const popover = new bootstrap.Popover(".example-popover", {
  container: "body",
});

Disabled elements

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>, ideally made keyboard-focusable using tabindex="0".

<span class="d-inline-block" 
  tabindex="0" 
  data-bs-toggle="popover" 
  data-bs-trigger="hover focus" 
  data-bs-content="Disabled popover">
<button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

Contents

Usage

Enable popovers via JavaScript:

const exampleEl = document.getElementById('example')
const popover = new bootstrap.Popover(exampleEl, options)

Making popovers work for keyboard and assistive technology users

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.

Options

As options can be passed via data attributes or JavaScript, you can append an option name to data-bs-, as in data-bs-animation="{value}". 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, use data-bs-custom-class="beautifier" instead of data-bs-customClass="beautifier".

As of Bootstrap 5.2.0, all components support an experimental reserved data attribute data-bs-config that can house simple component configuration as a JSON string. When an element has data-bs-config='{"delay":0, "title":123}' and data-bs-title="456" attributes, the final title value will be 456 and the separate data attributes will override values given on data-bs-config. In addition, existing data attributes are able to house JSON values like data-bs-delay='{"show":0,"hide":150}'.

Note that for security reasons the sanitize, sanitizeFn, and allowList options cannot be supplied using data attributes.

Name	Type	Default	Description
`allowList`	object	Default value	Object which contains allowed attributes and tags.
`animation`	boolean	`true`	Apply a CSS fade transition to the popover
`boundary`	string, element	`'clippingParents'`	Overflow constraint boundary of the popover (applies only to Popper’s preventOverflow modifier). By default, it’s `'clippingParents'` and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper’s detectOverflow docs.
`container`	string, element, false	`false`	Appends the popover to a specific element. Example: `container: 'body'`. This option is particularly useful in that it allows you to position the popover in the flow of the document near the triggering element - which will prevent the popover from floating away from the triggering element during a window resize.
`content`	string, element, function	`''`	Default content value if `data-bs-content` attribute isn’t present. If a function is given, it will be called with its `this` reference set to the element that the popover is attached to.
`customClass`	string, function	`''`	Add classes to the popover 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: `'class-1 class-2'`. 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 popover (ms)—doesn’t 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 }`.
`fallbackPlacements`	string, array	`['top', 'right', 'bottom', 'left']`	Define fallback placements by providing a list of placements in array (in order of preference). For more information refer to Popper’s behavior docs.
`html`	boolean	`false`	Allow HTML in the popover. If true, HTML tags in the popover’s `title` will be rendered in the popover. If false, `innerText` property will be used to insert content into the DOM. Use text if you’re worried about XSS attacks.
`offset`	number, string, function	`[0, 0]`	Offset of the popover relative to its target. You can pass a string in data attributes with comma separated values like: `data-bs-offset="10,20"`. 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: skidding, distance. For more information refer to Popper’s offset docs.
`placement`	string, function	`'top'`	How to position the popover: auto, top, bottom, left, right. When `auto` is specified, it will dynamically reorient the popover. 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 `this` context is set to the popover instance.
`popperConfig`	null, object, function	`null`	To change Bootstrap’s default Popper config, see Popper’s configuration. 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.
`sanitize`	boolean	`true`	Enable or disable the sanitization. If activated `'template'`, `'content'` and `'title'` options will be sanitized.
`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.
`selector`	string, false	`false`	If a selector is provided, popover objects will be delegated to the specified targets. In practice, this is used to also apply popovers to dynamically added DOM elements (`jQuery.on` support). See this issue and an informative example.
`template`	string	`'<div class="popover" role="popover"><div class="popover-arrow"></div><div class="popover-inner"></div></div>'`	Base HTML to use when creating the popover. The popover’s `title` will be injected into the `.popover-inner`. `.popover-arrow` will become the popover’s arrow. The outermost wrapper element should have the `.popover` class and `role="popover"`.
`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 popover is attached to.
`trigger`	string	`'hover focus'`	How popover is triggered: click, hover, focus, manual. You may pass multiple triggers; separate them with a space. `'manual'` indicates that the popover will be triggered programmatically via the `.popover('show')`, `.popover('hide')` and `.popover('toggle')` methods; this value cannot be combined with any other trigger. `'hover'` on its own will result in popovers 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.

Data attributes for individual popovers

Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.

Using function with `popperConfig`

const popover = new bootstrap.Popover(element, {
  popperConfig(defaultBsPopperConfig) {
    // const 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.

Method	Description
`disable`	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.
`dispose`	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.
`enable`	Gives an element’s popover the ability to be shown. Popovers are enabled by default.
`getInstance`	Static method which allows you to get the popover instance associated with a DOM element.
`getOrCreateInstance`	Static method which allows you to get the popover instance associated with a DOM element, or create a new one in case it wasn’t initialized
`hide`	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.
`setContent`	Gives a way to change the popover’s content after its initialization.
`show`	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.
`toggle`	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.
`toggleEnabled`	Toggles the ability for an element’s popover to be shown or hidden.
`update`	Updates the position of an element’s popover.

// getOrCreateInstance example
const popover = bootstrap.Popover.getOrCreateInstance('#example') // Returns a Bootstrap popover instance

// setContent example
myPopover.setContent({
  '.popover-header': 'another title',
  '.popover-body': 'another content'
})

The setContent method accepts an object argument, where each property-key is a valid string selector within the popover template, and each related property-value can be string | element | function | null

Events

Event	Description
`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.
`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).

const myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', () => {
  // do something...
})

Popover

Basic example

Overview

Placement

Dismiss popover

Specific markup required for dismiss-on-next-click

Interactions

Mouse over event

Custom container

Disabled elements

Usage

Making popovers work for keyboard and assistive technology users

Options

Data attributes for individual popovers

Using function with popperConfig

Methods

Asynchronous methods and transitions

Events

Using function with `popperConfig`