Popovers
Documentação e exemplos para adicionar popovers do Bootstrap, como os encontrados no iOS, a qualquer elemento do seu site.
Visão geral
Coisas para saber ao usar o plugin popover:
- Popovers contam com a biblioteca de terceiros Popper para posicionamento. Você deve incluir popper.min.js antes de bootstrap.js ou usar
bootstrap.bundle.min.js
/bootstrap.bundle.js
que contém Popper para que os popovers funcionem! - Os popovers exigem o plug -in de dica de ferramenta como uma dependência.
- Se você estiver construindo nosso JavaScript a partir da fonte, ele requer
util.js
. - Os popovers são opcionais por motivos de desempenho, portanto, você mesmo deve inicializá-los .
- O comprimento zero
title
econtent
os valores nunca mostrarão um popover. - Especifique
container: 'body'
para evitar problemas de renderização em componentes mais complexos (como nossos grupos de entrada, grupos de botões etc.). - Acionar popovers em elementos ocultos não funcionará.
- Popovers para
.disabled
oudisabled
elementos devem ser acionados em um elemento wrapper. - Quando acionados a partir de âncoras que envolvem várias linhas, os popovers serão centralizados entre a largura total das âncoras. Use
.text-nowrap
em seus<a>
s para evitar esse comportamento. - Os popovers devem ser ocultados antes que seus elementos correspondentes sejam removidos do DOM.
- Popovers podem ser acionados graças a um elemento dentro de um shadow DOM.
prefers-reduced-motion
consulta de mídia. Consulte a
seção de movimento reduzido de nossa documentação de acessibilidade .
Continue lendo para ver como os popovers funcionam com alguns exemplos.
Exemplo: ativar popovers em todos os lugares
Uma maneira de inicializar todos os popovers em uma página seria selecioná-los por seu data-toggle
atributo:
$(function () {
$('[data-toggle="popover"]').popover()
})
Exemplo: Usando a container
opção
Quando você tiver alguns estilos em um elemento pai que interferem com um popover, você desejará especificar um personalizado container
para que o HTML do popover apareça dentro desse elemento.
$(function () {
$('.example-popover').popover({
container: 'body'
})
})
Exemplo
<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>
Quatro direções
Quatro opções estão disponíveis: alinhamento superior, direito, inferior e alinhamento à esquerda.
<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>
Dispensar no próximo clique
Use o focus
gatilho para dispensar popovers no próximo clique do usuário em um elemento diferente do elemento de alternância.
Marcação específica necessária para dispensar no próximo clique
Para um comportamento adequado entre navegadores e plataformas, você deve usar a <a>
tag, não a <button>
tag, e também deve incluir um tabindex
atributo.
<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'
})
Elementos desativados
Elementos com o disabled
atributo não são interativos, o que significa que os usuários não podem passar o mouse ou clicar neles para acionar um popover (ou dica de ferramenta). Como solução alternativa, você desejará acionar o popover de um wrapper <div>
ou <span>
substituir o pointer-events
no elemento desativado.
Para gatilhos de popover desativados, você também pode preferir data-trigger="hover"
que o popover apareça como feedback visual imediato para seus usuários, pois eles podem não esperar clicar em um elemento desativado.
<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>
Uso
Habilite popovers via JavaScript:
$('#example').popover(options)
Aceleração da GPU
Às vezes, os popovers aparecem embaçados em dispositivos Windows 10 devido à aceleração da GPU e a um DPI do sistema modificado. A solução para isso na v4 é desabilitar a aceleração da GPU conforme necessário em seus popovers.
Correção sugerida:
Popper.Defaults.modifiers.computeStyle.gpuAcceleration = !(window.devicePixelRatio < 1.5 && /Win/.test(navigator.platform))
Fazendo popovers funcionarem para usuários de teclado e tecnologia assistiva
Para permitir que usuários de teclado ativem seus popovers, você deve adicioná-los apenas a elementos HTML que são tradicionalmente focados no teclado e interativos (como links ou controles de formulário). Embora elementos HTML arbitrários (como <span>
s) possam ser focalizados adicionando o tabindex="0"
atributo, isso adicionará paradas de tabulação potencialmente irritantes e confusas em elementos não interativos para usuários de teclado, e a maioria das tecnologias assistivas atualmente não anuncia o conteúdo do popover nessa situação . Além disso, não confie apenas no hover
gatilho para seus popovers, pois isso os tornará impossíveis de acionar para usuários de teclado.
Embora você possa inserir HTML rico e estruturado em popovers com a html
opção, recomendamos que você evite adicionar uma quantidade excessiva de conteúdo. A maneira como os popovers funcionam atualmente é que, uma vez exibidos, seu conteúdo é vinculado ao elemento de gatilho com o aria-describedby
atributo. Como resultado, todo o conteúdo do popover será anunciado aos usuários de tecnologia assistiva como um fluxo longo e ininterrupto.
Além disso, embora seja possível incluir também controles interativos (como elementos de formulário ou links) em seu popover (adicionando esses elementos aos whiteList
atributos e tags permitidos), esteja ciente de que atualmente o popover não gerencia a ordem de foco do teclado. Quando um usuário de teclado abre um popover, o foco permanece no elemento acionador e, como o popover geralmente não segue imediatamente o acionador na estrutura do documento, não há garantia de que avançar/pressionarTABmoverá um usuário de teclado para o próprio popover. Em suma, simplesmente adicionar controles interativos a um popover provavelmente tornará esses controles inacessíveis/inutilizáveis para usuários de teclado e usuários de tecnologias assistivas, ou pelo menos criar uma ordem de foco geral ilógica. Nesses casos, considere usar uma caixa de diálogo modal.
Opções
As opções podem ser passadas por meio de atributos de dados ou JavaScript. Para atributos de dados, anexe o nome da opção a data-
, como em data-animation=""
.
sanitize
opções
sanitizeFn
e
whiteList
não podem ser fornecidas usando atributos de dados.
Nome | Modelo | Predefinição | Descrição |
---|---|---|---|
animação | boleano | verdadeiro | Aplicar uma transição de fade CSS ao popover |
recipiente | seqüência | elemento | falso | falso | Acrescenta o popover a um elemento específico. Exemplo: |
contente | seqüência | elemento | função | '' | Valor de conteúdo padrão se Se uma função for fornecida, ela será chamada com sua |
atraso | número | objeto | 0 | Atraso na exibição e ocultação do popover (ms) - não se aplica ao tipo de gatilho manual Se um número for fornecido, o atraso será aplicado tanto para ocultar/exibir A estrutura do objeto é: |
html | boleano | falso | Insira o HTML no popover. Se false, o text método do jQuery será usado para inserir conteúdo no DOM. Use texto se estiver preocupado com ataques XSS. |
colocação | seqüência | função | 'certo' | Como posicionar o popover - auto | topo | inferior | esquerda | certo. Quando uma função é usada para determinar o posicionamento, ela é chamada com o nó DOM popover como seu primeiro argumento e o nó DOM do elemento acionador como seu segundo. O |
seletor | seqüência | falso | falso | Se um seletor for fornecido, os objetos popover serão delegados aos destinos especificados. Na prática, isso é usado para permitir que o conteúdo HTML dinâmico tenha popovers adicionados. Veja este e um exemplo informativo . |
modelo | corda | '<div class="popover" role="tooltip"><div class="arrow"></div><h3 class="popover-header"></h3><div class="popover-body"></div></div>' |
HTML base para usar ao criar o popover. Os popovers Os popovers
O elemento wrapper mais externo deve ter a |
título | seqüência | elemento | função | '' | Valor de título padrão se o Se uma função for fornecida, ela será chamada com sua |
acionar | corda | 'clique' | Como o popover é acionado - clique | pairar | foco | manual. Você pode passar vários gatilhos; separe-os com um espaço. manual não pode ser combinado com nenhum outro gatilho. |
Deslocamento | número | corda | 0 | Deslocamento do popover em relação ao seu destino. Para obter mais informações, consulte os documentos de deslocamento de Popper . |
fallbackPlace | seqüência | variedade | 'virar' | Permite especificar qual posição o Popper usará no fallback. Para obter mais informações, consulte os documentos de comportamento de Popper |
customClass | seqüência | função | '' | Adicione classes ao popover quando ele for exibido. Observe que essas classes serão adicionadas além de quaisquer classes especificadas no modelo. Para adicionar várias classes, separe-as com espaços: Você também pode passar uma função que deve retornar uma única string contendo nomes de classes adicionais. |
fronteira | seqüência | elemento | 'scrollParent' | Limite de restrição de estouro do popover. Aceita os valores de 'viewport' , 'window' , 'scrollParent' ou uma referência HTMLElement (somente JavaScript). Para obter mais informações, consulte os documentos preventOverflow do Popper . |
higienizar | boleano | verdadeiro | Habilite ou desabilite a higienização. Se ativado 'template' , 'content' as 'title' opções serão higienizadas. Consulte a seção de limpeza em nossa documentação JavaScript . |
lista branca | objeto | Valor padrão | Objeto que contém atributos e tags permitidos |
higienizarFn | nulo | função | nulo | Aqui você pode fornecer sua própria função de higienização. Isso pode ser útil se você preferir usar uma biblioteca dedicada para realizar a higienização. |
popperConfig | nulo | objeto | nulo | Para alterar a configuração padrão do Popper do Bootstrap, consulte a configuração do Popper |
Atributos de dados para popovers individuais
Opções para popovers individuais podem ser especificadas alternativamente através do uso de atributos de dados, conforme explicado acima.
Métodos
Métodos e transições assíncronas
Todos os métodos de API são assíncronos e iniciam uma transição . Eles retornam ao chamador assim que a transição é iniciada, mas antes que ela termine . Além disso, uma chamada de método em um componente de transição será ignorada .
Consulte nossa documentação JavaScript para obter mais informações .
$().popover(options)
Inicializa popovers para uma coleção de elementos.
.popover('show')
Revela o popover de um elemento. Retorna ao chamador antes que o popover tenha sido realmente mostrado (ou seja, antes que o shown.bs.popover
evento ocorra). Isso é considerado um acionamento “manual” do popover. Os popovers cujo título e conteúdo são ambos de comprimento zero nunca são exibidos.
$('#element').popover('show')
.popover('hide')
Oculta o popover de um elemento. Retorna ao chamador antes que o popover tenha sido ocultado (ou seja, antes que o hidden.bs.popover
evento ocorra). Isso é considerado um acionamento “manual” do popover.
$('#element').popover('hide')
.popover('toggle')
Alterna o popover de um elemento. Retorna ao chamador antes que o popover tenha sido exibido ou ocultado (ou seja, antes que o evento shown.bs.popover
ou hidden.bs.popover
ocorra). Isso é considerado um acionamento “manual” do popover.
$('#element').popover('toggle')
.popover('dispose')
Esconde e destrói o popover de um elemento. Popovers que usam delegação (que são criados usando a selector
opção ) não podem ser destruídos individualmente em elementos de disparo descendentes.
$('#element').popover('dispose')
.popover('enable')
Dá ao popover de um elemento a capacidade de ser mostrado. Os popovers são ativados por padrão.
$('#element').popover('enable')
.popover('disable')
Remove a capacidade de mostrar o popover de um elemento. O popover só poderá ser exibido se for reativado.
$('#element').popover('disable')
.popover('toggleEnabled')
Alterna a capacidade de mostrar ou ocultar o popover de um elemento.
$('#element').popover('toggleEnabled')
.popover('update')
Atualiza a posição do popover de um elemento.
$('#element').popover('update')
Eventos
Tipo de evento | Descrição |
---|---|
show.bs.popover | Este evento é acionado imediatamente quando o show método de instância é chamado. |
mostrado.bs.popover | Este evento é acionado quando o popover se torna visível para o usuário (aguardará a conclusão das transições CSS). |
hide.bs.popover | Este evento é acionado imediatamente quando o hide método de instância é chamado. |
oculto.bs.popover | Este evento é acionado quando o popover termina de ser ocultado do usuário (aguardará a conclusão das transições CSS). |
inserido.bs.popover | Este evento é acionado após o show.bs.popover evento quando o modelo popover foi adicionado ao DOM. |
$('#myPopover').on('hidden.bs.popover', function () {
// do something...
})