Popovers
Bootstrap 5 Popover component
Responsive popover built with the latest Bootstrap 5. Popover is like a tooltip, but it can persist after hovering off. It allows displaying more content including header & footer.
Documentation and examples for adding popovers, like those found in iOS, to any element on your site.
Note: Read the API tab to find all available options and advanced customization
*
*
UMD autoinits are enabled
by default. This means that you don't need to initialize
the component manually. However if you are using MDBootstrap ES format then you should pass
the required components to the initMDB
method.
Basic example
Popovers are overlays that open on demand and are mainly used on elements to display more content on floating cards, triggered by clicking or hovering.
<button
type="button"
class="btn btn-lg btn-danger"
data-mdb-popover-init
data-mdb-ripple-init
title="Popover title"
data-mdb-content="And here's some amazing content. It's very engaging. Right?"
>
Click to toggle popover
</button>
// Initialization for ES Users
import { Popover, initMDB } from "mdb-ui-kit";
initMDB({ Popover });
Overview
Things to know when using the popovers:
- Popovers are opt-in for performance reasons, so you must initialize them yourself.
-
Zero-length
title
andcontent
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
ordisabled
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.
Four directions
Four options are available: top, right, bottom, and left aligned.
<button
type="button"
class="btn btn-secondary"
data-mdb-container="body"
data-mdb-ripple-init
data-mdb-popover-init
data-mdb-placement="top"
data-mdb-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus."
>
Popover on top
</button>
<button
type="button"
class="btn btn-secondary"
data-mdb-container="body"
data-mdb-ripple-init
data-mdb-popover-init
data-mdb-placement="right"
data-mdb-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus."
>
Popover on right
</button>
<button
type="button"
class="btn btn-secondary"
data-mdb-container="body"
data-mdb-ripple-init
data-mdb-popover-init
data-mdb-placement="bottom"
data-mdb-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus."
>
Popover on bottom
</button>
<button
type="button"
class="btn btn-secondary"
data-mdb-container="body"
data-mdb-ripple-init
data-mdb-popover-init
data-mdb-placement="left"
data-mdb-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus."
>
Popover on left
</button>
// Initialization for ES Users
import { Popover, initMDB } from "mdb-ui-kit";
initMDB({ Popover });
Dismiss on next click
Use the focus
trigger to dismiss popovers on the user’s next click of a different
element than the toggle element.
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.
<a
tabindex="0"
class="btn btn-lg btn-danger"
role="button"
data-mdb-ripple-init
data-mdb-popover-init
data-mdb-trigger="focus"
title="Dismissible popover"
data-mdb-content="And here's some amazing content. It's very engaging. Right?"
>
Dismissible popover
</a>
// Initialization for ES Users
import { Popover, initMDB } from "mdb-ui-kit";
initMDB({ Popover });
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>
and override
the pointer-events
on the disabled element.
For disabled popover triggers, you may also prefer data-mdb-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.
<span class="d-inline-block" data-mdb-ripple-init data-mdb-popover-init data-mdb-trigger="hover" data-mdb-content="Disabled popover">
<button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>
// Initialization for ES Users
import { Popover, initMDB } from "mdb-ui-kit";
initMDB({ Popover });
Popovers - API
Import
Importing components depends on how your application works. If you intend to use the MDBootstrap ES
format, you must
first import the component and then initialize it with the initMDB
method. If you are going to use the UMD
format,
just import the mdb-ui-kit
package.
import { Popover, initMDB } from "mdb-ui-kit";
initMDB({ Popover });
import "mdb-ui-kit"
Usage
Via data attributes
Using the Popovers component doesn't require any additional JavaScript code - simply add
data-mdb-popover-init
attribute to
toggle element
and use other data attributes to set all options.
For ES
format, you must first import and call the initMDB
method.
<button
type="button"
class="btn btn-lg btn-danger"
data-mdb-popconfirm-init
data-mdb-ripple-init
title="Popover title"
data-mdb-content="And here's some amazing content. It's very engaging. Right?"
>
Click to toggle popover
</button>
Via JavaScript:
const element = document.getElementById('example')
const instance = new Popover(exampleEl, options)
const element = document.getElementById('example')
const instance = new mdb.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
or 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
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to
data-mdb-
, as in data-mdb-animation=""
.
Note: For security reasons the sanitize
,
sanitizeFn
and allowList
options cannot be supplied using data
attributes.
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 |
null | string | element | function | '' |
Default content value if
If a function is given, it will be called with its
|
customClass |
string | function | '' |
Add classes to the tooltip 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: 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) - 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 |
array | string | function | [0, 8] | Offset of the popover relative to its target. For more information refer to Popper's offset docs. |
fallbackPlacement |
string | array | ['top', 'right', 'bottom', 'left'] | Allow to specify which position Popper will use on fallback. For more information refer to Popper's behavior docs |
boundary |
string | element | 'clippingParents' |
Overflow constraint boundary of the popover (applies only to Popper's preventOverflow
modifier). Accepts the values of
'viewport' , 'window' , 'scrollParent' , or an
HTMLElement reference (via JavaScript only). For more information refer to Popper's
detectOverflow docs.
|
sanitize |
boolean | true |
Enable or disable the sanitization. If activated 'template' ,
'content' and 'title' options will be sanitized.
|
allowList |
object | DefaultAllowlist |
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 | function | null |
To change Bootstrap's default Popper config, see Popper's configuration |
Data attributes for individual popovers:
Options for individual popovers can alternatively be specified through the use of data
attributes, as explained above.
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 | Example |
---|---|---|
show |
Reveals an element’s popover.
Returns to the caller before the popover has actually been shown
(i.e. before the shown.mdb.popover event occurs). This is considered a
“manual” triggering of the popover. Popovers whose title and content are both
zero-length are never displayed.
|
myPopover.show() |
hide |
Hides an element’s popover.
Returns to the caller before the popover has actually been hidden
(i.e. before the hidden.mdb.popover event occurs). This is considered a
“manual” triggering of the popover.
|
myPopover.hide() |
toggle |
Toggles an element’s popover.
Returns to the caller before the popover has actually been shown or hidden
(i.e. before the shown.mdb.popover or hidden.mdb.popover event
occurs). This is considered a “manual” triggering of the popover.
|
myPopover.toggle() |
dispose |
Hides and destroys an element’s popover. Popovers that use delegation (which are created
using
the selector option) cannot be
individually destroyed on descendant trigger elements.
|
myPopover.dispose() |
enable |
Gives an element’s popover the ability to be shown. Popovers are enabled by default. | myPopover.enable() |
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. | myPopover.disable() |
toggleEnabled |
Toggles the ability for an element’s popover to be shown or hidden. | myPopover.toggleEnabled() |
update |
Updates the position of an element’s popover. | myPopover.update({delay: { "show": 500, "hide": 100 }}) |
getInstance |
Static method which allows you to get the popover instance associated with a DOM element. | Popover.getInstance() |
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. | Popover.getOrCreateInstance() |
const exampleTriggerEl = document.getElementById('example')
const popover = new Popover(exampleTriggerEl)
popover.show()
const exampleTriggerEl = document.getElementById('example')
const popover = new mdb.Popover(exampleTriggerEl)
popover.show()
Events
Event type | Description |
---|---|
show.mdb.popover |
This event fires immediately when the show instance method is called.
|
shown.mdb.popover |
This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete). |
hide.mdb.popover |
This event is fired immediately when the hide instance method has been
called.
|
hidden.mdb.popover |
This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete). |
inserted.mdb.popover |
This event is fired after the show.mdb.popover event when the popover
template has been added to the DOM.
|
const myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.mdb.popover', () => {
// do something...
})
CSS variables
As part of MDB’s evolving CSS variables approach, popover now use local CSS variables on
.popover
for enhanced real-time customization. Values for the CSS variables are
set via Sass, so Sass customization is still supported, too.
// .popover
--#{$prefix}popover-zindex: #{$zindex-popover};
--#{$prefix}popover-max-width: #{$popover-max-width};
@include rfs($popover-font-size, --#{$prefix}popover-font-size);
--#{$prefix}popover-bg: #{$popover-bg};
--#{$prefix}popover-border-width: #{$popover-border-width};
--#{$prefix}popover-border-color: #{$popover-border-color};
--#{$prefix}popover-border-radius: #{$popover-border-radius};
--#{$prefix}popover-inner-border-radius: #{$popover-inner-border-radius};
--#{$prefix}popover-box-shadow: #{$popover-box-shadow};
--#{$prefix}popover-header-padding-x: #{$popover-header-padding-x};
--#{$prefix}popover-header-padding-y: #{$popover-header-padding-y};
@include rfs($popover-header-font-size, --#{$prefix}popover-header-font-size);
--#{$prefix}popover-header-color: #{$popover-header-color};
--#{$prefix}popover-header-bg: #{$popover-header-bg};
--#{$prefix}popover-body-padding-x: #{$popover-body-padding-x};
--#{$prefix}popover-body-padding-y: #{$popover-body-padding-y};
--#{$prefix}popover-body-color: #{$popover-body-color};
--#{$prefix}popover-arrow-width: #{$popover-arrow-width};
--#{$prefix}popover-arrow-height: #{$popover-arrow-height};
--#{$prefix}popover-arrow-border: var(--#{$prefix}popover-border-color);
--#{$prefix}popover-border-bottom-width: #{$popover-border-bottom-width};
SCSS variables
$popover-font-size: $font-size-sm;
$popover-bg: var(--#{$prefix}surface-bg);
$popover-max-width: 276px;
$popover-inner-border-radius: calc(
#{$popover-border-radius} - #{$popover-border-width}
);
$popover-header-font-size: $font-size-base;
$popover-header-bg: var(--#{$prefix}secondary-bg);
$popover-header-color: $headings-color;
$popover-header-padding-y: 0.5rem;
$popover-header-padding-x: $spacer;
$popover-body-color: var(--#{$prefix}surface-color);
$popover-body-padding-y: $spacer;
$popover-body-padding-x: $spacer;
$popover-arrow-width: 1rem;
$popover-arrow-height: 0.5rem;
$popover-arrow-color: $popover-bg;
$popover-arrow-outer-color: var(--#{$prefix}border-color-translucent);
$popover-box-shadow: $box-shadow-2;
$popover-border-radius: $border-radius-lg;
$popover-border-bottom-width: $border-width-alternate;
$popover-border-width: 1px;
$popover-border-color: var(--#{$prefix}divider-color);