Documentation and examples for adding Bootstrap popovers, like those found in iOS, to any element on your site.
Things to know when using the popover plugin:
bootstrap.js
, or use one bootstrap.bundle.min.js
which contains Popper.title
and content
values will never show a popover.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..text-nowrap
on your <a>
s to avoid this behavior.prefers-reduced-motion
media query. See the reduced motion section of our accessibility documentation.
Keep reading to see how popovers work with some examples.
As mentioned above, you must initialize popovers before they can be used. One way to initialize all popovers on a page would be to select them by their data-bs-toggle
attribute, like so:
const popoverTriggerList = document.querySelectorAll('[data-bs-toggle="popover"]')
const popoverList = [...popoverTriggerList].map(popoverTriggerEl => new bootstrap.Popover(popoverTriggerEl))
We use JavaScript similar to the snippet above to render the following live popover. Titles are set via data-bs-title
and body content is set via data-bs-content
.
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-lg btn-danger" data-bs-toggle="popover" data-bs-title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
Four options are available: top, right, bottom, and left. Directions are mirrored when using Bootstrap in RTL. Set data-bs-placement
to change the direction.
<button type="button" class="btn btn-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 btn-secondary" 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-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 btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover">
Popover on left
</button>
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 modal dialog, to make sure that the popover itself is appended to the modal. This is particularly important for popovers that contain interactive elements – modal dialogs will trap focus, so unless the popover is a child element of the modal, users won’t be able to focus or activate these interactive elements.
const popover = new bootstrap.Popover('.example-popover', {
container: '.modal-body'
})
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.
.custom-popover {
--bs-popover-max-width: 200px;
--bs-popover-border-color: var(--bs-primary);
--bs-popover-header-bg: var(--bs-primary);
--bs-popover-header-color: var(--bs-white);
--bs-popover-body-padding-x: 1rem;
--bs-popover-body-padding-y: .5rem;
}
<button type="button" class="btn btn-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
</button>
Use the focus
trigger to dismiss popovers on the user’s next click of a different element than the toggle element.
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.
<a tabindex="0" class="btn btn-lg btn-danger" 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>
const popover = new bootstrap.Popover('.popover-dismiss', {
trigger: 'focus'
})
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.
<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>