Instrumentorum
Documenta et exempla ad consuetudinem Bootstrap instrumentorum addendi cum CSS et JavaScript utens CSS3 pro animationibus et data-bs-attributis pro repositionis titulo locali.
Overview
Res cognoscendi cum usura tooltip plugin est:
- Tooltips innituntur 3 factionis bibliothecae Popper pro positione. Includere debetis popper.min.js ante bootstrap.js vel uti
bootstrap.bundle.min.js
/bootstrap.bundle.js
quod continet Popper ut instrumenta ad operandum! - Tooltips optet-in causis faciendis, ergo eas te ipsum initialize oportet .
- Instrumenta cum titulis zerum-longitudo numquam ostentantur.
- Specificare
container: 'body'
ad vitandas difficultates in pluribus componentibus (sicut coetus input coetus, globuli, etc). - Instrumentorum occultorum in elementis felis non laborabit.
- Tooltips enim
.disabled
veldisabled
elementum eget elementum in wrapper. - Cum ex hyperlinks utitur qui plures lineas spatiantur, instrumenta media centra erunt. Utere
white-space: nowrap;
tuo<a>
s ad vitandum hunc mores. - Instrumenta celari debent antequam elementa eorum correspondentia a dom.
- Instrumenta possunt agere per elementum intra umbram dom.
prefers-reduced-motion
interrogatione instrumentorum. Videre
motum sectionem accessibilitatis nostrae documentationis reductam .
Possedi omnia qua? Magna, videamus quomodo aliquibus exemplis operentur.
Exemplum: Admitte tooltips ubique
Uno modo ut omnia instrumenta in pagina initializent eas per data-bs-toggle
attributum eligere:
var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
return new bootstrap.Tooltip(tooltipTriggerEl)
})
Exempla
Volitant super nexus infra videre tooltips:
Placeholder textum ad demonstrandum nonnullos nexus inlineos cum instrumentis instrumentorum communicationis socialis. Nunc id consectetur justo, nec tincidunt nulla. Contentus hic positus est iustus ad imitandum praesentiam textus reali . Et omnia quae iusta tibi dant ideam quomodo instrumenta spectarent cum in adiunctis realibus mundi adhibitis. Ita spe iam vidisti quomodo instrumenta illa in nexus in praxi laborare possint, semel in situ tuo vel incepto uteris.
Super globulis infra volitant quattuor instrumenta directionum: summum, dextrum, fundum, et sinistrum. Directiones speculantur cum per 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>
Et cum consuetudine HTML additur:
<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>
Cum SVG:
Sass
Variabilium
$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;
Consuetudinem
Instrumentum plugin contentum et signum in demanda generat, et per default loca instrumenta post elementum felis suum.
Tooltip Trigger per JavaScript:
var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, options)
Redundant auto
etscroll
Tooltip positio automatice mutare conatur cum parens continens noster habet overflow: auto
vel overflow: scroll
similis .table-responsive
, sed tamen pristinam positionis collocationem servat. Ad hoc solvendum, boundary
optionem pone (pro flip determinatio optionis utentis popperConfig
) cuivis HTMLElement ut valorem default vincat, 'clippingParents'
, ut document.body
:
var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, {
boundary: document.body // or document.querySelector('#boundary')
})
Markup
Signum requisitum pro instrumenti instrumenti data
attributum est tantum et title
in elementum HTML quod tooltip habere vis. Nota notae generatae instrumenti instrumenti magis simplex est, quamquam positione requirit (per default ad top
plugin positam).
Faciens tooltips operandi tincidunt et assistive technicae users
Instrumenta instrumenta ad HTML tantum addere debes, quae tradita sunt claviaturae focus et interactiva (qualia sunt nexus vel forma controllis). Etsi arbitraria HTML elementa (sicut <span>
ss) umbilici effici possunt addito tabindex="0"
attributo, hoc potentia molestus et turbans tab cessat in elementis non-interacivis pro claviaturis usoribus, et technologiae adiuvativae in hoc situ instrumentorum nunc maxime non annuntiant. Accedite, nolite inniti solum hover
sicut felis pro instrumento tuo, sicut hoc faciet instrumenta tua impossibilia ad trigger pro claviaturis usoribus.
<!-- 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>
Debilitatum elementis
Elementa cum disabled
attributo non sunt interactive, utentes significationes non possunt focus, tabernus, vel preme eas ut tooltip trigger (vel popover). Cum habemus, voles ex fascia instrumentum felis felis <div>
vel <span>
, bene utens cinematographico-focusabile factum 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>
Optiones
Optiones transigi possunt per data attributa vel JavaScript. Data enim attributa, adiungunt optionis nomen data-bs-
, ut in data-bs-animation=""
. Fac mutare casus genus optionis nominis e camelCase ad kebab-casu cum transeundo optiones per data attributa. Exempli gratia, loco data-bs-customClass="beautifier"
uteris, uteris data-bs-custom-class="beautifier"
.
sanitize
,
sanitizeFn
, et
allowList
optiones non possunt suppeditari usura attributa data.
Nomen | Type | Default | Descriptio |
---|---|---|---|
animation |
Boolean | true |
Applicare CSS cecidimus transitus ad tooltip |
container |
string | elementum | falsus | false |
Adhibet tooltip ad elementum specificum. Exemplum: |
delay |
numerus | object | 0 |
Mora monstrans et occultans tooltip (ms) - non applicatur ad genus felis manualem Si numerus suppleatur, mora adhibenda est ad utrumque corium/show Objectum structura est: |
html |
Boolean | false |
HTML patitur in tooltip. Quod si verum est, HTML tags in instrumenti instrumenti ratione in tools Utere textu si de oppugnationibus XSS sollicitus es. |
placement |
string | officium | 'top' |
Quomodo positio tooltip - auto | top | imo | left | ius. Cum munus collocationis determinare adhibetur, cum instrumento instrumenti nodi dom nodi appellatur ut argumentum primum et elementum dom nodi excitato ut eius secundae. Contextus |
selector |
string | falsus | false |
Si electrix cautum est, instrumenta instrumentorum ad certa scuta delegabuntur. Re, hoc etiam instrumenta instrumenta ad dom elementa dynamice addita adhibere ( jQuery.on suspendium). Vide hoc et exemplum informativum . |
template |
filum | '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' |
Basi HTML uti, cum tooltip creandi. Instrumentum
Extremum elementum fasciculus debet habere |
title |
string | elementum | officium | '' |
Default title valorem si Si munus detur, vocabitur cum sua |
trigger |
filum | 'hover focus' |
Quomodo tooltip utitur - click | tabernus | focus | manuale. Plures triggers transire potes; eosque spatio.
|
fallbackPlacements |
ordinata | ['top', 'right', 'bottom', 'left'] |
Define placements fallback providens indices placementorum in ordine (in ordine praepositorum). Pro magis informationes pertinent ad mores Popper soUicitudo |
boundary |
string | elementum | 'clippingParents' |
Superfluum coactionis limitis instrumenti instrumenti (solum applicat ad determinationem Popper scriptor preventsOverflow). Defalta suus 'clippingParents' et HTMLElement referentem (per JavaScript only). For more information refer to Popper's detectOverflow docs . |
customClass |
string | officium | '' |
Classes ad tooltip addere monstratur. Nota has classes additas esse omnibus generibus in template specificatis. Ad multiplices classes, spatiis eas separa: Munus praeterea praeterire potes quod chorda unica referat quae adiectis nominibus classis continentur. |
sanitize |
Boolean | true |
Admitte vel disable sanitization. Si activated 'template' et 'title' bene sanitized erit. See the sanitizer section in our JavaScript documentation . |
allowList |
object | Default valorem | Id quod continet permissa attributa et tags |
sanitizeFn |
null | officium | null |
Hic tu munus tuum inconsideratus supplere potes. Hoc utile esse potest si bibliotheca dedicata uti mavis sanitizationem praestare. |
offset |
ordinata | string | officium | [0, 0] |
Offset tooltip relativum ad scopum suum. Filum transire potes in data attributis cum commate valores separatos similes: Cum munus cinguli definiendi adhibetur, cum obiecto popperum collocationem, relationem continet, et popper ut primum argumentum corrigit. Nodus domne elementum excitato praecessit ut secundum argumentum. Munus ordinata duobus numeris reddere debet: . For more information refer to Popper's offset docs . |
popperConfig |
null | object | officium | null |
Mutare Bootstrap default Popper config, vide configurationem Popper . Cum munus ad configurationem Popper creare adhibetur, cum obiecto dicitur, quod default Popper configurationem Bootstrap continet. Iuvat uteris et defaltam cum propria configuratione confundas. Munus obiecto configurationem reddere debet pro Popper. |
Data singulis tooltips tribuit
Optiones singulorum instrumentorum per usum attributorum datorum, ut supra dictum est, specificari possunt.
Munus cum usurapopperConfig
var tooltip = new bootstrap.Tooltip(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Methodi
Modi asynchronous et transitus
Omnes API modi asynchroni sunt et transitus committitur . Redeunt ad RECENS mox ut transitus incipiat sed antequam finiatur . Methodus praeterea in transitus transeuntis ignorabitur .
ostende
Elementum demonstrat tooltip. RECENS redit ad instrumentum ante demonstratum (id est antequam shown.bs.tooltip
evenit). Hoc habetur "manuale" excitato instrumenti instrumenti. Instrumenta cum titulis zerum-longitudo numquam ostentantur.
tooltip.show()
celare
Instrumentum elementum celat. Redit ad RECENS ante instrumentum absconditum (id est antequam hidden.bs.tooltip
evenit). Hoc habetur "manuale" excitato instrumenti instrumenti.
tooltip.hide()
toggle
Toggles tooltip elementum est. RECENS redit ad instrumentum ante demonstratum vel absconditum (id est ante shown.bs.tooltip
vel hidden.bs.tooltip
eventum). Hoc habetur "manuale" excitato instrumenti instrumenti.
tooltip.toggle()
dispono
Coria et instrumentum elementi destruit (reposita removet data in elementum dom). Instrumenta delegationis utentium ( quae selector
optione utente creantur ) singulariter destrui non possunt in elementis felis descendentibus.
tooltip.dispose()
da "
Instrumentum instrumentum elementi facultatem demonstrandi dat. Instrumenta per defaltam possunt.
tooltip.enable()
disable
Facultatem removet instrumentum ad ostensionem elementi. Instrumentum instrumentum tantum demonstrari poterit si re-paratur.
tooltip.disable()
toggleEnabled
Toggles facultatem instrumenti elementi exhibendi vel absconditi.
tooltip.toggleEnabled()
renovatio
Renovat locum tooltip elementi.
tooltip.update()
getInstance
Statica methodus quae te permittit ut instantia instrumenti instrumenti ad elementum dom consociata
var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance
getOrCreateInstance
Statica methodus quae te permittit ut instantia instrumenti instrumenti cum elemento DOM adiuncto accipias, vel novum efficias in casu non initialized
var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance
Events
Genus res | Descriptio |
---|---|
show.bs.tooltip |
Huius rei accendit statim cum show instantia methodus appellatur. |
shown.bs.tooltip |
Eventus hic accensus est cum instrumentum usoris conspicuum factum est (exspectabit CSS transitus ad perficiendum). |
hide.bs.tooltip |
Hic eventus statim accensus est cum hide methodus instantia vocata est. |
hidden.bs.tooltip |
Eventus hic accensus est cum tooltip occultatum ab usore complevit (exspectabit CSS transitus ad perficiendum). |
inserted.bs.tooltip |
Hic eventus post eventum accensus est show.bs.tooltip cum instrumentum tabulae instrumentorum ad dom additum est. |
var myTooltipEl = document.getElementById('myTooltip')
var tooltip = new bootstrap.Tooltip(myTooltipEl)
myTooltipEl.addEventListener('hidden.bs.tooltip', function () {
// do something...
})
tooltip.hide()