Popovers
Faʻamaumauga ma faʻataʻitaʻiga mo le faʻaopoopoina o Bootstrap popovers, pei o loʻo maua i iOS, i soʻo se elemene i luga o lau 'upega tafaʻilagi.
Vaaiga lautele
Mea e iloa pe a faʻaaogaina le popover plugin:
- Popovers fa'alagolago ile faletusi lona tolu Popper mo le fa'atulagaina. E tatau ona e aofia ai popper.min.js i luma o le bootstrap.js poʻo le faʻaoga
bootstrap.bundle.min.js
/bootstrap.bundle.js
o loʻo i ai Popper ina ia mafai ai ona galue popovers! - Popovers manaʻomia le meafaigaluega faʻapipiʻi e fai ma faʻalagolago.
- Popovers e filifili i totonu mo mafuaʻaga o faʻatinoga, o lea e tatau ai ona e amataina oe lava ia .
- Ole umi ole umi
title
macontent
tau o le a le fa'aalia se popover. - Fa'ama'oti
container: 'body'
e 'alofia ai le fa'atupuina o fa'afitauli i vaega e sili atu ona lavelave (pei o tatou vaega fa'aoga, vaega fa'amau, ma isi). - O le faʻaosoina o popovers i elemene natia o le a le aoga.
- Popovers mo
.disabled
po'odisabled
elemene e tatau ona fa'aoso i luga o se elemene afifi. - A fa'aoso mai taula e afifi i luga o le tele o laina, popovers o le a totonugalemu i le va o taula' lautele lautele. Fa'aoga
.text-nowrap
i lou<a>
s e aloese ai mai lenei amio. - Popovers e tatau ona natia aʻo leʻi aveesea a latou elemene tutusa mai le DOM.
- Popovers e mafai ona faʻaosoina faʻafetai i se elemene i totonu o se ata lafoia DOM.
prefers-reduced-motion
aufaasālalau. Va'ai le vaega
fa'aitiitiga fa'aitiitiga oa matou pepa fa'aoga avanoa .
Fa'aauau le faitau e va'ai pe fa'afefea ona fa'aoga popovers ma nisi fa'ata'ita'iga.
Fa'ata'ita'iga: Fa'amalo popovers i so'o se mea
O se tasi o auala e amata ai popovers uma i luga o se itulau o le filifilia lea e ala i o latou data-bs-toggle
uiga:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Faataitaiga: Faʻaaogaina le container
filifiliga
A iai ni au sitaili i luga o se elemene matua e faʻalavelave i se popover, e te manaʻo e faʻamaonia se aganuʻu container
ina ia faʻaalia le HTML o le popover i totonu o lena elemene nai lo.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Faataitaiga
<button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
Fa ituala
E fa filifiliga o lo'o avanoa: luga, taumatau, pito i lalo, ma agavale fa'aoga. E fa'aali fa'atonuga pe a fa'aogaina le Bootstrap ile RTL.
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover">
Popover on top
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="right" data-bs-content="Right popover">
Popover on right
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-content="Bottom popover">
Popover on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover">
Popover on left
</button>
Fa'ate'a ile isi kiliki
Fa'aoga le focus
fa'aoso e fa'ate'a ai popovers i le isi kiliki a le tagata fa'aoga o se elemene ese nai lo le elemene sui.
Fa'ailoga fa'apitoa e mana'omia mo le fa'ate'aina-i le isi-kiliki
Mo le fetaui lelei o le su'esu'ega ma le fa'aogaina o amioga, e tatau ona e fa'aogaina le <a>
pine, ae le o le <button>
pine, ma e tatau fo'i ona e aofia ai se tabindex
uiga.
<a tabindex="0" class="btn btn-lg btn-danger" role="button" data-bs-toggle="popover" data-bs-trigger="focus" title="Dismissible popover" data-bs-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>
var popover = new bootstrap.Popover(document.querySelector('.popover-dismiss'), {
trigger: 'focus'
})
Elemene le atoatoa
O elemene e iai le disabled
uiga e le fegalegaleai, o lona uiga e le mafai e tagata faʻaoga ona faʻafefe pe kiliki i latou e faʻaoso ai se popover (poʻo se meafaigaluega). I le avea ai o se fofo, e te manaʻo e faʻaoso le popover mai se afifi <div>
poʻo <span>
, faʻaoga lelei le faʻaogaina o le keyboard-faʻaaoga tabindex="0"
.
Mo fa'aoso popover fa'aletonu, atonu e te mana'o data-bs-trigger="hover focus"
fo'i ina ia fa'aalia le popover o se fa'aaliga va'aia vave i au tagata fa'aoga ona latou te le o fa'amoemoe e kiliki i luga o se elemene fa'aletonu.
<span class="d-inline-block" tabindex="0" data-bs-toggle="popover" data-bs-trigger="hover focus" data-bs-content="Disabled popover">
<button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>
Sass
Fuafuaga
$popover-font-size: $font-size-sm;
$popover-bg: $white;
$popover-max-width: 276px;
$popover-border-width: $border-width;
$popover-border-color: rgba($black, .2);
$popover-border-radius: $border-radius-lg;
$popover-inner-border-radius: subtract($popover-border-radius, $popover-border-width);
$popover-box-shadow: $box-shadow;
$popover-header-bg: shade-color($popover-bg, 6%);
$popover-header-color: $headings-color;
$popover-header-padding-y: .5rem;
$popover-header-padding-x: $spacer;
$popover-body-color: $body-color;
$popover-body-padding-y: $spacer;
$popover-body-padding-x: $spacer;
$popover-arrow-width: 1rem;
$popover-arrow-height: .5rem;
$popover-arrow-color: $popover-bg;
$popover-arrow-outer-color: fade-in($popover-border-color, .05);
Fa'aoga
Fa'amalo popovers e ala i le JavaScript:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Making popovers work for keyboard and assistive technology users
To allow keyboard users to activate your popovers, you should only add them to HTML elements that are traditionally keyboard-focusable and interactive (such as links or form controls). Although arbitrary HTML elements (such as <span>
s) can be made focusable by adding the tabindex="0"
attribute, this will add potentially annoying and confusing tab stops on non-interactive elements for keyboard users, and most assistive technologies currently do not announce the popover’s content in this situation. Additionally, do not rely solely on hover
as the trigger for your popovers, as this will make them impossible to trigger for keyboard users.
While you can insert rich, structured HTML in popovers with the html
option, we strongly recommend that you avoid adding an excessive amount of content. The way popovers currently work is that, once displayed, their content is tied to the trigger element with the aria-describedby
attribute. As a result, the entirety of the popover’s content will be announced to assistive technology users as one long, uninterrupted stream.
Additionally, while it is possible to also include interactive controls (such as form elements or links) in your popover (by adding these elements to the allowList
of allowed attributes and tags), be aware that currently the popover does not manage keyboard focus order. When a keyboard user opens a popover, focus remains on the triggering element, and as the popover usually does not immediately follow the trigger in the document’s structure, there is no guarantee that moving forward/pressing TAB will move a keyboard user into the popover itself. In short, simply adding interactive controls to a popover is likely to make these controls unreachable/unusable for keyboard users and users of assistive technologies, or at the very least make for an illogical overall focus order. In these cases, consider using a modal dialog instead.
Options
Options can be passed via data attributes or JavaScript. For data attributes, append the option name to data-bs-
, as in data-bs-animation=""
. Make sure to change the case type of the option name from camelCase to kebab-case when passing the options via data attributes. For example, instead of using data-bs-customClass="beautifier"
, use data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, and
allowList
options cannot be supplied using data attributes.
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, innerText property 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 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="popover-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. |
fallbackPlacements |
array | ['top', 'right', 'bottom', 'left'] |
Define fallback placements by providing a list of placements in array (in order of preference). For more information refer to Popper's behavior docs |
boundary |
string | element | 'clippingParents' |
Overflow constraint boundary of the popover (applies only to Popper's preventOverflow modifier). By default it's 'clippingParents' and can accept an HTMLElement reference (via JavaScript only). For more information refer to Popper's detectOverflow docs. |
customClass |
string | function | '' |
Add classes to the popover when it is shown. Note that these classes will be added in addition to any classes specified in the template. To add multiple classes, separate them with spaces: You can also pass a function that should return a single string containing additional class names. |
sanitize |
boolean | true |
Enable or disable the sanitization. If activated 'template' , 'content' and 'title' options will be sanitized. See the sanitizer section in our JavaScript documentation. |
allowList |
object | Default value | 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. |
offset |
array | string | function | [0, 8] |
Offset of the popover relative to its target. You can pass a string in data attributes with comma separated values like: When a function is used to determine the offset, it is called with an object containing the popper placement, the reference, and popper rects as its first argument. The triggering element DOM node is passed as the second argument. The function must return an array with two numbers: For more information refer to Popper's offset docs. |
popperConfig |
null | object | function | null |
To change Bootstrap's default Popper config, see Popper's configuration. When a function is used to create the Popper configuration, it's called with an object that contains the Bootstrap's default Popper configuration. It helps you use and merge the default with your own configuration. The function must return a configuration object for Popper. |
Data attributes for individual popovers
Options for individual popovers can alternatively be specified through the use of data attributes, as explained above.
Using function with popperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
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.
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 title and content are both zero-length are never displayed.
myPopover.show()
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.
myPopover.hide()
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.
myPopover.toggle()
dispose
Hides and destroys an element’s popover (Removes stored data on the DOM element). Popovers that use delegation (which are created using the selector
option) cannot be individually destroyed on descendant trigger elements.
myPopover.dispose()
enable
Gives an element’s popover the ability to be shown. Popovers are enabled by default.
myPopover.enable()
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.
myPopover.disable()
toggleEnabled
Toggles the ability for an element’s popover to be shown or hidden.
myPopover.toggleEnabled()
update
Updates the position of an element’s popover.
myPopover.update()
getInstance
Static method which allows you to get the popover instance associated with a DOM element
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Static method which allows you to get the popover instance associated with a DOM element, or create a new one in case it wasn’t initialized
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
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. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})