Popovers
Dokumentacija i primjeri za dodavanje Bootstrap skočnih prozora, poput onih koji se nalaze u iOS-u, bilo kojem elementu na vašoj web-lokaciji.
Pregled
Stvari koje treba znati kada koristite popover dodatak:
- Popovers se oslanjaju na biblioteku treće strane Popper za pozicioniranje. Morate uključiti popper.min.js prije bootstrap.js ili koristiti
bootstrap.bundle.min.js
/bootstrap.bundle.js
koji sadrži Popper kako bi popoveri radili! - Popovi zahtijevaju plugin tooltip kao ovisnost.
- Popoveri su opt-in zbog performansi, pa ih morate sami pokrenuti .
- Nulta duljina
title
icontent
vrijednosti nikada neće prikazati skočni prikaz. - Navedite
container: 'body'
kako biste izbjegli probleme s generiranjem u složenijim komponentama (poput naših ulaznih grupa, grupa gumba itd.). - Pokretanje skočnih prozora na skrivenim elementima neće raditi.
- Skočni prozori za elemente
.disabled
ilidisabled
moraju se pokrenuti na elementu omotača. - Kada se pokreću iz sidrišta koja se prelamaju preko više linija, skočni prozori bit će centrirani između ukupne širine sidrišta. Koristite
.text-nowrap
na svom<a>
s kako biste izbjegli ovakvo ponašanje. - Skočni prozori moraju biti skriveni prije nego što se njihovi odgovarajući elementi uklone iz DOM-a.
- Popoveri se mogu pokrenuti zahvaljujući elementu unutar DOM-a u sjeni.
prefers-reduced-motion
medijskom upitu. Pogledajte odjeljak
smanjenog kretanja u našoj dokumentaciji o pristupačnosti .
Nastavite čitati da vidite kako skočni prozori funkcioniraju s nekim primjerima.
Primjer: Omogućite skočne prozore posvuda
Jedan od načina da inicijalizirate sve skočne prozore na stranici bio bi da ih odaberete prema njihovom data-bs-toggle
atributu:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Primjer: Korištenje container
opcije
Kada imate neke stilove na nadređenom elementu koji ometaju skočni prozor, trebali biste navesti prilagođeni container
tako da se HTML skočnog prozora pojavljuje unutar tog elementa.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Primjer
<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>
Četiri smjera
Dostupne su četiri opcije: gore, desno, dolje i lijevo poravnato. Upute se preslikavaju kada koristite Bootstrap u RTL-u.
<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>
Odbaci pri sljedećem kliku
Upotrijebite focus
okidač za odbacivanje skočnih prozora pri sljedećem korisnikovom kliku na element različit od preklopnog elementa.
Za odbacivanje pri sljedećem kliku potrebna je posebna oznaka
Za ispravno ponašanje između preglednika i platformi, morate koristiti <a>
oznaku, a ne oznaku <button>
, a također morate uključiti tabindex
atribut.
<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'
})
Onemogućeni elementi
Elementi s disabled
atributom nisu interaktivni, što znači da korisnici ne mogu lebdjeti pokazivačem ili kliknuti na njih da bi pokrenuli skočni prozor (ili opis). Kao zaobilazno rješenje, htjet ćete pokrenuti skočni prozor iz omotača <div>
ili <span>
, idealno napravljenog za fokusiranje na tipkovnici, pomoću tabindex="0"
.
Za onemogućene okidače skočnog prozora možda biste radije željeli data-bs-trigger="hover focus"
da se skočni prozor pojavi kao neposredna vizualna povratna informacija vašim korisnicima jer možda neće očekivati da će kliknuti na onemogućeni element.
<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
Varijable
$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);
Korištenje
Omogući skočne prozore putem JavaScripta:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Učinite da skočni prozori rade za korisnike tipkovnice i pomoćne tehnologije
Da biste omogućili korisnicima tipkovnice da aktiviraju vaše skočne prozore, trebali biste ih dodati samo u HTML elemente koji su tradicionalno fokusirani na tipkovnici i koji su interaktivni (kao što su veze ili kontrole obrazaca). Iako proizvoljni HTML elementi (kao što <span>
je s) mogu biti fokusirani dodavanjem tabindex="0"
atributa, to će dodati potencijalno neugodna i zbunjujuća zaustavljanja kartice na neinteraktivnim elementima za korisnike tipkovnice, a većina pomoćnih tehnologija trenutno ne najavljuje sadržaj skočnog prozora u ovoj situaciji . Osim toga, nemojte se oslanjati samo na hover
njega kao na okidač za svoje skočne prozore, jer će to onemogućiti njihovo pokretanje za korisnike tipkovnice.
Iako možete umetnuti bogati, strukturirani HTML u skočne prozore s ovom html
opcijom, toplo preporučujemo da izbjegavate dodavanje pretjerane količine sadržaja. Način na koji skočni prozori trenutno funkcioniraju jest da se njihov sadržaj, nakon što se prikažu, povezuje s elementom okidača s aria-describedby
atributom. Kao rezultat toga, cjelokupni sadržaj Popovera bit će najavljen korisnicima pomoćne tehnologije kao jedan dugi, neprekinuti tok.
Osim toga, iako je moguće također uključiti interaktivne kontrole (kao što su elementi obrasca ili veze) u vaš skočni prozor (dodavanjem ovih elemenata u allowList
dopuštene atribute i oznake), imajte na umu da trenutno skočni prozor ne upravlja redoslijedom fokusa tipkovnice. Kada korisnik tipkovnice otvori skočni prozor, fokus ostaje na elementu okidača, a kako skočni prozor obično ne slijedi odmah okidač u strukturi dokumenta, nema jamstva da će pomicanje naprijed/pritisakTABpremjestit će korisnika tipkovnice u sam skočni prozor. Ukratko, jednostavno dodavanje interaktivnih kontrola skočnom prozoru vjerojatno će te kontrole učiniti nedostupnima/neupotrebljivima za korisnike tipkovnice i korisnike pomoćnih tehnologija ili će u najmanju ruku stvoriti nelogičan ukupni redoslijed fokusa. U tim slučajevima razmislite o korištenju modalnog dijaloškog okvira.
Mogućnosti
Opcije se mogu proslijediti putem atributa podataka ili JavaScripta. Za atribute podataka dodajte naziv opcije u data-bs-
, kao u data-bs-animation=""
. Obavezno promijenite vrstu slučaja naziva opcije iz camelCase u kebab-case kada prosljeđujete opcije putem atributa podataka. Na primjer, umjesto da koristite data-bs-customClass="beautifier"
, koristite data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, i
allowList
ne mogu isporučiti pomoću atributa podataka.
Ime | Tip | Zadano | Opis |
---|---|---|---|
animation |
Booleov | true |
Primijenite CSS fade prijelaz na skočni prozor |
container |
niz | element | lažno | false |
Dodaje skočni prozor određenom elementu. Primjer: |
content |
niz | element | funkcija | '' |
Zadana vrijednost sadržaja ako Ako je dana funkcija, bit će pozvana s |
delay |
broj | objekt | 0 |
Odgoda prikazivanja i skrivanja skočnog prozora (ms) - ne odnosi se na vrstu ručnog okidača Ako je naveden broj, odgoda se primjenjuje na skrivanje/prikazivanje Struktura objekta je: |
html |
Booleov | false |
Umetnite HTML u skočni prozor. Ako je netočno, innerText svojstvo će se koristiti za umetanje sadržaja u DOM. Upotrijebite tekst ako ste zabrinuti zbog XSS napada. |
placement |
niz | funkcija | 'right' |
Kako postaviti popover - automatski | vrh | dno | lijevo | pravo. Kada se funkcija koristi za određivanje položaja, poziva se s skočnim DOM čvorom kao prvim argumentom i DOM čvorom pokretačkog elementa kao drugim. Kontekst |
selector |
niz | lažno | false |
Ako je selektor osiguran, skočni objekti bit će delegirani navedenim ciljevima. U praksi se ovo koristi za omogućavanje dodavanja skočnih prozora za dinamički HTML sadržaj. Pogledajte ovo i informativan primjer . |
template |
niz | '<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
Osnovni HTML za korištenje pri stvaranju skočnog prozora. Popover Popover
Najudaljeniji element omotača trebao bi imati |
title |
niz | element | funkcija | '' |
Zadana vrijednost naslova ako Ako je dana funkcija, bit će pozvana s |
trigger |
niz | 'click' |
Kako se pokreće popover - kliknite | lebdjeti | fokus | priručnik. Možete proći više okidača; odvojite ih razmakom. manual ne može se kombinirati ni s jednim drugim okidačem. |
fallbackPlacements |
niz | ['top', 'right', 'bottom', 'left'] |
Definirajte zamjenske položaje pružanjem popisa položaja u nizu (redoslijedom preferencija). Za više informacija pogledajte Popperovu dokumentaciju o ponašanju |
boundary |
niz | element | 'clippingParents' |
Granica ograničenja prekoračenja skočnog prozora (odnosi se samo na Popperov modifikator za sprečavanje preljeva). Prema zadanim postavkama 'clippingParents' može prihvatiti HTMLElement referencu (samo putem JavaScripta). Za više informacija pogledajte Popper's detectOverflow dokumente . |
customClass |
niz | funkcija | '' |
Dodajte klase skočnom prozoru kada se prikaže. Imajte na umu da će ove klase biti dodane uz sve klase navedene u predlošku. Za dodavanje više klasa, odvojite ih razmacima: Također možete proslijediti funkciju koja bi trebala vratiti jedan niz koji sadrži dodatna imena klasa. |
sanitize |
Booleov | true |
Omogućite ili onemogućite dezinfekciju. Ako je aktivirano 'template' , 'content' i 'title' opcije će biti očišćene. Pogledajte odjeljak sanitizera u našoj JavaScript dokumentaciji . |
allowList |
objekt | Zadana vrijednost | Objekt koji sadrži dopuštene atribute i oznake |
sanitizeFn |
nula | funkcija | null |
Ovdje možete ponuditi vlastitu funkciju dezinfekcije. Ovo može biti korisno ako radije koristite namjensku knjižnicu za izvođenje dezinfekcije. |
offset |
niz | niz | funkcija | [0, 8] |
Pomak popover-a u odnosu na cilj. Možete proslijediti niz u atributima podataka s vrijednostima odvojenim zarezima kao što su: Kada se funkcija koristi za određivanje pomaka, ona se poziva s objektom koji sadrži popper položaj, referencu i popper rects kao prvi argument. DOM čvor pokretačkog elementa prosljeđuje se kao drugi argument. Funkcija mora vratiti niz s dva broja: . Za više informacija pogledajte Popperovu offset dokumentaciju . |
popperConfig |
nula | objekt | funkcija | null |
Za promjenu Bootstrapove zadane Popper konfiguracije, pogledajte Popperovu konfiguraciju . Kada se funkcija koristi za stvaranje Popper konfiguracije, poziva se s objektom koji sadrži Bootstrapovu zadanu Popper konfiguraciju. Pomaže vam koristiti i spojiti zadane postavke s vlastitom konfiguracijom. Funkcija mora vratiti konfiguracijski objekt za Popper. |
Atributi podataka za pojedinačne skočne prozore
Opcije za pojedinačne skočne prozore mogu se alternativno specificirati upotrebom atributa podataka, kao što je gore objašnjeno.
Korištenje funkcije sapopperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Metode
Asinkrone metode i prijelazi
Sve API metode su asinkrone i pokreću prijelaz . Vraćaju se pozivatelju čim prijelaz započne, ali prije nego što završi . Osim toga, poziv metode na prijelaznoj komponenti bit će zanemaren .
Pogledajte našu JavaScript dokumentaciju za više informacija .
pokazati
Otkriva popover elementa. Vraća se pozivatelju prije nego što se popover stvarno prikaže (tj. prije nego što se shown.bs.popover
događaj dogodi). Ovo se smatra "ručnim" pokretanjem popover-a. Skočni prozori čiji su naslov i sadržaj nulte duljine nikad se ne prikazuju.
myPopover.show()
sakriti
Skriva skočni prozor elementa. Vraća se pozivatelju prije nego što je popover zapravo skriven (tj. prije nego što se hidden.bs.popover
događaj dogodi). Ovo se smatra "ručnim" pokretanjem popover-a.
myPopover.hide()
prebaciti
Isključuje skočni prozor elementa. Vraća se pozivatelju prije nego što se popover stvarno prikaže ili sakrije (tj. prije nego što se dogodi događaj shown.bs.popover
ili ). hidden.bs.popover
Ovo se smatra "ručnim" pokretanjem popover-a.
myPopover.toggle()
raspolagati
Skriva i uništava popover elementa (Uklanja pohranjene podatke na DOM elementu). Popoveri koji koriste delegiranje (koji se stvaraju pomoću opcije selector
) ne mogu se pojedinačno uništiti na okidačkim elementima potomcima.
myPopover.dispose()
omogućiti
Daje mogućnost prikazivanja skočnog prozora elementa. Skočni prozori omogućeni su prema zadanim postavkama.
myPopover.enable()
onemogućiti
Uklanja mogućnost prikazivanja skočnog prozora elementa. Popover će se moći prikazati samo ako je ponovno omogućen.
myPopover.disable()
prebaciOmogućeno
Isključuje mogućnost prikazivanja ili sakrivanja skočnog prozora elementa.
myPopover.toggleEnabled()
Ažuriraj
Ažurira položaj skočnog prozora elementa.
myPopover.update()
getInstance
Statička metoda koja vam omogućuje dobivanje skočne instance povezane s DOM elementom
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Statička metoda koja vam omogućuje dobivanje skočne instance povezane s DOM elementom ili stvaranje nove u slučaju da nije inicijalizirana
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
Događaji
Vrsta događaja | Opis |
---|---|
pokazati.bs.popover | Ovaj događaj aktivira se odmah kada show se pozove metoda instance. |
prikazano.bs.popover | Ovaj se događaj pokreće kada je popover vidljiv korisniku (pričekat će se da se CSS prijelazi završe). |
sakriti.bs.popover | Ovaj se događaj aktivira odmah nakon hide pozivanja metode instance. |
skriven.bs.popover | Ovaj se događaj pokreće kada popover više nije skriven od korisnika (pričekat će se da se dovrše CSS prijelazi). |
umetnuto.bs.popover | Ovaj se događaj pokreće nakon show.bs.popover događaja kada je skočni predložak dodan u DOM. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})