Knopinfo
Documentatie en voorbeelden voor het toevoegen van aangepaste Bootstrap-tooltips met CSS en JavaScript met CSS3 voor animaties en data-bs-attributen voor lokale titelopslag.
Overzicht
Wat u moet weten bij het gebruik van de tooltip-plug-in:
- Tooltips vertrouwen op de 3rd party bibliotheek Popper voor positionering. U moet popper.min.js vóór bootstrap.js opnemen of
bootstrap.bundle.min.js
/ gebruikenbootstrap.bundle.js
die Popper bevat om tooltips te laten werken! - Tooltips zijn opt-in om prestatieredenen, dus u moet ze zelf initialiseren .
- Knopinfo met titels met een lengte van nul worden nooit weergegeven.
- Specificeer
container: 'body'
om weergaveproblemen in complexere componenten te voorkomen (zoals onze invoergroepen, knopgroepen, enz.). - Het activeren van tooltips op verborgen elementen werkt niet.
- Tooltips voor
.disabled
ofdisabled
elementen moeten worden geactiveerd op een wrapper-element. - Wanneer geactiveerd door hyperlinks die meerdere regels overspannen, worden tooltips gecentreerd. Gebruik
white-space: nowrap;
op uw<a>
s om dit gedrag te voorkomen. - Knopinfo moet worden verborgen voordat de bijbehorende elementen uit het DOM zijn verwijderd.
- Tooltips kunnen worden geactiveerd dankzij een element in een schaduw-DOM.
prefers-reduced-motion
mediaquery. Zie het
gedeelte over beperkte beweging van onze toegankelijkheidsdocumentatie .
Heb je dat allemaal? Geweldig, laten we eens kijken hoe ze werken met enkele voorbeelden.
Voorbeeld: Knopinfo overal inschakelen
Een manier om alle knopinfo op een pagina te initialiseren, is door ze op hun data-bs-toggle
attribuut te selecteren:
var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
return new bootstrap.Tooltip(tooltipTriggerEl)
})
Voorbeelden
Plaats de muisaanwijzer op de onderstaande links om tooltips te zien:
Tijdelijke tekst om enkele inline-links met tooltips te demonstreren. Dit is nu gewoon opvulling, geen moordenaar. Inhoud die hier is geplaatst om de aanwezigheid van echte tekst na te bootsen . En dat allemaal om u een idee te geven van hoe tooltips eruit zouden zien als ze in echte situaties worden gebruikt. Dus hopelijk heb je nu gezien hoe deze tooltips over links in de praktijk kunnen werken, als je ze eenmaal op je eigen site of project gebruikt.
Plaats de muisaanwijzer op de onderstaande knoppen om de vier tooltips-richtingen te zien: boven, rechts, onder en links. Routebeschrijvingen worden gespiegeld bij gebruik van Bootstrap in RTL.
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="top" title="Tooltip on top">
Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="right" title="Tooltip on right">
Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Tooltip on bottom">
Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="left" title="Tooltip on left">
Tooltip on left
</button>
En met aangepaste HTML toegevoegd:
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
Tooltip with HTML
</button>
Met een SVG:
Sass
Variabelen
$tooltip-font-size: $font-size-sm;
$tooltip-max-width: 200px;
$tooltip-color: $white;
$tooltip-bg: $black;
$tooltip-border-radius: $border-radius;
$tooltip-opacity: .9;
$tooltip-padding-y: $spacer * .25;
$tooltip-padding-x: $spacer * .5;
$tooltip-margin: 0;
$tooltip-arrow-width: .8rem;
$tooltip-arrow-height: .4rem;
$tooltip-arrow-color: $tooltip-bg;
Gebruik
De tooltip-plug-in genereert on-demand inhoud en markeringen en plaatst standaard tooltips na hun trigger-element.
Activeer de knopinfo via JavaScript:
var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, options)
Overloop auto
enscroll
De positie van de knopinfo probeert automatisch te veranderen wanneer een bovenliggende container onze heeft overflow: auto
of overflow: scroll
leuk vindt .table-responsive
, maar behoudt nog steeds de positionering van de oorspronkelijke plaatsing. Om dit op te lossen, stelt u de boundary
optie (voor de flip-modifier die de popperConfig
optie gebruikt) in op een HTMLElement om de standaardwaarde te overschrijven 'clippingParents'
, zoals document.body
:
var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, {
boundary: document.body // or document.querySelector('#boundary')
})
Markup
De vereiste opmaak voor een tooltip is slechts een data
attribuut en title
op het HTML-element wil je een tooltip hebben. De gegenereerde opmaak van een tooltip is vrij eenvoudig, maar vereist wel een positie (standaard ingesteld top
door de plug-in).
Knopinfo laten werken voor gebruikers van toetsenborden en ondersteunende technologie
Voeg alleen tooltips toe aan HTML-elementen die traditioneel gericht zijn op het toetsenbord en interactief zijn (zoals koppelingen of formulierbesturingselementen). Hoewel willekeurige HTML-elementen (zoals <span>
s) focusseerbaar kunnen worden gemaakt door het tabindex="0"
attribuut toe te voegen, zal dit voor toetsenbordgebruikers mogelijk vervelende en verwarrende tabstops toevoegen op niet-interactieve elementen, en de meeste ondersteunende technologieën geven momenteel geen tooltip aan in deze situatie. Vertrouw er bovendien niet alleen op hover
als de trigger voor uw tooltip, omdat dit ervoor zorgt dat uw tooltips niet kunnen worden geactiveerd voor toetsenbordgebruikers.
<!-- HTML to write -->
<a href="#" data-bs-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="tooltip-arrow"></div>
<div class="tooltip-inner">
Some tooltip text!
</div>
</div>
Uitgeschakelde elementen
Elementen met het disabled
attribuut zijn niet interactief, wat betekent dat gebruikers niet kunnen focussen, de muisaanwijzer erop kunnen plaatsen of erop kunnen klikken om knopinfo (of popover) te activeren. Als tijdelijke oplossing wilt u de knopinfo activeren vanuit een wrapper <div>
of <span>
, idealiter gemaakt voor toetsenbordfocus met behulp van tabindex="0"
.
<span class="d-inline-block" tabindex="0" data-bs-toggle="tooltip" title="Disabled tooltip">
<button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>
Opties
Opties kunnen worden doorgegeven via data-attributen of JavaScript. Voeg voor gegevensattributen de optienaam toe aan data-bs-
, zoals in data-bs-animation=""
. Zorg ervoor dat u het kasttype van de optienaam wijzigt van camelCase in kebab-case wanneer u de opties doorgeeft via gegevensattributen. Gebruik bijvoorbeeld in plaats data-bs-customClass="beautifier"
van data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, en
allowList
niet kunnen worden geleverd met gegevensattributen.
Naam | Type | Standaard | Beschrijving |
---|---|---|---|
animation |
booleaans | true |
Pas een CSS-vervagingsovergang toe op de knopinfo |
container |
tekenreeks | element | vals | false |
Voegt de knopinfo toe aan een specifiek element. Voorbeeld: |
delay |
nummer | object | 0 |
Vertraging bij het tonen en verbergen van de knopinfo (ms) - is niet van toepassing op het handmatige triggertype Als een nummer wordt opgegeven, wordt vertraging toegepast op zowel verbergen/weergeven Objectstructuur is: |
html |
booleaans | false |
HTML toestaan in de knopinfo. Indien waar, worden HTML-tags in de tooltip Gebruik sms als je je zorgen maakt over XSS-aanvallen. |
placement |
tekenreeks | functie | 'top' |
Hoe de tooltip te positioneren - auto | naar boven | onderaan | links | Rechtsaf. Wanneer een functie wordt gebruikt om de plaatsing te bepalen, wordt deze aangeroepen met de tooltip DOM-node als eerste argument en het triggerende element DOM-node als tweede. De |
selector |
tekenreeks | vals | false |
Als er een selector is, worden knopinfo-objecten gedelegeerd aan de opgegeven doelen. In de praktijk wordt dit gebruikt om ook tooltips toe te passen op dynamisch toegevoegde DOM-elementen ( jQuery.on ondersteuning). Zie dit en een informatief voorbeeld . |
template |
snaar | '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' |
Basis-HTML om te gebruiken bij het maken van de knopinfo. De tooltip's
Het buitenste wrapper-element moet de |
title |
tekenreeks | element | functie | '' |
Standaardtitelwaarde als Als een functie is opgegeven, wordt deze aangeroepen met de |
trigger |
snaar | 'hover focus' |
Hoe knopinfo wordt geactiveerd - klik op | zweven | focus | handleiding. U kunt meerdere triggers doorgeven; scheid ze met een spatie.
|
fallbackPlacements |
reeks | ['top', 'right', 'bottom', 'left'] |
Definieer fallback-plaatsingen door een lijst met plaatsingen in een array op te geven (in volgorde van voorkeur). Raadpleeg voor meer informatie de gedragsdocumenten van Popper |
boundary |
tekenreeks | element | 'clippingParents' |
Overloopbeperkingsgrens van de tooltip (geldt alleen voor de preventOverflow-modifier van Popper). Standaard is 'clippingParents' en kan het een HTMLElement-referentie accepteren (alleen via JavaScript). Voor meer informatie raadpleegt u Popper's detectOverflow docs . |
customClass |
tekenreeks | functie | '' |
Voeg klassen toe aan de knopinfo wanneer deze wordt weergegeven. Houd er rekening mee dat deze klassen worden toegevoegd naast de klassen die in de sjabloon zijn gespecificeerd. Om meerdere klassen toe te voegen, scheidt u ze met spaties: U kunt ook een functie doorgeven die een enkele tekenreeks moet retourneren met extra klassenamen. |
sanitize |
booleaans | true |
Schakel de desinfectie in of uit. Indien geactiveerd 'template' en 'title' opties zullen worden opgeschoond. Zie de sectie over ontsmettingsmiddelen in onze JavaScript-documentatie . |
allowList |
object | Standaardwaarde | Object dat toegestane attributen en tags bevat |
sanitizeFn |
null | functie | null |
Hier kunt u uw eigen ontsmettingsfunctie leveren. Dit kan handig zijn als u liever een speciale bibliotheek gebruikt om op te schonen. |
offset |
reeks | tekenreeks | functie | [0, 0] |
Offset van de tooltip ten opzichte van het doel. U kunt een tekenreeks in gegevensattributen doorgeven met door komma's gescheiden waarden zoals: Wanneer een functie wordt gebruikt om de offset te bepalen, wordt deze aangeroepen met een object dat de popper-plaatsing, de referentie en popper-rects als eerste argument bevat. Het triggerelement DOM-knooppunt wordt doorgegeven als het tweede argument. De functie moet een array teruggeven met twee getallen: . Raadpleeg voor meer informatie de offsetdocumenten van Popper . |
popperConfig |
null | object | functie | null |
Zie de configuratie van Popper om de standaard Popper-configuratie van Bootstrap te wijzigen . Wanneer een functie wordt gebruikt om de Popper-configuratie te maken, wordt deze aangeroepen met een object dat de standaard Popper-configuratie van Bootstrap bevat. Het helpt u de standaard te gebruiken en samen te voegen met uw eigen configuratie. De functie moet een configuratieobject voor Popper teruggeven. |
Gegevensattributen voor individuele knopinfo
Opties voor individuele tooltips kunnen ook worden gespecificeerd door het gebruik van data-attributen, zoals hierboven uitgelegd.
Functie gebruiken metpopperConfig
var tooltip = new bootstrap.Tooltip(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Methoden:
Asynchrone methoden en overgangen
Alle API-methoden zijn asynchroon en starten een transitie . Ze keren terug naar de beller zodra de overgang is gestart maar voordat deze eindigt . Bovendien wordt een methodeaanroep op een overgangscomponent genegeerd .
show
Onthult de tooltip van een element. Keert terug naar de beller voordat de tooltip daadwerkelijk is getoond (dwz voordat de shown.bs.tooltip
gebeurtenis plaatsvindt). Dit wordt beschouwd als een "handmatige" activering van de tooltip. Knopinfo met titels van lengte nul worden nooit weergegeven.
tooltip.show()
verbergen
Verbergt de knopinfo van een element. Keert terug naar de beller voordat de knopinfo daadwerkelijk is verborgen (dwz voordat de hidden.bs.tooltip
gebeurtenis plaatsvindt). Dit wordt beschouwd als een "handmatige" activering van de tooltip.
tooltip.hide()
schakelaar
Schakelt de knopinfo van een element in. Keert terug naar de beller voordat de tooltip daadwerkelijk is getoond of verborgen (dwz voordat de shown.bs.tooltip
of hidden.bs.tooltip
-gebeurtenis plaatsvindt). Dit wordt beschouwd als een "handmatige" activering van de tooltip.
tooltip.toggle()
weggooien
Verbergt en vernietigt de tooltip van een element (verwijdert opgeslagen gegevens op het DOM-element). Tooltips die delegatie gebruiken (die zijn gemaakt met de selector
optie ) kunnen niet afzonderlijk worden vernietigd op onderliggende triggerelementen.
tooltip.dispose()
inschakelen
Geeft de tooltip van een element de mogelijkheid om te worden weergegeven. Knopinfo is standaard ingeschakeld.
tooltip.enable()
uitzetten
Verwijdert de mogelijkheid om de knopinfo van een element weer te geven. De knopinfo kan alleen worden weergegeven als deze opnieuw wordt ingeschakeld.
tooltip.disable()
toggleIngeschakeld
Schakelt de mogelijkheid om de knopinfo van een element te tonen of te verbergen.
tooltip.toggleEnabled()
update
Werkt de positie van de knopinfo van een element bij.
tooltip.update()
getInstance
Statische methode waarmee u de tooltip-instantie kunt krijgen die is gekoppeld aan een DOM-element
var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance
getOrCreateInstance
Statische methode waarmee u de tooltip-instantie kunt krijgen die is gekoppeld aan een DOM-element, of een nieuwe kunt maken voor het geval deze niet is geïnitialiseerd
var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance
Evenementen
Evenementtype | Beschrijving |
---|---|
show.bs.tooltip |
Deze gebeurtenis wordt onmiddellijk geactiveerd wanneer de show instantiemethode wordt aangeroepen. |
shown.bs.tooltip |
Deze gebeurtenis wordt geactiveerd wanneer de knopinfo zichtbaar is gemaakt voor de gebruiker (wacht tot de CSS-overgangen zijn voltooid). |
hide.bs.tooltip |
Deze gebeurtenis wordt onmiddellijk geactiveerd wanneer de hide instantiemethode is aangeroepen. |
hidden.bs.tooltip |
Deze gebeurtenis wordt geactiveerd wanneer de knopinfo niet meer voor de gebruiker verborgen is (wacht tot de CSS-overgangen zijn voltooid). |
inserted.bs.tooltip |
Deze gebeurtenis wordt geactiveerd na de show.bs.tooltip gebeurtenis wanneer de tooltip-sjabloon is toegevoegd aan de DOM. |
var myTooltipEl = document.getElementById('myTooltip')
var tooltip = new bootstrap.Tooltip(myTooltipEl)
myTooltipEl.addEventListener('hidden.bs.tooltip', function () {
// do something...
})
tooltip.hide()