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

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.

Edit in sandbox 
        
            
            <button
              type="button"
              class="btn btn-lg btn-danger"
              data-mdb-toggle="popover"
              title="Popover title"
              data-mdb-content="And here's some amazing content. It's very engaging. Right?"
            >
              Click to toggle popover
            </button>

Overview

Things to know when using the popovers:

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

Four directions

Four options are available: top, right, bottom, and left aligned.

Edit in sandbox 
        
            
            <button
              type="button"
              class="btn btn-secondary"
              data-mdb-container="body"
              data-mdb-toggle="popover"
              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-toggle="popover"
              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-toggle="popover"
              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-toggle="popover"
              data-mdb-placement="left"
              data-mdb-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus."
            >
              Popover on left
            </button>

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.

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

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.

Edit in sandbox 
        
            
            <span class="d-inline-block" data-mdb-toggle="popover" data-mdb-content="Disabled popover">
              <button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
            </span>

Popovers - API

Usage

Via JavaScript:

Edit in sandbox 
        
            
            const exampleEl = document.getElementById('example')
            const popover = 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: 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-mdb-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 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: '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) - does not 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 }
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 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.

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

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 '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's offset docs.
fallbackPlacement string | array 'flip' 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 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 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
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.
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.
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.
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.
enable Gives an element’s popover the ability to be shown. Popovers are enabled by default.
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.
toggleEnabled Toggles the ability for an element’s popover to be shown or hidden.
update Updates the position of an element’s popover.
getInstance Static method which allows you to get the popover instance associated with a DOM element.
Edit in sandbox 
        
            
          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.
Edit in sandbox 
        
            
            const myPopoverTrigger = document.getElementById('myPopover')
            myPopoverTrigger.addEventListener('hidden.mdb.popover', () => {
              // do something...
            })

Import

MDB UI KIT also works with module bundlers. Use the following code to import this component:

Edit in sandbox 
        
            
            import { Popover } from 'mdb-ui-kit';