Verktygstips

Dokumentation och exempel för att lägga till anpassade Bootstrap-verktygstips med CSS och JavaScript med CSS3 för animationer och dataattribut för lokal titellagring.

Översikt

Saker att veta när du använder verktygstipsplugin:

• Verktygstips förlitar sig på tredje parts bibliotek Popper.js för positionering. Du måste inkludera popper.min.js före bootstrap.js eller använda bootstrap.bundle.min.js/ bootstrap.bundle.jssom innehåller Popper.js för att verktygstips ska fungera!
• Om du bygger vårt JavaScript från källan kräverutil.js det .
• Verktygstips är opt-in av prestandaskäl, så du måste initiera dem själv .
• Verktygstips med noll-längd titlar visas aldrig.
• Ange container: 'body'för att undvika att problem återges i mer komplexa komponenter (som våra indatagrupper, knappgrupper, etc).
• Att trigga verktygstips på dolda element kommer inte att fungera.
• Verktygstips för .disabledeller disabledelement måste utlösas på ett omslagselement.
• När de utlöses från hyperlänkar som sträcker sig över flera rader kommer verktygstips att centreras. Använd white-space: nowrap;på din <a>s för att undvika detta beteende.
• Verktygstips måste döljas innan deras motsvarande element har tagits bort från DOM.
• Verktygstips kan triggas tack vare ett element inuti en skugga DOM.

Har du allt det där? Bra, låt oss se hur de fungerar med några exempel.

Exempel: Aktivera verktygstips överallt

Ett sätt att initiera alla verktygstips på en sida är att välja dem efter deras data-toggleattribut:

$(function () {
  $('[data-toggle="tooltip"]').tooltip()
})

Exempel

Håll muspekaren över länkarna nedan för att se verktygstips:

Håll muspekaren över knapparna nedan för att se de fyra verktygstipsriktningarna: topp, höger, botten och vänster.

<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
  Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">
  Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">
  Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
  Tooltip on left
</button>

Och med anpassad HTML tillagd:

<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
  Tooltip with HTML
</button>

Användande

Verktygstipspluginen genererar innehåll och uppmärkning på begäran och placerar som standard verktygstips efter deras utlösarelement.

Aktivera verktygstipset via JavaScript:

$('#example').tooltip(options)

$('#example').tooltip({ boundary: 'window' })

Pålägg

Den nödvändiga markeringen för ett verktygstips är bara ett dataattribut och titlepå HTML-elementet vill du ha ett verktygstips. Den genererade markeringen av ett verktygstips är ganska enkel, även om den kräver en position (som standard inställd på topav plugin).

<!-- HTML to write -->
<a href="#" data-toggle="tooltip" title="Some tooltip text!">Hover over me</a>

<!-- Generated markup by the plugin -->
<div class="tooltip bs-tooltip-top" role="tooltip">
  <div class="arrow"></div>
  <div class="tooltip-inner">
    Some tooltip text!
  </div>
</div>

Inaktiverade element

Element med disabledattributet är inte interaktiva, vilket innebär att användare inte kan fokusera, hålla muspekaren eller klicka på dem för att utlösa ett verktygstips (eller popover). Som en lösning bör du trigga verktygstipset från ett omslag <div>eller <span>, idealiskt gjort tangentbordsfokuseringsbart med tabindex="0", och åsidosätta pointer-eventspå det inaktiverade elementet.

<span class="d-inline-block" tabindex="0" data-toggle="tooltip" title="Disabled tooltip">
  <button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>

alternativ

Alternativ kan skickas via dataattribut eller JavaScript. För dataattribut, lägg till alternativnamnet till data-, som i data-animation="".

Metoder

$().tooltip(options)

Bifogar en verktygstipshanterare till en elementsamling.

.tooltip('show')

Visar ett elements verktygstips. Återgår till den som ringer innan verktygstipset faktiskt har visats (dvs innan shown.bs.tooltiphändelsen inträffar). Detta anses vara en "manuell" triggning av verktygstipset. Verktygstips med noll-längd titlar visas aldrig.

$('#element').tooltip('show')

.tooltip('hide')

Döljer ett elements verktygstips. Återgår till den som ringer innan verktygstipset faktiskt har dolts (dvs innan hidden.bs.tooltiphändelsen inträffar). Detta anses vara en "manuell" triggning av verktygstipset.

$('#element').tooltip('hide')

.tooltip('toggle')

Växlar ett elements verktygstips. Återgår till den som ringer innan verktygstipset faktiskt har visats eller dolt (dvs innan händelsen shown.bs.tooltipeller hidden.bs.tooltipinträffar). Detta anses vara en "manuell" triggning av verktygstipset.

$('#element').tooltip('toggle')

.tooltip('dispose')

Döljer och förstör ett elements verktygstips. Verktygstips som använder delegering (som skapas med alternativet selector) kan inte förstöras individuellt på underliggande triggerelement.

$('#element').tooltip('dispose')

.tooltip('enable')

Ger ett elements verktygstips möjligheten att visas. Verktygstips är aktiverade som standard.

$('#element').tooltip('enable')

.tooltip('disable')

Tar bort möjligheten för ett elements verktygstips att visas. Verktygstipset kommer bara att kunna visas om det återaktiveras.

$('#element').tooltip('disable')

.tooltip('toggleEnabled')

Växlar möjligheten för ett elements verktygstips att visas eller döljas.

$('#element').tooltip('toggleEnabled')

.tooltip('update')

Uppdaterar positionen för ett elements verktygstips.

$('#element').tooltip('update')

evenemang

$('#myTooltip').on('hidden.bs.tooltip', function () {
  // do something…
})