Mga Popover
Dokumentasyon at mga halimbawa para sa pagdaragdag ng Bootstrap popovers, tulad ng mga matatagpuan sa iOS, sa anumang elemento sa iyong site.
Pangkalahatang-ideya
Mga bagay na dapat malaman kapag ginagamit ang popover plugin:
- Umaasa ang mga Popover sa 3rd party na library na Popper para sa pagpoposisyon. Dapat mong isama ang popper.min.js bago ang bootstrap.js o gamitin ang
bootstrap.bundle.min.js
/bootstrap.bundle.js
na naglalaman ng Popper upang gumana ang mga popover! - Kinakailangan ng mga Popover ang tooltip plugin bilang dependency.
- Ang mga popover ay nag-opt-in para sa mga dahilan ng pagganap, kaya dapat mong simulan ang mga ito sa iyong sarili .
- Hindi kailanman magpapakita ng popover ang zero-length
title
at mga value.content
- Tukuyin
container: 'body'
upang maiwasan ang pag-render ng mga problema sa mas kumplikadong mga bahagi (tulad ng aming mga pangkat ng input, mga pangkat ng button, atbp). - Ang pag-trigger ng mga popover sa mga nakatagong elemento ay hindi gagana.
- Dapat na ma-trigger ang mga popover para sa
.disabled
o mgadisabled
elemento sa isang elemento ng wrapper. - Kapag na-trigger mula sa mga anchor na bumabalot sa maraming linya, ang mga popover ay igitna sa pagitan ng kabuuang lapad ng mga anchor. Gamitin
.text-nowrap
sa iyong<a>
s upang maiwasan ang pag-uugaling ito. - Dapat na itago ang mga popover bago maalis ang mga kaukulang elemento nito sa DOM.
- Maaaring ma-trigger ang mga popover salamat sa isang elemento sa loob ng shadow DOM.
prefers-reduced-motion
query ng media. Tingnan ang
seksyon ng pinababang paggalaw ng aming dokumentasyon ng accessibility .
Panatilihin ang pagbabasa upang makita kung paano gumagana ang mga popover kasama ang ilang mga halimbawa.
Halimbawa: Paganahin ang mga popover sa lahat ng dako
Ang isang paraan upang simulan ang lahat ng mga popover sa isang pahina ay ang piliin ang mga ito ayon sa kanilang data-bs-toggle
katangian:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Halimbawa: Gamit ang container
opsyon
Kapag mayroon kang ilang mga istilo sa isang parent na elemento na nakakasagabal sa isang popover, gugustuhin mong tumukoy ng custom container
upang ang HTML ng popover ay lumabas na lang sa loob ng elementong iyon.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Halimbawa
<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>
Apat na direksyon
Apat na opsyon ang magagamit: naka-align sa itaas, kanan, ibaba, at kaliwa. Ang mga direksyon ay sinasalamin kapag gumagamit ng Bootstrap sa 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>
I-dismiss sa susunod na pag-click
Gamitin ang focus
trigger upang i-dismiss ang mga popover sa susunod na pag-click ng user sa ibang elemento kaysa sa toggle na elemento.
Kinakailangan ang partikular na markup para sa dismiss-on-next-click
Para sa wastong cross-browser at cross-platform na pag-uugali, dapat mong gamitin ang <a>
tag, hindi ang <button>
tag, at dapat ka ring magsama ng tabindex
attribute.
<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'
})
Mga elementong may kapansanan
Ang mga elementong may disabled
attribute ay hindi interactive, ibig sabihin, hindi maaaring i-hover o i-click ng mga user ang mga ito upang mag-trigger ng popover (o tooltip). Bilang isang solusyon, gugustuhin mong i-trigger ang popover mula sa isang wrapper <div>
o <span>
, perpektong ginawang keyboard-focusable gamit ang tabindex="0"
.
Para sa mga na-disable na pag-trigger ng popover, maaari mo ring mas gusto data-bs-trigger="hover focus"
na ang popover ay lumitaw bilang agarang visual na feedback sa iyong mga user dahil maaaring hindi nila inaasahan na mag- click sa isang hindi pinaganang elemento.
<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
Mga variable
$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);
Paggamit
Paganahin ang mga popover sa pamamagitan ng JavaScript:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Ang paggawa ng mga popover ay gumagana para sa mga gumagamit ng keyboard at pantulong na teknolohiya
Upang payagan ang mga user ng keyboard na i-activate ang iyong mga popover, dapat mo lang silang idagdag sa mga elemento ng HTML na tradisyonal na nakatutok sa keyboard at interactive (tulad ng mga link o mga kontrol sa form). Bagama't ang mga di-makatwirang elemento ng HTML (tulad ng <span>
s) ay maaaring gawing focusable sa pamamagitan ng pagdaragdag ng tabindex="0"
attribute, magdaragdag ito ng potensyal na nakakainis at nakakalito na mga tab stop sa mga hindi interactive na elemento para sa mga user ng keyboard, at karamihan sa mga pantulong na teknolohiya ay kasalukuyang hindi nag-aanunsyo ng nilalaman ng popover sa sitwasyong ito. . Bukod pa rito, huwag umasa lamang hover
bilang trigger para sa iyong mga popover, dahil gagawin nitong imposibleng ma-trigger ang mga ito para sa mga user ng keyboard.
Bagama't maaari kang magpasok ng mayaman, structured na HTML sa mga popover na may html
opsyon, lubos naming inirerekomenda na iwasan mo ang pagdaragdag ng labis na dami ng nilalaman. Ang paraan ng kasalukuyang paggana ng mga popover ay, kapag naipakita na, ang kanilang nilalaman ay nakatali sa elemento ng pag-trigger na may aria-describedby
katangian. Bilang resulta, ang kabuuan ng nilalaman ng popover ay iaanunsyo sa mga gumagamit ng pantulong na teknolohiya bilang isang mahaba, walang patid na stream.
Bukod pa rito, habang posible ring isama ang mga interactive na kontrol (gaya ng mga elemento ng form o link) sa iyong popover (sa pamamagitan ng pagdaragdag ng mga elementong ito sa mga allowList
pinapayagang attribute at tag), tandaan na sa kasalukuyan ang popover ay hindi namamahala sa keyboard focus order. Kapag ang isang gumagamit ng keyboard ay nagbukas ng isang popover, ang focus ay nananatili sa nagti-trigger na elemento, at dahil ang popover ay karaniwang hindi kaagad sumusunod sa trigger sa istraktura ng dokumento, walang garantiya na ang paglipat ng pasulong/pagpindotTABililipat ang isang gumagamit ng keyboard sa mismong popover. Sa madaling salita, ang pagdaragdag lamang ng mga interactive na kontrol sa isang popover ay malamang na gawing hindi maabot/hindi magagamit ang mga kontrol na ito para sa mga gumagamit ng keyboard at mga gumagamit ng mga pantulong na teknolohiya, o sa pinakakaunti ay gumawa para sa isang hindi makatwirang pangkalahatang pagkakasunud-sunod ng focus. Sa mga kasong ito, isaalang-alang ang paggamit ng modal dialog sa halip.
Mga pagpipilian
Maaaring ipasa ang mga opsyon sa pamamagitan ng mga katangian ng data o JavaScript. Para sa mga katangian ng data, idagdag ang pangalan ng opsyon sa data-bs-
, tulad ng sa data-bs-animation=""
. Siguraduhing baguhin ang uri ng kaso ng pangalan ng opsyon mula sa camelCase patungo sa kebab-case kapag ipinapasa ang mga opsyon sa pamamagitan ng mga katangian ng data. Halimbawa, sa halip na gamitin ang data-bs-customClass="beautifier"
, gamitin ang data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, at
mga allowList
opsyon ay hindi maibibigay gamit ang mga katangian ng data.
Pangalan | Uri | Default | Paglalarawan |
---|---|---|---|
animation |
boolean | true |
Maglapat ng CSS fade transition sa popover |
container |
string | elemento | mali | false |
Idinaragdag ang popover sa isang partikular na elemento. Halimbawa: |
content |
string | elemento | function | '' |
Default na halaga ng nilalaman kung Kung ang isang function ay ibinigay, ito ay tatawagin kasama ang |
delay |
numero | bagay | 0 |
Pagkaantala sa pagpapakita at pagtatago ng popover (ms) - hindi nalalapat sa manu-manong uri ng pag-trigger Kung may ibinigay na numero, ilalapat ang pagkaantala sa parehong itago/ipakita Ang istraktura ng bagay ay: |
html |
boolean | false |
Ipasok ang HTML sa popover. Kung false, innerText gagamitin ang property para magpasok ng content sa DOM. Gumamit ng text kung nag-aalala ka tungkol sa mga pag-atake ng XSS. |
placement |
string | function | 'right' |
Paano iposisyon ang popover - auto | tuktok | ibaba | kaliwa | tama. Kapag ginamit ang isang function upang matukoy ang placement, tinatawag itong popover DOM node bilang unang argumento nito at ang triggering element na DOM node bilang pangalawa nito. Ang |
selector |
string | mali | false |
Kung may ibibigay na tagapili, ang mga bagay na popover ay idelegado sa mga tinukoy na target. Sa pagsasagawa, ito ay ginagamit upang paganahin ang dynamic na HTML na nilalaman na magkaroon ng mga popover na idinagdag. Tingnan ito at isang halimbawang nagbibigay-kaalaman . |
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 na gagamitin kapag gumagawa ng popover. Ang popover's Ang popover's
Ang pinakamalawak na elemento ng wrapper ay dapat magkaroon ng |
title |
string | elemento | function | '' |
Default na halaga ng pamagat kung Kung ang isang function ay ibinigay, ito ay tatawagin kasama ang |
trigger |
string | 'click' |
Paano na-trigger ang popover - i-click ang | mag-hover | focus | manwal. Maaari kang magpasa ng maraming trigger; paghiwalayin sila ng isang puwang. manual hindi maaaring isama sa anumang iba pang trigger. |
fallbackPlacements |
array | ['top', 'right', 'bottom', 'left'] |
Tukuyin ang mga fallback na placement sa pamamagitan ng pagbibigay ng listahan ng mga placement sa array (ayon sa kagustuhan). Para sa higit pang impormasyon sumangguni sa mga doc ng pag-uugali ng Popper |
boundary |
string | elemento | 'clippingParents' |
Overflow constraint boundary ng popover (nalalapat lang sa preventOverflow modifier ng Popper). Bilang default, ito 'clippingParents' ay at maaaring tumanggap ng isang HTMLElement reference (sa pamamagitan lamang ng JavaScript). Para sa higit pang impormasyon sumangguni sa detectOverflow docs ng Popper . |
customClass |
string | function | '' |
Magdagdag ng mga klase sa popover kapag ipinakita ito. Tandaan na ang mga klase na ito ay idaragdag bilang karagdagan sa anumang mga klase na tinukoy sa template. Upang magdagdag ng maraming klase, paghiwalayin ang mga ito ng mga puwang: Maaari ka ring magpasa ng function na dapat magbalik ng isang string na naglalaman ng mga karagdagang pangalan ng klase. |
sanitize |
boolean | true |
Paganahin o huwag paganahin ang sanitization. Kung activated 'template' , 'content' at 'title' ang mga opsyon ay ma-sanitize. Tingnan ang seksyon ng sanitizer sa aming dokumentasyon ng JavaScript . |
allowList |
bagay | Default na halaga | Bagay na naglalaman ng mga pinapayagang katangian at tag |
sanitizeFn |
null | function | null |
Dito maaari kang magbigay ng iyong sariling sanitize function. Maaari itong maging kapaki-pakinabang kung mas gusto mong gumamit ng nakalaang library para magsagawa ng sanitization. |
offset |
array | string | function | [0, 8] |
Offset ng popover na nauugnay sa target nito. Maaari kang magpasa ng string sa mga katangian ng data na may mga halagang pinaghihiwalay ng kuwit tulad ng: Kapag ang isang function ay ginamit upang matukoy ang offset, ito ay tinatawag na may isang bagay na naglalaman ng popper placement, ang reference, at popper rects bilang ang unang argumento nito. Ang triggering element na DOM node ay ipinasa bilang pangalawang argumento. Ang function ay dapat magbalik ng array na may dalawang numero: . Para sa higit pang impormasyon sumangguni sa mga offset na doc ng Popper . |
popperConfig |
null | bagay | function | null |
Upang baguhin ang default na Popper config ng Bootstrap, tingnan ang configuration ng Popper . Kapag ang isang function ay ginamit upang lumikha ng Popper configuration, ito ay tinatawag na may isang object na naglalaman ng default na Popper configuration ng Bootstrap. Tinutulungan ka nitong gamitin at pagsamahin ang default sa sarili mong configuration. Ang function ay dapat magbalik ng configuration object para sa Popper. |
Mga katangian ng data para sa mga indibidwal na popover
Ang mga opsyon para sa mga indibidwal na popover ay maaaring tukuyin sa pamamagitan ng paggamit ng mga katangian ng data, gaya ng ipinaliwanag sa itaas.
Paggamit ng function na maypopperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Paraan
Mga asynchronous na pamamaraan at paglipat
Ang lahat ng mga pamamaraan ng API ay asynchronous at nagsisimula ng isang paglipat . Bumalik sila sa tumatawag sa sandaling magsimula ang paglipat ngunit bago ito matapos . Bilang karagdagan, babalewalain ang isang method call sa isang transitioning component .
Tingnan ang aming dokumentasyon ng JavaScript para sa higit pang impormasyon .
palabas
Nagpapakita ng popover ng isang elemento. Bumabalik sa tumatawag bago aktwal na naipakita ang popover (ibig sabihin, bago shown.bs.popover
mangyari ang kaganapan). Ito ay itinuturing na isang "manual" na pag-trigger ng popover. Ang mga popover na ang pamagat at nilalaman ay parehong zero-length ay hindi kailanman ipinapakita.
myPopover.show()
tago
Itinatago ang popover ng isang elemento. Bumabalik sa tumatawag bago aktwal na naitago ang popover (ibig sabihin, bago hidden.bs.popover
mangyari ang kaganapan). Ito ay itinuturing na isang "manual" na pag-trigger ng popover.
myPopover.hide()
magpalipat-lipat
I-toggle ang popover ng isang elemento. Bumabalik sa tumatawag bago aktwal na naipakita o naitago ang popover (ibig sabihin, bago mangyari ang shown.bs.popover
o hidden.bs.popover
kaganapan). Ito ay itinuturing na isang "manual" na pag-trigger ng popover.
myPopover.toggle()
itapon
Itinatago at sinisira ang popover ng isang elemento (Tinatanggal ang nakaimbak na data sa elemento ng DOM). Ang mga popover na gumagamit ng delegasyon (na ginawa gamit ang selector
opsyon ) ay hindi maaaring isa-isang sirain sa mga elemento ng descendant na trigger.
myPopover.dispose()
paganahin
Nagbibigay ng kakayahang maipakita ang popover ng isang elemento. Ang mga popover ay pinagana bilang default.
myPopover.enable()
huwag paganahin
Tinatanggal ang kakayahang maipakita ang popover ng isang elemento. Maipapakita lang ang popover kung ito ay muling pinagana.
myPopover.disable()
toggleEnabled
I-toggle ang kakayahang maipakita o maitago ang popover ng isang elemento.
myPopover.toggleEnabled()
update
Ina-update ang posisyon ng popover ng isang elemento.
myPopover.update()
getInstance
Static na paraan na nagbibigay-daan sa iyong makuha ang popover instance na nauugnay sa isang elemento ng DOM
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Static na paraan na nagbibigay-daan sa iyong makuha ang popover instance na nauugnay sa isang elemento ng DOM, o gumawa ng bago kung sakaling hindi ito nasimulan
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
Mga kaganapan
Uri ng kaganapan | Paglalarawan |
---|---|
show.bs.popover | Agad na gagana ang kaganapang ito kapag show tinawag ang paraan ng instance. |
ipinapakita.bs.popover | Ang kaganapang ito ay pinapagana kapag ang popover ay ginawang nakikita ng user (maghihintay na makumpleto ang mga transition ng CSS). |
hide.bs.popover | Agad na pinapagana ang kaganapang ito kapag hide tinawag na ang paraan ng instance. |
hidden.bs.popover | Ang kaganapang ito ay pinapagana kapag ang popover ay tapos nang itago mula sa user (maghihintay para sa mga transition ng CSS na makumpleto). |
ipinasok.bs.popover | Ang kaganapang ito ay pinapagana pagkatapos ng show.bs.popover kaganapan kapag ang template ng popover ay naidagdag sa DOM. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})