Popover

Source: https://getbootstrap.com/docs/6.0/components/popover

Small, contextual overlays for displaying custom content and information via JavaScript.

Overview

Click the button below to show and close a popover.

<Example addStackblitzJs code={&lt;button type="button" class="btn-solid theme-primary" data-bs-toggle="popover" data-bs-title="Popover title" data-bs-content="This is the popover content—make it as long as you want."> Toggle popover &lt;/button>} />

Things to know when using the popover plugin:

  • Popovers rely on the third party library Floating UI for positioning. Use bootstrap.bundle.min.js which includes Floating UI, or include Floating UI separately via an import map.
  • Popovers require the popover plugin as a dependency.
  • Popovers are automatically initialized when using data-bs-toggle="popover".
  • 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.

Keep reading to see how popovers work with some examples.

Examples

Live demo

Titles are set via data-bs-title and body content is set via data-bs-content.

<Example addStackblitzJs code={&lt;button type="button" class="btn-solid theme-primary" data-bs-toggle="popover" data-bs-title="Popover title" data-bs-content="And here’s some amazing content. It’s very engaging. Right?"> Toggle popover &lt;/button>} />

Placement

Set data-bs-placement to change the direction. Four options are available: top, right, bottom, and left. Directions are mirrored when using Bootstrap in RTL.

<Example addStackblitzJs code={`<button type="button" class="btn-solid theme-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover"> Popover on left </button> <button type="button" class="btn-solid theme-secondary" 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-solid theme-secondary" 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-solid theme-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="right" data-bs-content="Right popover"> Popover on right </button>`} />

Responsive placement

Change placement at different breakpoints using responsive prefixes. The syntax is breakpoint:placement, where breakpoint is one of sm, md, lg, xl, or 2xl.

<Example addStackblitzJs code={&lt;button type="button" class="btn-solid theme-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top md:right lg:bottom" data-bs-content="This popover changes placement at different breakpoints."> Top → md:right → lg:bottom &lt;/button> &lt;button type="button" class="btn-solid theme-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left lg:top" data-bs-content="Responsive popover placement."> Left → lg:top &lt;/button>} />

Resize your browser to see the popover placement change at different breakpoints.

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'
})

Another situation where you’ll want to set an explicit custom container are popovers inside a dialog, to make sure that the popover itself is appended to the dialog. This is particularly important for popovers that contain interactive elements – dialogs will trap focus, so unless the popover is a child element of the dialog, users won’t be able to focus or activate these interactive elements.

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

Custom popovers

You can customize the appearance of popovers using CSS variables. We set a custom class with data-bs-custom-class="custom-popover" to scope our custom appearance and use it to override some of the local CSS variables.

<Example addStackblitzJs class="custom-popover-demo" code={&lt;button type="button" class="btn-solid theme-secondary" data-bs-toggle="popover" data-bs-placement="right" data-bs-custom-class="custom-popover" data-bs-title="Custom popover" data-bs-content="This popover is themed via CSS variables."> Custom popover &lt;/button>} />

Dismiss on next click

Use the focus trigger to dismiss popovers on the user’s next click of an element other than the toggle element. Clicks and focus inside the popover itself do not dismiss it, so users can select text or use controls in the content.

Dismissing on next click requires specific HTML for proper cross-browser and cross-platform behavior. You can only use <a> elements, not <button>s, and you must include a tabindex.

<Example addStackblitzJs code={&lt;a tabindex="0" class="btn-solid theme-secondary" 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 &lt;/a>} />

const popover = new bootstrap.Popover('.popover-dismiss', {
  trigger: 'focus'
})

A shown popover can also be dismissed by pressing the <kbd>Escape</kbd> key. As with dropdown menus, a popover shown inside a dialog is dismissed on its own: the first <kbd>Escape</kbd> closes the popover and a subsequent one closes the dialog.

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".

For disabled popover triggers, you may also prefer data-bs-trigger="hover focus" so that the popover appears as immediate visual feedback to your users as they may not expect to click on a disabled element.

