Popovers
Skjöl og dæmi til að bæta Bootstrap popover, eins og þeim sem finnast í iOS, við hvaða þátt sem er á síðunni þinni.
Yfirlit
Atriði sem þarf að vita þegar popover viðbótin er notuð:
- Popovers treysta á þriðja aðila bókasafnið Popper fyrir staðsetningu. Þú verður að hafa popper.min.js fyrir bootstrap.js eða nota
bootstrap.bundle.min.js
/bootstrap.bundle.js
sem inniheldur Popper til að popovers virki! - Popovers krefjast tooltip viðbótarinnar sem ósjálfstæði.
- Popovers eru valdir af frammistöðuástæðum, svo þú verður að frumstilla þá sjálfur .
- Núll-lengd
title
ogcontent
gildi munu aldrei sýna popover. - Tilgreindu
container: 'body'
til að forðast að skila vandamálum í flóknari íhlutum (eins og inntakshópum okkar, hnappahópum osfrv.). - Það mun ekki virka að kveikja á popover á földum þáttum.
- Popovers fyrir
.disabled
eðadisabled
þætti verður að kveikja á umbúðaeiningu. - Þegar kveikt er á akkerum sem sveiflast yfir margar línur, verða sprettigluggar miðaðir á milli heildarbreiddar akkeranna. Notaðu
.text-nowrap
á þinn<a>
s til að forðast þessa hegðun. - Fela verður popover áður en samsvarandi þættir þeirra hafa verið fjarlægðir úr DOM.
- Hægt er að kveikja á popover þökk sé frumefni inni í skugga DOM.
prefers-reduced-motion
miðlunarfyrirspurninni. Sjá
kaflann um minni hreyfingu í aðgengisskjölunum okkar .
Haltu áfram að lesa til að sjá hvernig popovers virka með nokkrum dæmum.
Dæmi: Virkja popover alls staðar
Ein leið til að frumstilla alla sprettiglugga á síðu væri að velja þá eftir data-bs-toggle
eiginleikum þeirra:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Dæmi: Notkun container
valmöguleikans
Þegar þú ert með einhverja stíla á móðureiningu sem truflar sprettiglugga, viltu tilgreina sérsniðinn container
þannig að HTML sprettigluggans birtist innan þess þáttar í staðinn.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Dæmi
<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>
Fjórar áttir
Fjórir valkostir eru í boði: efst, hægri, neðst og vinstri stillt. Leiðbeiningar eru speglaðar þegar Bootstrap er notað í 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>
Hunsa við næsta smell
Notaðu focus
kveikjuna til að hafna sprettiglugga þegar notandinn smellir næst á annan þátt en skiptaeininguna.
Sérstök merking er nauðsynleg til að hafna-við-næsta-smelli
Fyrir rétta hegðun milli vafra og vettvanga verður þú að nota <a>
merkið, ekki merkið <button>
, og þú verður líka að innihalda tabindex
eigind.
<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'
})
Óvirkir þættir
Þættir með disabled
eigindinni eru ekki gagnvirkir, sem þýðir að notendur geta ekki sveiflað eða smellt á þá til að kalla fram sprettiglugga (eða tólábendingu). Sem lausn, þú vilt kveikja á popover frá umbúðum <div>
eða <span>
, helst gert lyklaborðsfókus með því að nota tabindex="0"
.
Fyrir óvirka sprettiglugga, gætirðu líka viljað data-bs-trigger="hover focus"
að sprettigluggan birtist sem tafarlaus sjónræn endurgjöf til notenda þinna þar sem þeir búast kannski ekki við að smella á óvirkan þátt.
<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
Breytur
$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);
Notkun
Virkja popover í gegnum JavaScript:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Að láta popover virka fyrir notendur lyklaborðs og hjálpartækja
Til að leyfa lyklaborðsnotendum að virkja sprettiglugga þína, ættirðu aðeins að bæta þeim við HTML þætti sem venjulega eru með lyklaborðsfókus og gagnvirkir (svo sem tenglar eða formstýringar). Þrátt fyrir að hægt sé að gera handahófskennda HTML þætti (eins og <span>
s) fókusanlega með því að bæta tabindex="0"
eigindinni við, mun þetta bæta við hugsanlega pirrandi og ruglingslegum flipastoppum á ógagnvirka þætti fyrir lyklaborðsnotendur, og flestar hjálpartækni tilkynnir ekki efni sprettigluggans í þessum aðstæðum. . Að auki, ekki treysta eingöngu á hover
sem kveikjuna fyrir popovers þína, þar sem þetta mun gera þá ómögulegt að kveikja á lyklaborðsnotendum.
Þó að þú getir sett inn innihaldsríkt, skipulagt HTML í sprettiglugga með html
möguleikanum, mælum við eindregið með því að þú forðast að bæta við of miklu magni af efni. Leiðin sem sprettigluggar virka nú er að þegar það hefur verið birt er innihald þeirra bundið við kveikjuþáttinn með aria-describedby
eigindinni. Fyrir vikið verður allt innihald popoversins tilkynnt notendum hjálpartækja sem einn langur, samfelldur straumur.
Að auki, þó að það sé einnig mögulegt að innihalda gagnvirkar stýringar (eins og formþætti eða tengla) í popover þinn (með því að bæta þessum þáttum við allowList
leyfilega eiginleika og merki), skaltu vera meðvitaður um að sem stendur stýrir popover ekki fókusröð lyklaborðs. Þegar lyklaborðsnotandi opnar sprettiglugga, er einbeitingin áfram á kveikjuhlutanum og þar sem sprettiglugginn fylgir venjulega ekki strax kveikjunni í uppbyggingu skjalsins, er engin trygging fyrir því að halda áfram/ýtaTABmun færa lyklaborðsnotanda inn í sprettigluggann sjálfan. Í stuttu máli, einfaldlega að bæta gagnvirkum stjórntækjum við sprettiglugga er líklegt til að gera þessar stýringar óaðgengilegar/ónothæfar fyrir lyklaborðsnotendur og notendur hjálpartækni, eða að minnsta kosti gera órökrétta heildar fókusröð. Í þessum tilvikum skaltu íhuga að nota valmynd í staðinn.
Valmöguleikar
Hægt er að senda valkosti í gegnum gagnaeiginleika eða JavaScript. Fyrir gagnaeiginleika skaltu bæta heiti valkostsins við data-bs-
, eins og í data-bs-animation=""
. Gakktu úr skugga um að breyta tilfelli tegundar valmöguleikans úr camelCase í kebab-case þegar þú sendir valkostina í gegnum gagnaeiginleika. Til dæmis, í stað þess að nota data-bs-customClass="beautifier"
skaltu nota data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, og
allowList
með því að nota gagnaeiginleika.
Nafn | Tegund | Sjálfgefið | Lýsing |
---|---|---|---|
animation |
Boolean | true |
Notaðu CSS fade umskipti á popover |
container |
strengur | þáttur | rangt | false |
Bætir sprettiglugganum við ákveðinn þátt. Dæmi: |
content |
strengur | þáttur | virka | '' |
Sjálfgefið innihaldsgildi ef Ef fall er gefið upp verður það kallað með |
delay |
númer | mótmæla | 0 |
Seinkun á að sýna og fela sprettigluggann (ms) - á ekki við um handvirka kveikjugerð Ef númer er gefið upp er seinkun beitt á bæði fela/sýna Uppbygging hlutar er: |
html |
Boolean | false |
Settu HTML inn í popover. Ef það er rangt verður innerText eignin notuð til að setja efni inn í DOM. Notaðu texta ef þú hefur áhyggjur af XSS árásum. |
placement |
strengur | virka | 'right' |
Hvernig á að staðsetja popover - sjálfvirkt | efst | botn | vinstri | rétt. Þegar fall er notað til að ákvarða staðsetninguna er það kallað með popover DOM hnútinn sem fyrstu röksemd og kveikjuþáttinn DOM hnútinn sem seinni. Samhengið |
selector |
strengur | rangt | false |
Ef valkostur er til staðar verða sprettigluggar hlutir framseldir til tilgreindra skotmarka. Í reynd er þetta notað til að gera kviku HTML efni kleift að bæta við sprettigluggum. Sjá þetta og fróðlegt dæmi . |
template |
strengur | '<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
Grunn HTML til að nota þegar þú býrð til popover. Popoverinu Popoverinu
Ysta umbúðaþátturinn ætti að hafa |
title |
strengur | þáttur | virka | '' |
Sjálfgefið titilgildi ef Ef fall er gefið upp verður það kallað með |
trigger |
strengur | 'click' |
Hvernig popover er kveikt - smelltu á | sveima | fókus | handbók. Þú gætir farið framhjá mörgum kveikjum; aðskilja þá með bili. manual ekki hægt að sameina með neinum öðrum kveikjum. |
fallbackPlacements |
fylki | ['top', 'right', 'bottom', 'left'] |
Skilgreindu varastaðsetningar með því að gefa upp lista yfir staðsetningar í fylki (í forgangsröð). Nánari upplýsingar er að finna í hegðunarskjölum Poppers |
boundary |
strengur | þáttur | 'clippingParents' |
Yfirflæðisþvingunarmörk sprettigluggans (á aðeins við um Popper's preventOverflow modifier). Sjálfgefið er 'clippingParents' og getur samþykkt HTMLElement tilvísun (aðeins með JavaScript). Nánari upplýsingar er að finna í detectOverflow skjölum Popper . |
customClass |
strengur | virka | '' |
Bættu flokkum við sprettigluggann þegar hann er sýndur. Athugaðu að þessum flokkum verður bætt við til viðbótar öllum flokkum sem tilgreindir eru í sniðmátinu. Til að bæta við mörgum flokkum skaltu aðskilja þá með bilum: Þú getur líka sent aðgerð sem ætti að skila einum streng sem inniheldur fleiri flokksnöfn. |
sanitize |
Boolean | true |
Virkja eða slökkva á sótthreinsun. Ef virkjað 'template' , 'content' og 'title' valkostir verða sótthreinsaðir. Sjáðu hreinsiefnishlutann í JavaScript skjölunum okkar . |
allowList |
mótmæla | Sjálfgefið gildi | Hlutur sem inniheldur leyfilega eiginleika og merki |
sanitizeFn |
núll | virka | null |
Hér getur þú útvegað þína eigin sótthreinsunaraðgerð. Þetta getur verið gagnlegt ef þú vilt frekar nota sérstakt bókasafn til að framkvæma hreinsun. |
offset |
fylki | strengur | virka | [0, 8] |
Jöfnun sprettigluggans miðað við markmið hans. Þú getur sent streng í gagnaeiginleikum með kommum aðskilin gildi eins og: Þegar fall er notað til að ákvarða offsetið er það kallað með hlut sem inniheldur popper staðsetningu, tilvísun og popper rects sem fyrstu rök. Kveikjuþátturinn DOM hnútur er samþykktur sem önnur rök. Fallið verður að skila fylki með tveimur tölum: . Nánari upplýsingar er að finna í Offset-skjölum Poppers . |
popperConfig |
núll | hlutur | virka | null |
Til að breyta sjálfgefna Popper stillingu Bootstrap, sjáðu stillingar Popper . Þegar aðgerð er notuð til að búa til Popper stillinguna er hún kölluð með hlut sem inniheldur sjálfgefna Popper stillingu Bootstrap. Það hjálpar þér að nota og sameina sjálfgefið við þína eigin stillingu. Aðgerðin verður að skila stillingarhlut fyrir Popper. |
Gagnaeiginleikar fyrir einstaka sprettiglugga
Að öðrum kosti er hægt að tilgreina valkosti fyrir einstaka sprettiglugga með því að nota gagnaeiginleika, eins og útskýrt er hér að ofan.
Að nota aðgerð meðpopperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Aðferðir
Ósamstilltar aðferðir og umskipti
Allar API aðferðir eru ósamstilltar og hefja umskipti . Þeir snúa aftur til þess sem hringir um leið og umskiptin eru hafin en áður en þeim lýkur . Að auki verður aðferðakall á umbreytingarhluta hunsað .
sýna
Sýnir popover frumefnis. Snýr aftur til þess sem hringir áður en sprettigluggan hefur verið sýnd (þ.e. áður en shown.bs.popover
atburðurinn á sér stað). Þetta er talið „handvirk“ kveikja á popover. Popovers þar sem titill og innihald eru bæði núll lengd birtast aldrei.
myPopover.show()
fela sig
Felur sprettiglugga frumefnis. Snýr aftur til þess sem hringir áður en popover hefur verið falið (þ.e. áður en hidden.bs.popover
atburðurinn á sér stað). Þetta er talið „handvirk“ kveikja á popover.
myPopover.hide()
skipta
Kveikir á sprettiglugga frumefnis. Snýr aftur til þess sem hringir áður en sprettigluggan hefur verið sýnd eða falin (þ.e. áður en atburðurinn shown.bs.popover
eða hidden.bs.popover
á sér stað). Þetta er talið „handvirk“ kveikja á popover.
myPopover.toggle()
farga
Felur og eyðir sprettiglugga frumefnis (Fjarlægir vistuð gögn á DOM-einingunni). Popovers sem nota úthlutun (sem eru búnar til með valmöguleikanum selector
) er ekki hægt að eyða hver fyrir sig á afkvæma kveikjuþáttum.
myPopover.dispose()
virkja
Gefur popover frumefnis möguleika á að vera sýndur. Popovers eru sjálfgefið virkjaðir.
myPopover.enable()
slökkva
Fjarlægir möguleikann á að sprettiglugga frumefnis sé sýnt. Aðeins er hægt að sýna sprettigluggann ef hann er virkjaður aftur.
myPopover.disable()
toggleEnabled
Skiptir um möguleikann á að sprettiglugga frumefnis sé sýnt eða falið.
myPopover.toggleEnabled()
uppfærsla
Uppfærir staðsetningu sprettiglugga frumefnis.
myPopover.update()
getTilvik
Static aðferð sem gerir þér kleift að fá popover tilvikið tengt DOM frumefni
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Statísk aðferð sem gerir þér kleift að fá popover-tilvikið tengt DOM-einingu, eða búa til nýjan ef það var ekki frumstillt
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
Viðburðir
Tegund viðburðar | Lýsing |
---|---|
show.bs.poppover | Þessi atburður ræsir strax þegar show tilviksaðferðin er kölluð. |
sýnd.bs.poppover | Þessi atburður er ræstur þegar sprettiglugginn hefur verið gerður sýnilegur notanda (mun bíða eftir að CSS umbreytingum ljúki). |
fela.bs.poppover | Þessi atburður er ræstur strax þegar hide tilviksaðferðin hefur verið kölluð. |
falinn.bs.poppover | Þessi atburður er ræstur þegar búið er að fela sprettigluggann fyrir notandanum (bíður eftir að CSS umbreytingum ljúki). |
settur.bs.poppover | Þessi atburður er rekinn eftir show.bs.popover atburðinn þegar popover sniðmátinu hefur verið bætt við DOM. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})