PopoversPRO

Provide additional context for elements using Bootstrap’s popover plugin.

Popovers provide a popup of content, such as text, on top of another element. This can be used to provide users with additional information when they desire.

Popovers rely on the 3rd party library Popper.js for positioning. Be sure to include it as a resource.
Popovers are opt-in for performance reasons, so you must initialize them yourself.
Specify container: ‘body' to avoid rendering problems in more complex components (like input groups, button groups, etc).
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.

Usage

Specify an element that may trigger a popover on click, by setting data-toggle="popover", title="“ and data-content="“ attributes.


<button type="button" class="btn 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>

and to initialize all popovers:


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

Customizing popovers

Placement

Change the location of the popover using data-placement="“ with options top, right, bottom and left.


<button type="button" class="btn btn-secondary" data-toggle="popover" data-placement="top" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on top
</button>

<button type="button" class="btn btn-secondary" data-toggle="popover" data-placement="right" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on right
</button>

<button type="button" class="btn btn-secondary" data-toggle="popover" data-placement="bottom" data-content="Vivamus
sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on bottom
</button>

<button type="button" class="btn btn-secondary" data-toggle="popover" data-placement="left" data-content="Vivamus sagittis lacus vel augue laoreet rutrum faucibus.">
  Popover on left
</button>

Dismiss on next click

Make the popover dismissable when clicking another element by setting the data-trigger="focus" attribute.

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


<a tabindex="0" class="btn 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>

On 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-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-trigger="hover" data-content="Popover on disabled element">
  <button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>

JavaScript behavior

Enable popovers via JavaScript as follows:


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

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-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.
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, 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 `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.
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 `title` will be injected into the `.popover-header`. The popover’s content will be injected into the `.popover-body`. `.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.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.
sanitize	boolean	true	Enable or disable the sanitization. If activated `'template'`, `'content'` and `'title'` options will be sanitized.
whiteList	object	Default value of Bootstrap sanitizer	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.

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
`$().popover(options)`	Activates your content as a popover. Accepts an optional options `object`.
`$().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.
`$().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.
`$().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 the `selector` option) cannot be individually destroyed on descendant trigger elements.
`$().popover('enable')`	Gives an element’s popover the ability to be shown. Popovers are enabled by default.
`$().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.
`$().popover('toggleEnabled')`	Toggles the ability for an element’s popover to be shown or hidden.
`$().popover('update')`	Updates the position of an element’s popover.

Events

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...
});

Parallax Progress