Popovers
Documentație și exemple pentru adăugarea popover-urilor Bootstrap, precum cele găsite în iOS, la orice element de pe site-ul dvs.
Prezentare generală
Lucruri de știut când utilizați pluginul popover:
- Popovers se bazează pe biblioteca terță parte Popper pentru poziționare. Trebuie să includeți popper.min.js înainte de bootstrap.js sau să utilizați
bootstrap.bundle.min.js
/bootstrap.bundle.js
care conține Popper pentru ca popover-urile să funcționeze! - Popover-urile necesită pluginul tooltip ca dependență.
- Dacă construiți JavaScript din sursă, este nevoie
util.js
de . - Popover-urile sunt opt-in din motive de performanță, așa că trebuie să le inițializați singur .
- Lungimea zero
title
șicontent
valorile nu vor afișa niciodată un popover. - Specificați
container: 'body'
pentru a evita problemele de randare în componente mai complexe (cum ar fi grupurile noastre de intrare, grupurile de butoane etc.). - Declanșarea popover-urilor pe elemente ascunse nu va funcționa.
- Popover-urile pentru
.disabled
saudisabled
elemente trebuie să fie declanșate pe un element wrapper. - Când sunt declanșate de la ancore care se înfășoară pe mai multe linii, popover-urile vor fi centrate între lățimea totală a ancorelor. Folosește -l
.text-nowrap
pe tine<a>
pentru a evita acest comportament. - Popover-urile trebuie ascunse înainte ca elementele lor corespunzătoare să fie eliminate din DOM.
- Popover-urile pot fi declanșate datorită unui element din interiorul unui DOM umbră.
prefers-reduced-motion
interogarea media. Consultați
secțiunea cu mișcare redusă a documentației noastre de accesibilitate .
Continuați să citiți pentru a vedea cum funcționează popover-urile cu câteva exemple.
Exemplu: activați popover-urile peste tot
O modalitate de a inițializa toate popover-urile dintr-o pagină ar fi să le selectați după data-toggle
atributul lor:
$(function () {
$('[data-toggle="popover"]').popover()
})
Exemplu: Utilizarea container
opțiunii
Când aveți unele stiluri pe un element părinte care interferează cu un popover, veți dori să specificați o personalizare container
, astfel încât HTML-ul popover-ului să apară în acel element.
$(function () {
$('.example-popover').popover({
container: 'body'
})
})
Exemplu
<button type="button" class="btn btn-lg btn-danger" data-toggle="popover" title="Popover title" data-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>
Patru direcții
Sunt disponibile patru opțiuni: aliniat sus, dreapta, jos și stânga.
<button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="top" data-content="Top popover">
Popover on top
</button>
<button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="right" data-content="Right popover">
Popover on right
</button>
<button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="bottom" data-content="Bottom popover">
Popover on bottom
</button>
<button type="button" class="btn btn-secondary" data-container="body" data-toggle="popover" data-placement="left" data-content="Left popover">
Popover on left
</button>
Închideți la următorul clic
Utilizați focus
declanșatorul pentru a închide popover-urile la următorul clic al utilizatorului asupra unui alt element decât elementul de comutare.
Este necesar un marcaj specific pentru respingerea la clicul următor
Pentru un comportament adecvat între browsere și platforme, trebuie să utilizați <a>
eticheta, nu eticheta <button>
și, de asemenea, trebuie să includeți un tabindex
atribut.
<a tabindex="0" class="btn btn-lg btn-danger" role="button" data-toggle="popover" data-trigger="focus" title="Dismissible popover" data-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>
$('.popover-dismiss').popover({
trigger: 'focus'
})
Elemente dezactivate
Elementele cu disabled
atributul nu sunt interactive, ceea ce înseamnă că utilizatorii nu pot trece cu mouse-ul sau nu pot face clic pe ele pentru a declanșa un popover (sau un sfat instrument). Ca o soluție, veți dori să declanșați popover-ul dintr-un înveliș <div>
sau <span>
să înlocuiți pointer-events
elementul dezactivat.
Pentru declanșatoarele popover dezactivate, este posibil să preferați, data-trigger="hover"
de asemenea, ca popoverul să apară ca feedback vizual imediat pentru utilizatorii dvs., deoarece aceștia nu se așteaptă să facă clic pe un element dezactivat.
<span class="d-inline-block" data-toggle="popover" data-content="Disabled popover">
<button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>
Utilizare
Activați popover-urile prin JavaScript:
$('#example').popover(options)
Accelerație GPU
Popover-urile apar uneori neclare pe dispozitivele Windows 10 din cauza accelerării GPU și a unui DPI de sistem modificat. Soluția pentru aceasta în v4 este de a dezactiva accelerarea GPU după cum este necesar pe popover-urile dvs.
Remediere sugerată:
Popper.Defaults.modifiers.computeStyle.gpuAcceleration = !(window.devicePixelRatio < 1.5 && /Win/.test(navigator.platform))
Faceți popover-urile să funcționeze pentru utilizatorii de tastatură și tehnologie de asistență
Pentru a permite utilizatorilor de tastatură să activeze popover-urile dvs., ar trebui să le adăugați numai la elementele HTML care sunt în mod tradițional focalizate pe tastatură și interactive (cum ar fi link-uri sau comenzi de formular). Deși elementele HTML arbitrare (cum ar fi <span>
s) pot fi focalizate prin adăugarea tabindex="0"
atributului, acest lucru va adăuga tabulaturi potențial enervante și confuze pe elementele neinteractive pentru utilizatorii de tastatură, iar majoritatea tehnologiilor de asistență nu anunță în prezent conținutul popover-ului în această situație. . În plus, nu vă bazați exclusiv pe hover
declanșarea popover-urilor dvs., deoarece acest lucru le va face imposibil de declanșat pentru utilizatorii de tastatură.
Deși puteți insera HTML bogat și structurat în popover-uri cu html
opțiunea, vă recomandăm insistent să evitați adăugarea unei cantități excesive de conținut. Modul în care funcționează în prezent popover-urile este că, odată afișate, conținutul lor este legat de elementul declanșator cu aria-describedby
atributul. Ca urmare, întregul conținut al popover-ului va fi anunțat utilizatorilor de tehnologie de asistență ca un flux lung și neîntrerupt.
În plus, deși este posibil să includeți și comenzi interactive (cum ar fi elemente de formular sau linkuri) în popover-ul dvs. (prin adăugarea acestor elemente la whiteList
atributele și etichetele permise), rețineți că în prezent popover-ul nu gestionează ordinea de focalizare a tastaturii. Când un utilizator de tastatură deschide un popover, focalizarea rămâne pe elementul de declanșare și, deoarece popover-ul de obicei nu urmează imediat declanșatorul din structura documentului, nu există nicio garanție că deplasarea înainte/apăsareaTABva muta un utilizator de tastatură în popover-ul propriu-zis. Pe scurt, simpla adăugare de comenzi interactive la un popover poate face aceste controale inaccesibile/inutilizabile pentru utilizatorii de tastatură și utilizatorii de tehnologii de asistență sau, cel puțin, va face o ordine generală ilogică de focalizare. În aceste cazuri, luați în considerare utilizarea unui dialog modal.
Opțiuni
Opțiunile pot fi transmise prin atribute de date sau JavaScript. Pentru atributele datelor, adăugați numele opțiunii la data-
, ca în data-animation=""
.
sanitize
,
opțiunile sanitizeFn
și
whiteList
nu pot fi furnizate utilizând atribute de date.
Nume | Tip | Mod implicit | Descriere |
---|---|---|---|
animaţie | boolean | Adevărat | Aplicați o tranziție de estompare CSS la popover |
recipient | șir | element | fals | fals | Adaugă popover-ul la un anumit element. Exemplu: |
conţinut | șir | element | funcţie | '' | Valoarea implicită a conținutului dacă Dacă este dată o funcție, aceasta va fi apelată cu |
întârziere | număr | obiect | 0 | Întârziere afișarea și ascunderea popover-ului (ms) - nu se aplică tipului de declanșare manuală Dacă este furnizat un număr, se aplică întârziere atât pentru ascunde/afișare Structura obiectului este: |
html | boolean | fals | Inserați HTML în popover. Dacă este fals, text metoda jQuery va fi folosită pentru a insera conținut în DOM. Folosiți text dacă vă îngrijorează atacurile XSS. |
plasare | șir | funcţie | 'dreapta' | Cum să poziționați popover-ul - automat | sus | jos | stânga | dreapta. Când o funcție este utilizată pentru a determina plasarea, este apelată cu nodul popover DOM ca prim argument și elementul de declanșare nodul DOM ca al doilea. Contextul |
selector | șir | fals | fals | Dacă este furnizat un selector, obiectele popover vor fi delegate țintelor specificate. În practică, aceasta este utilizată pentru a permite conținutului HTML dinamic să fie adăugate popovers. Vedeți acesta și un exemplu informativ . |
șablon | şir | '<div class="popover" role="tooltip"><div class="arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
HTML de bază de utilizat la crearea popover-ului. Popover-urile Popover-urile
Elementul de înveliș exterior ar trebui să aibă |
titlu | șir | element | funcţie | '' | Valoarea implicită a titlului dacă Dacă este dată o funcție, aceasta va fi apelată cu |
declanșatorul | şir | 'clic' | Cum se declanșează popoverul - faceți clic pe | hover | focus | manual. Puteți trece mai multe declanșatoare; separați-le cu un spațiu. manual nu poate fi combinat cu niciun alt declanșator. |
decalaj | număr | şir | 0 | Deplasarea popover-ului în raport cu ținta sa. Pentru mai multe informații, consultați documentele despre offset ale lui Popper . |
plasare de rezervă | șir | matrice | „întoarce” | Permiteți să specificați ce poziție va folosi Popper în cazul de rezervă. Pentru mai multe informații, consultați documentele de comportament ale lui Popper |
customClass | șir | funcţie | '' | Adăugați clase la popover când este afișat. Rețineți că aceste clase vor fi adăugate în plus față de orice clase specificate în șablon. Pentru a adăuga mai multe clase, separați-le cu spații: De asemenea, puteți transmite o funcție care ar trebui să returneze un singur șir care conține nume de clasă suplimentare. |
limite | șir | element | 'scrollParent' | Limita constrângerii de depășire a popover-ului. Acceptă valorile 'viewport' , 'window' , 'scrollParent' , sau o referință HTMLElement (numai JavaScript). Pentru mai multe informații, consultați documentele Popper preventOverflow . |
dezinfecta | boolean | Adevărat | Activați sau dezactivați igienizarea. Dacă este activat 'template' , 'content' și 'title' opțiunile vor fi dezinfectate. Consultați secțiunea dezinfectant din documentația noastră JavaScript . |
Lista albă | obiect | Valoare implicită | Obiect care conține atribute și etichete permise |
igienizaFn | nul | funcţie | nul | Aici vă puteți furniza propria funcție de dezinfectare. Acest lucru poate fi util dacă preferați să utilizați o bibliotecă dedicată pentru a efectua igienizarea. |
popperConfig | nul | obiect | nul | Pentru a schimba configurația implicită Popper a Bootstrap, consultați configurația lui Popper |
Atribute de date pentru popovers individuale
Opțiunile pentru popover-uri individuale pot fi specificate alternativ prin utilizarea atributelor de date, așa cum s-a explicat mai sus.
Metode
Metode și tranziții asincrone
Toate metodele API sunt asincrone și încep o tranziție . Ei revin la apelant imediat ce tranziția este începută, dar înainte ca aceasta să se încheie . În plus, un apel de metodă pentru o componentă de tranziție va fi ignorat .
Consultați documentația noastră JavaScript pentru mai multe informații .
$().popover(options)
Inițializează popover-urile pentru o colecție de elemente.
.popover('show')
Dezvăluie popover-ul unui element. Revine la apelant înainte ca popover-ul să fie afișat efectiv (adică înainte de apariția shown.bs.popover
evenimentului). Aceasta este considerată o declanșare „manuală” a popover-ului. Popover-urile al căror titlu și conținut sunt ambele de lungime zero nu sunt niciodată afișate.
$('#element').popover('show')
.popover('hide')
Ascunde popover-ul unui element. Se întoarce la apelant înainte ca popover-ul să fi fost efectiv ascuns (adică înainte de apariția hidden.bs.popover
evenimentului). Aceasta este considerată o declanșare „manuală” a popover-ului.
$('#element').popover('hide')
.popover('toggle')
Comută popover-ul unui element. Revine la apelant înainte ca popover-ul să fi fost efectiv afișat sau ascuns (adică înainte ca evenimentul shown.bs.popover
sau să hidden.bs.popover
apară). Aceasta este considerată o declanșare „manuală” a popover-ului.
$('#element').popover('toggle')
.popover('dispose')
Ascunde și distruge popover-ul unui element. Popover-urile care folosesc delegarea (care sunt create folosind opțiunea selector
) nu pot fi distruse individual pe elementele de declanșare descendente.
$('#element').popover('dispose')
.popover('enable')
Oferă popover-ului unui element posibilitatea de a fi afișat. Popover-urile sunt activate în mod implicit.
$('#element').popover('enable')
.popover('disable')
Elimină posibilitatea ca popover-ul unui element să fie afișat. Popover-ul va putea fi afișat numai dacă este reactivat.
$('#element').popover('disable')
.popover('toggleEnabled')
Comută posibilitatea ca popover-ul unui element să fie afișat sau ascuns.
$('#element').popover('toggleEnabled')
.popover('update')
Actualizează poziția popover-ului unui element.
$('#element').popover('update')
Evenimente
Tip de eveniment | Descriere |
---|---|
show.bs.popover | Acest eveniment se declanșează imediat când show este apelată metoda instanței. |
arătat.bs.popover | Acest eveniment este declanșat atunci când popover-ul a fost făcut vizibil pentru utilizator (va aștepta finalizarea tranzițiilor CSS). |
ascunde.bs.popover | Acest eveniment este declanșat imediat când hide metoda instanței a fost apelată. |
ascuns.bs.popover | Acest eveniment este declanșat când popover-ul a terminat de a fi ascuns utilizatorului (va aștepta finalizarea tranzițiilor CSS). |
introdus.bs.popover | Acest eveniment este declanșat după show.bs.popover eveniment când șablonul popover a fost adăugat la DOM. |
$('#myPopover').on('hidden.bs.popover', function () {
// do something...
})