Popover
Documentazione ed esempi per aggiungere popover Bootstrap, come quelli che si trovano in iOS, a qualsiasi elemento del tuo sito.
Panoramica
Cose da sapere quando si utilizza il plug-in popover:
- I popover si basano sulla libreria di terze parti Popper per il posizionamento. Devi includere popper.min.js prima di bootstrap.js o usare
bootstrap.bundle.min.js
/bootstrap.bundle.js
che contiene Popper affinché i popover funzionino! - I popover richiedono il plug-in del suggerimento come dipendenza.
- I popover sono attivabili per motivi di prestazioni, quindi devi inizializzarli tu stesso .
- Lunghezza zero
title
econtent
valori non mostreranno mai un popover. - Specificare
container: 'body'
per evitare problemi di rendering in componenti più complessi (come i nostri gruppi di input, gruppi di pulsanti, ecc.). - L'attivazione dei popover sugli elementi nascosti non funzionerà.
- I popover per gli elementi
.disabled
odisabled
devono essere attivati su un elemento wrapper. - Quando vengono attivati da ancoraggi che si avvolgono su più linee, i popover verranno centrati tra la larghezza complessiva degli ancoraggi. Usa
.text-nowrap
sui tuoi<a>
messaggi di posta elettronica per evitare questo comportamento. - I popover devono essere nascosti prima che i loro elementi corrispondenti siano stati rimossi dal DOM.
- I popover possono essere attivati grazie a un elemento all'interno di un DOM ombra.
prefers-reduced-motion
media query. Vedi la
sezione movimento ridotto della nostra documentazione sull'accessibilità .
Continua a leggere per vedere come funzionano i popover con alcuni esempi.
Esempio: abilita i popover ovunque
Un modo per inizializzare tutti i popover su una pagina sarebbe selezionarli in base al loro data-bs-toggle
attributo:
var popoverTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="popover"]'))
var popoverList = popoverTriggerList.map(function (popoverTriggerEl) {
return new bootstrap.Popover(popoverTriggerEl)
})
Esempio: utilizzo container
dell'opzione
Quando hai degli stili su un elemento padre che interferiscono con un popover, ti consigliamo di specificare uno stile personalizzato container
in modo che l'HTML del popover appaia invece all'interno di quell'elemento.
var popover = new bootstrap.Popover(document.querySelector('.example-popover'), {
container: 'body'
})
Esempio
<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>
Quattro direzioni
Sono disponibili quattro opzioni: allineato in alto, a destra, in basso e a sinistra. Le direzioni vengono rispecchiate quando si utilizza Bootstrap in 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>
Ignora al prossimo clic
Utilizzare il focus
trigger per ignorare i popover al successivo clic dell'utente su un elemento diverso rispetto all'elemento di attivazione/disattivazione.
È richiesto un markup specifico per l'eliminazione al clic successivo
Per un corretto comportamento cross-browser e multipiattaforma, devi utilizzare il <a>
tag, non il <button>
tag, e devi anche includere un tabindex
attributo.
<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'
})
Elementi disabilitati
Gli elementi con l' disabled
attributo non sono interattivi, il che significa che gli utenti non possono passare il mouse o fare clic su di essi per attivare un popover (o una descrizione comando). Come soluzione alternativa, ti consigliamo di attivare il popover da un wrapper <div>
o <span>
, idealmente reso focalizzabile dalla tastiera utilizzando tabindex="0"
.
Per i trigger di popover disabilitati, potresti anche preferire data-bs-trigger="hover focus"
che il popover appaia come feedback visivo immediato ai tuoi utenti poiché potrebbero non aspettarsi di fare clic su un elemento disabilitato.
<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
Variabili
$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);
Utilizzo
Abilita i popover tramite JavaScript:
var exampleEl = document.getElementById('example')
var popover = new bootstrap.Popover(exampleEl, options)
Fare in modo che i popover funzionino per gli utenti di tastiere e tecnologie assistive
Per consentire agli utenti della tastiera di attivare i tuoi popover, dovresti aggiungerli solo agli elementi HTML che sono tradizionalmente focalizzabili sulla tastiera e interattivi (come collegamenti o controlli dei moduli). Sebbene elementi HTML arbitrari (come <span>
s) possano essere resi attivabili aggiungendo l' tabindex="0"
attributo, ciò aggiungerà tabulazioni potenzialmente fastidiose e confuse su elementi non interattivi per gli utenti della tastiera e la maggior parte delle tecnologie assistive attualmente non annuncia il contenuto del popover in questa situazione . Inoltre, non fare affidamento solo su hover
come trigger per i tuoi popover, poiché ciò renderà impossibile attivarli per gli utenti della tastiera.
Sebbene tu possa inserire HTML ricco e strutturato nei popover con l' html
opzione, ti consigliamo vivamente di evitare di aggiungere una quantità eccessiva di contenuto. Il modo in cui funzionano attualmente i popover è che, una volta visualizzati, il loro contenuto è legato all'elemento trigger con l' aria-describedby
attributo. Di conseguenza, l'intero contenuto del popover verrà annunciato agli utenti di tecnologie assistive come un flusso lungo e ininterrotto.
Inoltre, sebbene sia possibile includere anche controlli interattivi (come elementi del modulo o collegamenti) nel tuo popover (aggiungendo questi elementi agli allowList
attributi e ai tag consentiti), tieni presente che attualmente il popover non gestisce l'ordine del focus della tastiera. Quando un utente della tastiera apre un popover, l'attenzione rimane sull'elemento di attivazione e poiché il popover di solito non segue immediatamente l'attivazione nella struttura del documento, non vi è alcuna garanzia che si vada avanti/premendoTABsposterà un utente della tastiera nel popover stesso. In breve, è probabile che la semplice aggiunta di controlli interattivi a un popover renda questi controlli irraggiungibili/inutilizzabili per gli utenti della tastiera e per gli utenti di tecnologie assistive, o almeno crei un ordine di messa a fuoco generale illogico. In questi casi, considera invece l'utilizzo di una finestra di dialogo modale.
Opzioni
Le opzioni possono essere passate tramite attributi di dati o JavaScript. Per gli attributi dei dati, aggiungere il nome dell'opzione a data-bs-
, come in data-bs-animation=""
. Assicurati di cambiare il tipo di caso del nome dell'opzione da camelCase a kebab-case quando passi le opzioni tramite attributi di dati. Ad esempio, invece di usare data-bs-customClass="beautifier"
, usa data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, e
allowList
non possono essere fornite utilizzando gli attributi dei dati.
Nome | Tipo | Predefinito | Descrizione |
---|---|---|---|
animation |
booleano | true |
Applica una transizione di dissolvenza CSS al popover |
container |
stringa | elemento | falso | false |
Aggiunge il popover a un elemento specifico. Esempio: |
content |
stringa | elemento | funzione | '' |
Valore di contenuto predefinito se Se viene fornita una funzione, verrà chiamata con il suo |
delay |
numero | oggetto | 0 |
Ritardo che mostra e nasconde il popover (ms) - non si applica al tipo di trigger manuale Se viene fornito un numero, il ritardo viene applicato a entrambi nascondi/mostra La struttura dell'oggetto è: |
html |
booleano | false |
Inserisci HTML nel popover. Se false, innerText la proprietà verrà utilizzata per inserire contenuto nel DOM. Usa il testo se sei preoccupato per gli attacchi XSS. |
placement |
stringa | funzione | 'right' |
Come posizionare il popover - auto | in alto | in basso | sinistra | Giusto. Quando una funzione viene utilizzata per determinare il posizionamento, viene chiamata con il nodo DOM popover come primo argomento e il nodo DOM dell'elemento di attivazione come secondo. Il |
selector |
stringa | falso | false |
Se viene fornito un selettore, gli oggetti popover verranno delegati alle destinazioni specificate. In pratica, questo viene utilizzato per consentire al contenuto HTML dinamico di aggiungere popover. Vedi questo e un esempio informativo . |
template |
corda | '<div class="popover" role="tooltip"><div class="popover-arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
HTML di base da utilizzare durante la creazione del popover. I popover I popover
L'elemento wrapper più esterno dovrebbe avere la |
title |
stringa | elemento | funzione | '' |
Valore del titolo predefinito se Se viene fornita una funzione, verrà chiamata con il suo |
trigger |
corda | 'click' |
Come viene attivato il popover - fare clic su | passa il mouse | messa a fuoco | Manuale. Puoi passare più trigger; separali con uno spazio. manual non può essere combinato con nessun altro trigger. |
fallbackPlacements |
Vettore | ['top', 'right', 'bottom', 'left'] |
Definisci i posizionamenti di riserva fornendo un elenco di posizionamenti nella matrice (in ordine di preferenza). Per ulteriori informazioni, fare riferimento ai documenti sul comportamento di Popper |
boundary |
stringa | elemento | 'clippingParents' |
Limite del vincolo di overflow del popover (si applica solo al modificatore preventOverflow di Popper). Per impostazione predefinita è 'clippingParents' e può accettare un riferimento HTMLElement (solo tramite JavaScript). Per ulteriori informazioni, fare riferimento ai documenti detectionOverflow di Popper . |
customClass |
stringa | funzione | '' |
Aggiungi classi al popover quando viene mostrato. Tieni presente che queste classi verranno aggiunte in aggiunta a tutte le classi specificate nel modello. Per aggiungere più classi, separale con spazi: Puoi anche passare una funzione che dovrebbe restituire una singola stringa contenente nomi di classi aggiuntivi. |
sanitize |
booleano | true |
Abilita o disabilita la sanificazione. Se attivato 'template' , 'content' e 'title' le opzioni verranno sanificate. Vedi la sezione disinfettante nella nostra documentazione JavaScript . |
allowList |
oggetto | Valore di default | Oggetto che contiene attributi e tag consentiti |
sanitizeFn |
nullo | funzione | null |
Qui puoi fornire la tua funzione di sanificazione. Questo può essere utile se si preferisce utilizzare una libreria dedicata per eseguire la sanificazione. |
offset |
matrice | stringa | funzione | [0, 8] |
Offset del popover rispetto al suo target. Puoi passare una stringa negli attributi dei dati con valori separati da virgole come: Quando una funzione viene utilizzata per determinare l'offset, viene chiamata con un oggetto contenente il posizionamento popper, il riferimento e popper rects come primo argomento. Il nodo DOM dell'elemento di attivazione viene passato come secondo argomento. La funzione deve restituire un array con due numeri: . Per ulteriori informazioni, fare riferimento ai documenti di offset di Popper . |
popperConfig |
nullo | oggetto | funzione | null |
Per modificare la configurazione di Popper predefinita di Bootstrap, vedere Configurazione di Popper . Quando una funzione viene utilizzata per creare la configurazione Popper, viene chiamata con un oggetto che contiene la configurazione Popper predefinita di Bootstrap. Ti aiuta a utilizzare e unire l'impostazione predefinita con la tua configurazione. La funzione deve restituire un oggetto di configurazione per Popper. |
Attributi dei dati per i singoli popover
Le opzioni per i singoli popover possono essere specificate in alternativa tramite l'uso di attributi di dati, come spiegato sopra.
Utilizzo della funzione conpopperConfig
var popover = new bootstrap.Popover(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Metodi
Metodi e transizioni asincrone
Tutti i metodi API sono asincroni e avviano una transizione . Ritornano al chiamante non appena la transizione è iniziata ma prima che termini . Inoltre, una chiamata al metodo su un componente in transizione verrà ignorata .
Consulta la nostra documentazione JavaScript per ulteriori informazioni .
mostrare
Rivela il popover di un elemento. Ritorna al chiamante prima che il popover sia stato effettivamente mostrato (cioè prima shown.bs.popover
che si verifichi l'evento). Questo è considerato un'attivazione "manuale" del popover. I popover il cui titolo e contenuto sono entrambi di lunghezza zero non vengono mai visualizzati.
myPopover.show()
nascondere
Nasconde il popover di un elemento. Ritorna al chiamante prima che il popover sia stato effettivamente nascosto (cioè prima hidden.bs.popover
che si verifichi l'evento). Questo è considerato un'attivazione "manuale" del popover.
myPopover.hide()
alternare
Attiva/disattiva il popover di un elemento. Ritorna al chiamante prima che il popover sia stato effettivamente mostrato o nascosto (cioè prima che si verifichi l' evento shown.bs.popover
o hidden.bs.popover
). Questo è considerato un'attivazione "manuale" del popover.
myPopover.toggle()
smaltire
Nasconde e distrugge il popover di un elemento (rimuove i dati memorizzati sull'elemento DOM). I popover che utilizzano la delega (che vengono creati utilizzando l' selector
opzione ) non possono essere distrutti individualmente sugli elementi trigger discendenti.
myPopover.dispose()
abilitare
Dà al popover di un elemento la possibilità di essere mostrato. I popover sono abilitati per impostazione predefinita.
myPopover.enable()
disattivare
Rimuove la possibilità di mostrare il popover di un elemento. Il popover potrà essere mostrato solo se viene riattivato.
myPopover.disable()
attiva/disattiva
Attiva o disattiva la possibilità di mostrare o nascondere il popover di un elemento.
myPopover.toggleEnabled()
aggiornare
Aggiorna la posizione del popover di un elemento.
myPopover.update()
getInstance
Metodo statico che ti consente di ottenere l'istanza popover associata a un elemento DOM
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
getOrCreateInstance
Metodo statico che ti consente di ottenere l'istanza popover associata a un elemento DOM o di crearne una nuova nel caso non sia stata inizializzata
var exampleTriggerEl = document.getElementById('example')
var popover = bootstrap.Popover.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap popover instance
Eventi
Tipo di evento | Descrizione |
---|---|
show.bs.popover | Questo evento viene attivato immediatamente quando show viene chiamato il metodo dell'istanza. |
mostrato.bs.popover | Questo evento viene attivato quando il popover è stato reso visibile all'utente (attenderà il completamento delle transizioni CSS). |
nascondi.bs.popover | Questo evento viene generato immediatamente quando hide viene chiamato il metodo dell'istanza. |
popover.bs.nascosto | Questo evento viene attivato quando il popover ha finito di essere nascosto all'utente (attenderà il completamento delle transizioni CSS). |
inserito.bs.popover | Questo evento viene attivato dopo l' show.bs.popover evento quando il modello popover è stato aggiunto al DOM. |
var myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', function () {
// do something...
})