Popovers

Bootstrap popovers

Note: We are transitioning MDB4 to a legacy version and focusing on developing MDB5. While we'll continue to support for the transition period, we encourage you to migrate to MDB5. We're offering a huge discount on MDB5 PRO to help with your transition, enabling you to leverage the full potential of the latest version. You can find more information here.
upgrade with discount

Here is 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:

• Popovers rely on the 3rd party library Popper.js for positioning. You must include popper.min.js before bootstrap.js in order for popovers to work!
• 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 hyperlinks that span multiple lines, popovers will be centered. Use white-space: nowrap; on your <a>s to avoid this behavior.
• Popovers must be hidden before their corresponding elements have been removed from the DOM.

Keep reading to see how popovers work with some examples.

Example: Enable popovers everywhere

One way to initialize all popovers on a page would be to select them by their data-toggle attribute:

        
            

        // popovers Initialization
        $(function () {
          $('[data-toggle="popover"]').popover()
        })

      
        
    

Example: Using the container option

When you have some styles on a parent element that interfere with a popover, you’ll need to specify a custom container so that the popover’s HTML appears within that element instead.

        
            

        // popovers Initialization
        $(function () {
          $('.example-popover').popover({
            container: 'body'
          })
        })

      
        
    

Example

Click the button below to see tooltip.

        
            

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

      
        
    

Four directions

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

        
            

        <button type="button" class="btn btn-primary" data-toggle="popover" data-placement="top" title="popover on top"
          data-content="Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.">popover
          on top</button>

        <button type="button" class="btn btn-primary" data-toggle="popover" data-placement="right" title="popover on right"
          data-content="Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.">popover
          on right</button>

        <button type="button" class="btn btn-primary" data-toggle="popover" data-placement="bottom" title="popover on bottom"
          data-content="Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.">popover
          on bottom</button>

        <button type="button" class="btn btn-primary" data-toggle="popover" data-placement="left" title="popover on left"
          data-content="Sed posuere consectetur est at lobortis. Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum.">popover
          on left</button>

      
        
    

Dismiss on next click

Use the focus trigger to dismiss popovers on the next click that the user makes.

As a specific markup is 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-toggle="popover" data-trigger="focus" title="Dismissible popover"
          data-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>

      
        
    

        
            

        $('.popover-dismiss').popover({
          trigger: 'focus'
        })

      
        
    

Disabled elements

Elements with the disabled attribute aren’t interactive, meaning users cannot hover or click on them to trigger a popover (or tooltip). As a workaround, you’ll need 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-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-toggle="popover" data-content="Disabled popover">
          <button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
        </span>

      
        
    

Example: Popover with image

This simple example shows how to place an image within a bootstrap popover. You can define if you want to launch the popover on hover or on click.

        
            

        <a class="btn btn-primary" data-toggle="popover-hover" data-img="https://mdbootstrap.com/img/logo/mdb192x192.webp">Hover
          me</a>
        <a class="btn btn-indigo" data-toggle="popover-click" data-img="https://mdbootstrap.com/img/Others/documentation/img%20(30)-mini.webp">Click
          me</a>
        <a class="btn btn-dark-green" data-toggle="popover-hover" data-img="//placehold.it/100x50">Hover over me</a>
        <a class="btn btn-purple" data-toggle="popover-click" data-img="//placehold.it/50x50">Click me</a>

      
        
    

        
            

          // popovers initialization - on hover
          $('[data-toggle="popover-hover"]').popover({
            html: true,
            trigger: 'hover',
            placement: 'bottom',
            content: function () { return '<img src="' + $(this).data('img') + '" />'; }
          });

          // popovers initialization - on click
          $('[data-toggle="popover-click"]').popover({
            html: true,
            trigger: 'click',
            placement: 'bottom',
            content: function () { return '<img src="' + $(this).data('img') + '" />'; }
          });
        
        
    

Usage

Enable popovers via JavaScript:

        
            

        $('#example').popover(options)

      
        
    

Options

Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-, as in data-animation="".

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.

$().popover(options)

Attaches a popover handler to an element collection.

.popover('show')

Reveals an element’s popover. It 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 with zero-length titles are never displayed.

        
            

        $('#element').popover('show');

      
        
    

.popover('hide')

Hides an element’s popover. It 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.

        
            

        $('#element').popover('hide');

      
        
    

.popover('toggle')

Toggles an element’s popover. It 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.

        
            

        $('#element').popover('toggle');

      
        
    

.popover('dispose')

Hides and destroys an element’s popover. Popovers that use delegation (those that are created using the selector option) cannot be individually destroyed on descendant trigger elements.

        
            

        $('#element').popover('dispose');

      
        
    

.popover('enable')

Gives an element’s popover the ability to be shown. Popovers are enabled by default.

        
            

        $('#element').popover('enable');

      
        
    

.popover('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.

        
            

        $('#element').popover('disable');

      
        
    

.popover('toggleEnabled')

Toggles the ability for an element’s popover to be shown or hidden.

        
            

        $('#element').popover('toggleEnabled');

      
        
    

.popover('updateupdate')

Updates the position of an element’s popover.

        
            

        $('#element').popover('update');

      
        
    

Events

        
            

        $('#myPopover').on('hidden.bs.popover', function () {
          // do something…
        })