Popovers
Dokumentācija un piemēri Bootstrap uznirstošo logu, piemēram, operētājsistēmā iOS, pievienošanai jebkuram vietnes elementam.
Pārskats
Lietas, kas jāzina, izmantojot uznirstošo spraudni:
- Popovers pozicionēšanai izmanto trešās puses bibliotēku Popper . Lai uznirstošie elementi darbotos, pirms bootstrap.js jāiekļauj popper.min.js vai jāizmanto
bootstrap.bundle.min.js
/bootstrap.bundle.js
kas satur Popper! - Uznirstošajiem ekrāniem kā atkarība ir nepieciešams rīka padoma spraudnis .
- Uznirstošie elementi ir izvēlēti veiktspējas iemeslu dēļ, tāpēc jums tie ir jāinicializē pašam .
- Nulles garums
title
uncontent
vērtības nekad neparādīs uznirstošo logu. - Norādiet
container: 'body'
, lai izvairītos no renderēšanas problēmām sarežģītākos komponentos (piemēram, mūsu ievades grupās, pogu grupās utt.). - Uznirstošo logu aktivizēšana slēptajos elementos nedarbosies.
- Uznirstošie elementi
.disabled
vaidisabled
elementiem ir jāaktivizē iesaiņojuma elementā. - Ja to aktivizē enkuri, kas apvij vairākas līnijas, uznirstošie elementi tiks centrēti starp enkuru kopējo platumu. Izmantojiet
.text-nowrap
,<a>
lai izvairītos no šādas uzvedības. - Uznirstošie elementi ir jāslēpj, pirms to atbilstošie elementi ir noņemti no DOM.
- Popovers var tikt aktivizēts, pateicoties elementam, kas atrodas ēnu DOM.
prefers-reduced-motion
multivides vaicājuma. Skatiet
mūsu pieejamības dokumentācijas sadaļu samazinātas kustības .
Turpiniet lasīt, lai redzētu, kā darbojas uznirstošie elementi, izmantojot dažus piemērus.
Piemērs: iespējot uznirstošos logus visur
Viens veids, kā inicializēt visus uznirstošos logus lapā, būtu atlasīt tos pēc to data-bs-toggle
atribūta:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Piemērs: container
opcijas izmantošana
Ja vecā elementā ir daži stili, kas traucē uznirstošo logu, jūs vēlaties norādīt pielāgotu container
, lai uznirstošā elementa HTML tiktu rādīts šajā elementā.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Piemērs
<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>
Četri virzieni
Ir pieejamas četras opcijas: līdzinājums augšā, pa labi, apakšā un pa kreisi. Norādes tiek atspoguļotas, izmantojot Bootstrap 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>
Noraidīt ar nākamo klikšķi
Izmantojiet focus
aktivizētāju, lai noraidītu uznirstošos logus, kad lietotājs nākamreiz noklikšķina uz cita elementa, nevis uz pārslēgšanas elementa.
Konkrēts marķējums ir nepieciešams, lai atteiktu nākamo klikšķi
Lai nodrošinātu pareizu darbību starp pārlūkprogrammām un platformām, ir jāizmanto <a>
tags, nevis tags, kā <button>
arī jāiekļauj tabindex
atribūts.
<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'
})
Atspējotie elementi
Elementi ar disabled
atribūtu nav interaktīvi, tas nozīmē, ka lietotāji nevar virzīt kursoru vai noklikšķināt uz tiem, lai aktivizētu uznirstošo logu (vai rīka padomu). Kā risinājumu varat aktivizēt uznirstošo pavērsienu no iesaiņojuma <div>
vai <span>
ideālā gadījumā, ja tastatūras fokuss ir piemērots, izmantojot tabindex="0"
.
Atspējotiem uznirstošiem aktivizētājiem varat arī izvēlēties data-bs-trigger="hover focus"
, lai uznirstošais logs lietotājiem tiktu rādīts kā tūlītēja vizuāla atgriezeniskā saite, jo viņi, iespējams, negaidīs, ka noklikšķinās uz atspējota elementa.
<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
Mainīgie lielumi
$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);
Lietošana
Iespējot uznirstošos logus, izmantojot JavaScript:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Uznirstošo logu izmantošana tastatūras un palīgtehnoloģiju lietotājiem
Lai ļautu tastatūras lietotājiem aktivizēt jūsu uznirstošos logus, jums tie jāpievieno tikai tiem HTML elementiem, kas tradicionāli ir orientēti uz tastatūru un ir interaktīvi (piemēram, saites vai veidlapas vadīklas). Lai gan patvaļīgus HTML elementus (piemēram, <span>
s) var padarīt fokusējamus, pievienojot tabindex="0"
atribūtu, tastatūras lietotājiem tiks pievienotas potenciāli kaitinošas un mulsinošas tabulēšanas pieturas neinteraktīvajiem elementiem, un lielākā daļa palīgtehnoloģiju pašlaik nepaziņo uznirstošā ekrāna saturu šajā situācijā. . Turklāt nepaļaujieties tikai uz hover
uznirstošo logu aktivizētāju, jo tas padarīs tos neiespējamu tastatūras lietotājiem.
Lai gan varat ievietot bagātīgu, strukturētu HTML uznirstošajos logos, izmantojot šo html
opciju, mēs ļoti iesakām izvairīties no pārmērīga satura daudzuma pievienošanas. Pašlaik uznirstošie uznirstošie elementi darbojas tādā veidā, ka pēc parādīšanas to saturs ir saistīts ar aktivizētāja elementu ar aria-describedby
atribūtu. Rezultātā viss popover saturs tiks paziņots palīgtehnoloģiju lietotājiem kā viena gara, nepārtraukta straume.
Turklāt, lai gan uznirstošajā logā ir iespējams iekļaut arī interaktīvas vadīklas (piemēram, veidlapas elementus vai saites) (pievienojot šos elementus allowList
atļautajiem atribūtiem un tagiem), ņemiet vērā, ka pašlaik uznirstošais logs nepārvalda tastatūras fokusa secību. Kad tastatūras lietotājs atver uznirstošo logu, fokuss paliek uz palaišanas elementu, un, tā kā uznirstošais logs parasti neseko uzreiz pēc palaišanas dokumenta struktūrā, nav garantijas, ka, virzoties uz priekšu/nospiežot.TABpārvietos tastatūras lietotāju pašā uznirstošajā logā. Īsāk sakot, vienkārši pievienojot interaktīvas vadīklas uznirstošajam logam, tastatūras lietotājiem un palīgtehnoloģiju lietotājiem šīs vadīklas, visticamāk, kļūs nepieejamas/nelietojamas vai vismaz radīs neloģisku kopējo fokusa secību. Šādos gadījumos apsveriet iespēju izmantot modālu dialoglodziņu.
Iespējas
Opcijas var nodot, izmantojot datu atribūtus vai JavaScript. Datu atribūtiem pievienojiet opcijas nosaukumu data-bs-
, tāpat kā data-bs-animation=""
. Nododot opcijas, izmantojot datu atribūtus, noteikti nomainiet opcijas nosaukuma reģistra veidu no camelCase uz kebab-case. Piemēram, tā vietā, lai izmantotu data-bs-customClass="beautifier"
, izmantojiet data-bs-custom-class="beautifier"
.
sanitize
opcijas
sanitizeFn
, un
allowList
opcijas nevar nodrošināt, izmantojot datu atribūtus.
Vārds | Tips | Noklusējums | Apraksts |
---|---|---|---|
animation |
Būla | true |
Uznirstošajam logam izmantojiet CSS izbalēšanas pāreju |
container |
stīga | elements | viltus | false |
Pievieno uznirstošo logu konkrētam elementam. Piemērs: |
content |
stīga | elements | funkciju | '' |
Noklusējuma satura vērtība, ja Ja funkcija ir dota, tā tiks izsaukta ar |
delay |
numurs | objektu | 0 |
Uznirstošā loga rādīšanas un slēpšanas aizkave (ms) — neattiecas uz manuālo palaišanas veidu Ja tiek norādīts numurs, aizkave tiek piemērota gan slēpšanai/rādīšanai Objekta struktūra ir šāda: |
html |
Būla | false |
Ievietojiet HTML uznirstošajā logā. Ja aplams, innerText īpašums tiks izmantots, lai ievietotu saturu DOM. Izmantojiet tekstu, ja uztraucaties par XSS uzbrukumiem. |
placement |
stīga | funkciju | 'right' |
Kā novietot uznirstošo logu - auto | uz augšu | apakšā | pa kreisi | pa labi. Ja funkcija tiek izmantota, lai noteiktu izvietojumu, tā tiek izsaukta ar uznirstošo DOM mezglu kā pirmo argumentu un izraisošo elementu DOM mezglu kā otro. Konteksts |
selector |
stīga | viltus | false |
Ja ir nodrošināts atlasītājs, uznirstošie objekti tiks deleģēti norādītajiem mērķiem. Praksē to izmanto, lai dinamiskam HTML saturam iespējotu uznirstošo logu pievienošanu. Skatiet šo un informatīvo piemēru . |
template |
stīga | '<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
Pamata HTML, kas jāizmanto, veidojot uznirstošo logu. Popover's Popover's
Vistālākajam iesaiņojuma elementam jābūt |
title |
stīga | elements | funkciju | '' |
Noklusējuma nosaukuma vērtība, ja Ja funkcija ir dota, tā tiks izsaukta ar |
trigger |
stīga | 'click' |
Kā tiek aktivizēts popover — noklikšķiniet uz | lidināties | fokuss | rokasgrāmata. Jūs varat nodot vairākus trigerus; atdaliet tos ar atstarpi. manual nevar kombinēt ar kādu citu aktivizētāju. |
fallbackPlacements |
masīvs | ['top', 'right', 'bottom', 'left'] |
Definējiet rezerves izvietojumus, nodrošinot izvietojumu sarakstu masīvā (priekšrocību secībā). Papildinformāciju skatiet Popera uzvedības dokumentos |
boundary |
stīga | elements | 'clippingParents' |
Uznirstošā loga pārpildes ierobežojuma robeža (attiecas tikai uz Poppera preventīvā pārpildes modifikatoru). Pēc noklusējuma tas ir 'clippingParents' un var pieņemt HTMLElement atsauci (tikai izmantojot JavaScript). Lai iegūtu papildinformāciju, skatiet Popper's detectOverflow dokumentus . |
customClass |
stīga | funkciju | '' |
Pievienojiet klases uznirstošajam logam, kad tas tiek parādīts. Ņemiet vērā, ka šīs klases tiks pievienotas papildus visām veidnē norādītajām klasēm. Lai pievienotu vairākas klases, atdaliet tās ar atstarpēm: Varat arī nodot funkciju, kurai jāatgriež viena virkne, kas satur papildu klašu nosaukumus. |
sanitize |
Būla | true |
Iespējojiet vai atspējojiet dezinfekciju. Ja tas ir aktivizēts 'template' , opcijas tiks sanitizētas. Skatiet mūsu JavaScript dokumentācijas sadaļu par dezinfekcijas līdzekļiem .'content' 'title' |
allowList |
objektu | Noklusējuma vērtība | Objekts, kurā ir atļauti atribūti un tagi |
sanitizeFn |
null | funkciju | null |
Šeit jūs varat nodrošināt savu dezinfekcijas funkciju. Tas var būt noderīgi, ja vēlaties dezinficēšanai izmantot īpašu bibliotēku. |
offset |
masīvs | stīga | funkciju | [0, 8] |
Popover nobīde attiecībā pret tā mērķi. Datu atribūtos varat nodot virkni ar komatu atdalītām vērtībām, piemēram: Ja funkcija tiek izmantota, lai noteiktu nobīdi, tā tiek izsaukta ar objektu, kurā kā pirmais arguments ir popper izvietojums, atsauce un popper rects. Aktivizējošais elements DOM mezgls tiek nodots kā otrais arguments. Funkcijai jāatgriež masīvs ar diviem cipariem: . Papildinformāciju skatiet Poppera nobīdes dokumentos . |
popperConfig |
null | objekts | funkciju | null |
Lai mainītu Bootstrap noklusējuma Popper konfigurāciju, skatiet Popper konfigurāciju . Ja funkcija tiek izmantota, lai izveidotu Popper konfigurāciju, tā tiek izsaukta ar objektu, kas satur Bootstrap noklusējuma Popper konfigurāciju. Tas palīdz izmantot un apvienot noklusējuma iestatījumus ar savu konfigurāciju. Funkcijai ir jāatgriež Popper konfigurācijas objekts. |
Datu atribūti atsevišķiem uznirstošajiem logiem
Atsevišķu uznirstošo logu opcijas var norādīt, izmantojot datu atribūtus, kā paskaidrots iepriekš.
Izmantojot funkciju arpopperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Metodes
Asinhronās metodes un pārejas
Visas API metodes ir asinhronas un sāk pāreju . Viņi atgriežas pie zvanītāja, tiklīdz ir sākta pāreja, bet pirms tās beigām . Turklāt pārejas komponenta metodes izsaukums tiks ignorēts .
parādīt
Atklāj elementa popover. Atgriežas pie zvanītāja, pirms faktiski ir parādīts uznirstošais logs (ti, pirms shown.bs.popover
notikuma). Tas tiek uzskatīts par "manuālu" uznirstošā ekrāna aktivizēšanu. Uznirstošie elementi, kuru nosaukumam un saturam ir nulles garums, nekad netiek rādīti.
myPopover.show()
paslēpties
Paslēpj elementa uznirstošo logu. Atgriežas pie zvanītāja, pirms uznirstošais logs ir faktiski paslēpts (ti, pirms hidden.bs.popover
notikuma). Tas tiek uzskatīts par "manuālu" uznirstošā ekrāna aktivizēšanu.
myPopover.hide()
pārslēgt
Pārslēdz elementa uznirstošo logu. Atgriežas pie zvanītāja, pirms uznirstošais logs ir faktiski parādīts vai paslēpts (ti, pirms shown.bs.popover
vai hidden.bs.popover
notikuma). Tas tiek uzskatīts par "manuālu" uznirstošā ekrāna aktivizēšanu.
myPopover.toggle()
atbrīvoties
Paslēpj un iznīcina elementa uznirstošo logu (noņem DOM elementā saglabātos datus). Uznirstošos logus, kuros tiek izmantota deleģēšana (kas tiek izveidoti, izmantojot opciju selector
) , nevar atsevišķi iznīcināt pēcnācēju trigera elementiem.
myPopover.dispose()
iespējot
Sniedz iespēju parādīt elementa uznirstošo logu. Uznirstošie elementi ir iespējoti pēc noklusējuma.
myPopover.enable()
atspējot
Noņem iespēju rādīt elementa uznirstošo logu. Uznirstošo logu varēs parādīt tikai tad, ja tas būs atkārtoti iespējots.
myPopover.disable()
pārslēgtIespējots
Pārslēdz iespēju rādīt vai paslēpt elementa uznirstošo logu.
myPopover.toggleEnabled()
Atjaunināt
Atjaunina elementa uznirstošā loga pozīciju.
myPopover.update()
getInstance
Statiskā metode, kas ļauj iegūt uznirstošo gadījumu, kas saistīts ar DOM elementu
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Statiskā metode, kas ļauj iegūt uznirstošo gadījumu, kas saistīts ar DOM elementu, vai izveidot jaunu, ja tas nav inicializēts
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
Pasākumi
Pasākuma veids | Apraksts |
---|---|
show.bs.popover | Šis notikums tiek aktivizēts nekavējoties, kad show tiek izsaukta instances metode. |
parādīts.bs.popover | Šis notikums tiek aktivizēts, kad uznirstošais logs ir padarīts redzams lietotājam (pagaidīs, līdz tiks pabeigtas CSS pārejas). |
hide.bs.popover | Šis notikums tiek aktivizēts nekavējoties, kad hide ir izsaukta instances metode. |
paslēpts.bs.popover | Šis notikums tiek aktivizēts, kad uznirstošais logs ir paslēpts no lietotāja (gaidīs, kamēr CSS pārejas tiks pabeigtas). |
ievietots.bs.popover | Šis notikums tiek aktivizēts pēc show.bs.popover notikuma, kad uznirstošā veidne ir pievienota DOM. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})