<Example addStackblitzJs code={&lt;span class="d-inline-block rounded-3" tabindex="0" data-bs-toggle="popover" data-bs-trigger="hover focus" data-bs-content="Disabled popover"> &lt;button class="btn-solid theme-primary" type="button" disabled>Disabled button&lt;/button> &lt;/span>} />

CSS

Variables

Usage

Enable popovers via JavaScript:

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

Keep popovers accessible to keyboard and assistive technology users by only adding them to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). While other HTML elements can be made focusable by adding tabindex="0", this can create annoying and confusing tab stops on non-interactive elements for keyboard users, and most assistive technologies currently do not announce popovers 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.

Avoid adding an excessive amount of content in popovers with the html option. Once popovers are displayed, their content is tied to the trigger element with the aria-describedby attribute, causing all of the popover’s content to be announced to assistive technology users as one long, uninterrupted stream.

Popovers do not manage keyboard focus order, and their placement can be random in the DOM, so be careful when adding interactive elements (like forms or links), as it may lead to an illogical focus order or make the popover content itself completely unreachable for keyboard users. In cases where you must use these elements, consider using a dialog instead.

Via data attributes

Attribute Description
data-bs-toggle="popover" Initializes the popover on the trigger element.
data-bs-title Title content shown in the popover header.
data-bs-content Body content of the popover.
data-bs-placement Where to place the popover relative to the trigger.
data-bs-trigger How the popover opens (click, hover, focus, manual, or a combination).
data-bs-custom-class Extra class names added to the popover for theming.
data-bs-html When true, allows HTML in the title and content (use with care for untrusted input).

Dependencies

Options

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 An object containing allowed tags and attributes. Those not explicitly allowed will be removed by the content sanitizer. <Callout type="warning">Exercise caution when adding to this list. Refer to OWASP’s Cross Site Scripting Prevention Cheat Sheet for more information.</Callout>
animation boolean true Apply a CSS fade transition to the popover. Set it to false to add .popover-instant to the popover, which switches the fade off.
boundary string, element 'clippingParents' Overflow constraint boundary of the popover (applies only to Floating UI’s shift middleware). By default, it’s 'clippingParents' and can accept an HTMLElement reference (via JavaScript only). For more information refer to Floating UI’s shift 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 '' The popover’s text content. If a function is given, it will be called with the element it is attached to as its first argument, and with its this reference set to that same element.
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 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 Floating UI’s flip 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. Prefer text when dealing with user-generated input to prevent XSS attacks.
offset array, string, function [0, 8] 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 floating placement, the reference, and floating 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: crossAxis, mainAxis. For more information refer to Floating UI’s offset docs.
placement string, function 'right' How to position the popover: top, bottom, left, right. Supports responsive prefixes like 'top md:right lg:bottom' to change placement at different breakpoints. 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.
floatingConfig null, object, function null To change Bootstrap’s default Floating UI config, see Floating UI’s configuration. When a function is used to create the Floating UI configuration, it’s called with an object that contains the Bootstrap’s default Floating UI configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Floating UI.
sanitize boolean true Enable content sanitization. If true, the template, content and title options will be sanitized. <Callout type="warning">Exercise caution when disabling content sanitization. Refer to OWASP’s Cross Site Scripting Prevention Cheat Sheet for more information. Vulnerabilities caused solely by disabling content sanitization are not considered within scope for Bootstrap’s security model.</Callout>
sanitizeFn null, function null Provide an alternative content sanitization 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. Note: title attribute must not be used as a selector.
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 title will be injected into the .popover-header. The popover’s content will be injected into the .popover-body. .popover-arrow will become the popover’s arrow. The outermost wrapper element should have the .popover class and role="tooltip".
title string, element, function '' The popover title. If a function is given, it will be called with the element it is attached to as its first argument, and with its this reference set to that same element.
trigger string 'click' 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.