Popovers

    Things to know when using the popover plugin:

    • Popovers rely on the 3rd party library Popper.js for positioning. You must include before bootstrap.js or use / bootstrap.bundle.js which contains Popper.js in order for popovers to work!
    • Popovers require the tooltip plugin as a dependency.
    • If you’re building our JavaScript from source, it .
    • 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.

    The animation effect of this component is dependent on the prefers-reduced-motion media query. See the reduced motion section of our accessibility documentation.

    Keep reading to see how popovers work with some examples.

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

    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.

    1. $(function () {
    2. $('.example-popover').popover({
    3. container: 'body'
    4. })
    5. })

    1. <button type="button" class="btn btn-lg btn-danger" 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 options are available: top, right, bottom, and left aligned.

    Popovers  - 图2

    1. <button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
    2. Popover on top
    3. </button>
    4. <button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
    5. </button>
    6. <button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="bottom" data-content="Vivamus
    7. sagittis lacus vel augue laoreet rutrum faucibus.">
    8. Popover on bottom
    9. </button>
    10. <button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
    11. Popover on left
    12. </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

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

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

    Popovers  - 图4

    1. <span class="d-inline-block" data-toggle="popover" data-content="Disabled popover">
    2. <button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
    3. </span>

    Enable popovers via JavaScript:

    1. $('#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="".

    Note that for security reasons the sanitize, sanitizeFn and whiteList options cannot be supplied using data attributes.

    Data attributes for individual popovers

    Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.

    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)

    Initializes popovers for an element collection.

    .popover('show')

    Reveals an element’s popover. 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 whose both title and content are zero-length are never displayed.

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

    .popover('hide')

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

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

    .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.bs.popover or hidden.bs.popover event occurs). This is considered a “manual” triggering of the popover.

    .popover('dispose')

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

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

    .popover('enable')

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

    1. $('#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.

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

    .popover('toggleEnabled')

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

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

    .popover('update')

    Updates the position of an element’s popover.

    Events

    Event TypeDescription
    show.bs.popoverThis event fires immediately when the show instance method is called.
    shown.bs.popoverThis event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete).
    hide.bs.popoverThis event is fired immediately when the hide instance method has been called.
    hidden.bs.popoverThis event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete).
    inserted.bs.popoverThis event is fired after the show.bs.popover event when the popover template has been added to the DOM.
    1. $('#myPopover').on('hidden.bs.popover', function () {