Popover are similar to tooltip which looks like those found in iOS. You can add popover to any element on your site.
bootstrap.bundle.min.js
/ bootstrap.bundle.js
which contains Popper.js within ittitle
and content
values will never show a popover.container: 'body'
to avoid rendering problems in more complex components (like our input groups, button groups, etc)..disabled
or disabled
elements must be triggered on a wrapper element..text-nowrap
on your <a>
s to avoid this behavior.For any element that you need popover add the data-toggle="popover" attribute and your desired content in the data-content="data-toggle
attribute using $('[data-toggle="popover"]').popover()
.
By default popover will be shown on clicking the popover element. You can also trigger popover on hover using data-trigger="hover"
or focus using data-trigger="focus"
attributes. You can also trigger manually by data-trigger="manual"
and you will need additional setup which you learn later in this chapter.
$(function () {
$('[data-toggle="popover"]').popover()
})
Example: Using the container
option
Styles on a parent element will interfere with a popover, so you want to specify a custom container
so that the popover's HTML appears within that element instead.
$(function () {
$('.example-popover').popover({
container: 'body'
})
})
Four options are available to position popover on top, right, bottom, and left aligned.
If you want dismiss popovers on the user's next click of a different element than the toggle element(clicked anywhere outside of popover button) use the focus
trigger. You can set it either using data-trigger="focus" attribute for a particular element or using popover options trigger: 'focus' during initialization.
For proper cross-browser and cross-platform behavior, You must only use the <a>
tag and you also must include a tabindex
attribute. Don't use the <button>
tag.
$('.popover-dismiss').popover({
trigger: 'focus'
})
Popovers will not work with the disabled
attribute. As a workaround, you should trigger the popover on the wrapper element like <div>
or <span>
and override the pointer-events
on the disabled element.
Enable popovers via JavaScript
$('#example').popover(options)
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-
, as in data-animation=""
.
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 | string | element | function | '' |
Default content value if If a function is given, it will be called with its |
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, jQuery's text method 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 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="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 | number | string | 0 | Offset of the popover relative to its target. For more information refer to Popper.js's offset docs. |
fallbackPlacement | string | array | 'flip' | Allow to specify which position Popper will use on fallback. For more information refer to Popper.js's behavior docs |
boundary | string | element | 'scrollParent' | Overflow constraint boundary of the popover. Accepts the values of 'viewport' , 'window' , 'scrollParent' , or an HTMLElement reference (JavaScript only). For more information refer to Popper.js's preventOverflow docs. |
Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.
$().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.
$('#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.
$('#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.
$('#element').popover('toggle')
.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.
$('#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('update')
Updates the position of an element’s popover.
$('#element').popover('update')
Event Type | Description |
---|---|
show.bs.popover | This event fires immediately when the show instance method is called. |
shown.bs.popover | This event is fired when the popover has been made visible to the user (will wait for CSS transitions to complete). |
hide.bs.popover | This event is fired immediately when the hide instance method has been called. |
hidden.bs.popover | This event is fired when the popover has finished being hidden from the user (will wait for CSS transitions to complete). |
inserted.bs.popover | This event is fired after the show.bs.popover event when the popover template has been added to the DOM. |
$('#myPopover').on('hidden.bs.popover', function () {
// do something…
})