Bootstrap Popovers

In bootstrap, the popover component is same as tooltip to show the HTML elements content with a customized popup style when the user clicks on an element. The only difference is the popover will use title attribute content for header text and the data-content attribute content will be shown inside of the popover body.

 

In order to create the popover, the following attributes are required:

 

  • data-toggle="popover" attribute to toggle the popover feature for the selected element.
  • Fill in the title attribute for header text of popover and define the data-content attribute to specify the text that you want to get displayed inside of the popover body.
  • data-placement attribute it’s optional but required to set the direction of the popover on top, bottom, left or right side of the element.

Following is the example of creating the popover for required elements in bootstrap.

 

Live Preview

 

<a href="#" class="btn btn-primary" data-toggle="popover" title="Popover Header" data-content="Sample popover body content">Click me</a>

<button type="button" class="btn btn-primary" data-toggle="popover" title="Popover Header" data-content="Click me to save the page content" >Submit</button>

In bootstrap, the custom style popovers can be triggered with jQuery. So, you need to import the following script in order to initialize the popovers.

 

<script>

    $(function() {

        $('[data-toggle="popover"]').popover();

    });

</script>

The above example will return the result like as shown below.

 

Bootstrap popover example result

 

Similarly, the bootstrap popovers can be enabled for any element such as labels, images, input controls, etc. by adding the required attributes based on our requirements.

Bootstrap Popover Directions

By default, the bootstrap popover will appear on the right side of the element. However, you can change the direction of popover to top, left, right and bottom by using data-placement attribute.

 

Live Preview

 

<button class="btn btn-primary" data-toggle="popover" data-placement="top" title="Top Popover" data-content="Top popover content">Top Popover</button>

<button class="btn btn-primary" data-toggle="popover" data-placement="left" title="Left Popover" data-content="Left popover content">Left Popover</button>

<button class="btn btn-primary" data-toggle="popover" data-placement="right" title="Right Popover" data-content="Right popover content">Right Popover</button>

<button class="btn btn-primary" data-toggle="popover" data-placement="bottom" title="Bottom Popover" data-content="Bottom popover content">Bottom Popover</button>

The above example will return the result like as shown below.

 

Bootstrap popover directions example result

 

You need to remember that the placement of popovers will not work as expect in case if enough space is not available for them. For example, the top placement of popover will display bottom of the element in case if enough space is not available at the top.

Bootstrap Dismiss Popovers

By default, the popovers will close only when we click on the element again. In order to make popovers dismissible / close when losing the focus, or in other words when clicking on the outside of the element or other element you need to add data-trigger="focus" attribute.

 

Live Preview

 

<button class="btn btn-danger" data-toggle="popover" data-trigger="focus" title="Close Popover" data-content="Click outside of the element to close popover">Dismiss Popover</button>

The above example will return the result like as shown below.

 

Bootstrap dismiss / close popover example result

 

Similarly, you can use data-trigger attribute to open or display the popovers on element hover for that you need to add data-trigger="hover" attribute to the respective element.

 

Live Preview

 

<button class="btn btn-danger" data-toggle="popover" data-trigger="hover" title="Hover Popover" data-content="Hover on the button element to show the popover">Hover Popover</button>

The above example will return the result like as shown below.

 

Bootstrap show popover on hover example result

Bootstrap Popover Options

In bootstrap, you can pass the different options to popover() method to customize the popover based on your requirements.

 

Following are the few of important options which we can pass to popover() method in bootstrap.

 

NameTypeDefaultDescription
animation boolean true It is useful to set fade transition to the popover.
container string | false false It is useful to append the popover to a specific element.
delay number 0 It is useful to delay showing and hiding the popover (ms).
html boolean false It is useful to allow HTML in the popover.
placement string 'top' It is useful to specify the position of popover.
title string '' It is useful to set the popover text.
trigger string click' It is useful to set how popover to trigger - click | hover | focus | manual. You can pass multiple triggers by separating them with space.
offset number | string 0 It is useful to set offset of the popover relative to its target.

The above popover options can set either through the data attributes or JavaScript. Following is the example of passing the options through JavaScript to popover() method.

 

Live Preview

<script>

    $(function() {

        $('#toppover').popover({

            title: 'Top Popover',

            content: 'Top popover content',

            placement: 'top'

        });

        $('#lftpover').popover({

            title: 'Left Popover',

            content: 'Left popover content',

            placement: 'left'

        });

        $('#rgtpover').popover({

            title: 'Right Popover',

            content: '<b>Right</b> popover content',

            html: true,

            placement: 'right'

        });

        $('#btmpover').popover({

            title: 'Bottom Popover',

            content: 'Bottom popover content',

            placement: 'bottom',

            delay: {

                show: 0,

                hide: 300

            }

        });

    });

</script>

If you observe the above code, we are passing multiple options to popover() method by using JavaScript. 

Bootstrap Popover Methods

Same like above popover options, we have different popover() methods to show, hide, or toogle the popovers based on our requirements.

 

MethodDescription
.popover(options) It is useful to attach popover options.
.popover('show') It is useful to show the popover
.popover('hide') It is useful to hide the popover
.popover('toggle') It is useful to toggle the popover
.popover('dispose') It is useful to hide and destroy the popover
.popover('enable') It gives an element’s popover the ability to be shown.
.popover('disable') It remove the ability for an element’s popover to be shown.

Following is the example of using popover() methods to show, hide, or toggle the popover based on the button clicks in bootstrap.

 

Live Preview

<script>

    $(function() {

        $('#btnShow').click(function() {

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

        });

        $('#btnHide').click(function() {

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

        });

        $('#btnTgle').click(function() {

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

        });

    });

</script>

The above example will return the result like as shown below.

 

Bootstrap popover methods example result

Bootstrap Popover Events

In bootstrap, the popover classes are having few events for hooking into popover functionality to fire the events during showing or hiding the popovers.

 

EventDescription
show.bs.popover This event will trigger before the popover is shown.
shown.bs.popover This event will trigger after the popover is shown.
hide.bs.popover This event will trigger before the popover is hidden.
hidden.bs.popover This event will trigger after the popover is hidden
inserted.bs.popover This event will trigger after the show.bs.popover event, before the popover is shown.

Following is the example of using the events to show the alert message during showing and hiding the popover in bootstrap.

 

Live Preview

<script>

    $(function() {

        $('[data-toggle="popover"]').popover();

        $("#pover1").on('hidden.bs.popover', function() {

            alert('The popover1 is dismissed');

        });

        $("#pover2").on('show.bs.popover', function() {

            alert('The popover2 will be shown now');

        });

    });

</script>

This is how we can use the bootstrap popovers in our applications to show the HTML elements title, content attributes text on click/hover with a customized popup style based on our requirements. 

Topics Covered