Skip to main content Skip ad navigationem soUicitudo
Check
in English

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 nituntur tertiae factionis bibliothecae Popper pro positione. Ante popper.min.js includere debes bootstrap.js, vel eo uti , bootstrap.bundle.min.jsquod popper continet.
  • 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 for .disabledor disabledelements must be Urguet in wrapper elementum.
  • 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.

Possedi omnia qua? Magna, videamus quomodo aliquibus exemplis operentur.

Defalta, haec pars utitur sanitizer aedificato in contentis, quae exuit aliqua elementa HTML quae explicite non licet. Vide sectionem sanitizer in documentis nostris JavaScript pro magis details.
Effectus animationis huius componentis dependet ex prefers-reduced-motioninterrogatione instrumentorum. Videre motum sectionem accessibilitatis nostrae documentationis reductam .

Exempla

Admitte tooltips

Ut supra dictum est, instrumenta prima initialize antequam adhiberi possunt. Uno modo ut omnia instrumenta instrumentorum in pagina initializent eas ex suo data-bs-toggleattributo eligere, sicut sic:

const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))

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.

html
<p class="muted">Placeholder text to demonstrate some <a href="#" data-bs-toggle="tooltip" data-bs-title="Default tooltip">inline links</a> with tooltips. This is now just filler, no killer. Content placed here just to mimic the presence of <a href="#" data-bs-toggle="tooltip" data-bs-title="Another tooltip">real text</a>. And all that just to give you an idea of how tooltips would look when used in real-world situations. So hopefully you've now seen how <a href="#" data-bs-toggle="tooltip" data-bs-title="Another one here too">these tooltips on links</a> can work in practice, once you use them on <a href="#" data-bs-toggle="tooltip" data-bs-title="The last tip!">your own</a> site or project.
</p>
Libenter utere vel titlevel data-bs-titlein HTML tuo. Cum titleadhibetur, Popper automatice restituet data-bs-titlecum elementum redditum est.

Custom tooltips

Additur in v5.2.0

CSS variabilium specierum instrumentorum consuetudines uti potes . Consuetudo classium constituimus cum data-bs-custom-class="custom-tooltip"forma consuetudinum nostrarum adaequanda et ea utimur ad variabilem localem CSS vincendum.

.custom-tooltip {
  --bs-tooltip-bg: var(--bs-primary);
}
html
<button type="button" class="btn btn-secondary"
        data-bs-toggle="tooltip" data-bs-placement="top"
        data-bs-custom-class="custom-tooltip"
        data-bs-title="This top tooltip is themed via CSS variables.">
  Custom tooltip
</button>

Directiones

Volitant infra tesserae quattuor instrumentorum directiones: 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" data-bs-title="Tooltip on top">
  Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="right" data-bs-title="Tooltip on right">
  Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-title="Tooltip on bottom">
  Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="left" data-bs-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" data-bs-title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
  Tooltip with HTML
</button>

Cum SVG:

CSS

Variabilium

Additur in v5.2.0

Cum pars Bootstrap evolutae CSS variabiles accedunt, instrumenta nunc localia CSS variabilium utuntur .tooltipin amplificatione real-time customizationis. Valores variabilium pro CSS per Sass positae sunt, ergo etiam adhuc Sass customization adiuvatur.

  --#{$prefix}tooltip-zindex: #{$zindex-tooltip};
  --#{$prefix}tooltip-max-width: #{$tooltip-max-width};
  --#{$prefix}tooltip-padding-x: #{$tooltip-padding-x};
  --#{$prefix}tooltip-padding-y: #{$tooltip-padding-y};
  --#{$prefix}tooltip-margin: #{$tooltip-margin};
  @include rfs($tooltip-font-size, --#{$prefix}tooltip-font-size);
  --#{$prefix}tooltip-color: #{$tooltip-color};
  --#{$prefix}tooltip-bg: #{$tooltip-bg};
  --#{$prefix}tooltip-border-radius: #{$tooltip-border-radius};
  --#{$prefix}tooltip-opacity: #{$tooltip-opacity};
  --#{$prefix}tooltip-arrow-width: #{$tooltip-arrow-width};
  --#{$prefix}tooltip-arrow-height: #{$tooltip-arrow-height};
  

Sass variables

$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:                    null; // TODO: remove this in v6

$tooltip-arrow-width:               .8rem;
$tooltip-arrow-height:              .4rem;
// fusv-disable
$tooltip-arrow-color:               null; // Deprecated in Bootstrap 5.2.0 for CSS variables
// fusv-enable

Consuetudinem

Instrumentum plugin contentum et signum in demanda generat, et per default loca instrumenta post elementum felis suum.

Tooltip Trigger per JavaScript:

const exampleEl = document.getElementById('example')
const tooltip = new bootstrap.Tooltip(exampleEl, options)
Redundant autoetscroll

Tooltip positio automatice mutare conatur cum parens continens noster habet overflow: autovel overflow: scrollsimilis .table-responsive, sed tamen pristinam positionis collocationem servat. Ad hoc solvendum, boundaryoptionem pone (pro flip determinatio optionis utentis popperConfig) cuivis HTMLElement ut valorem default vincat, 'clippingParents', ut document.body:

const tooltip = new bootstrap.Tooltip('#example', {
  boundary: document.body // or document.querySelector('#boundary')
})

Markup

Signum requisitum pro instrumenti instrumenti dataattributum est tantum et titlein elementum HTML quod tooltip habere vis. Nota notae generatae instrumenti instrumenti magis simplex est, quamquam positione requirit (per default ad topplugin 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>s) umbilici effici possunt addito tabindex="0"attributo, hoc potentia molestus et turbans tab sistit in elementis non-interacivis pro claviaturis usoribus, et technologiae adiuvativae in hoc situ instrumentorum nunc maxime non annuntiant. Accedite, nolite inniti solum hoversicut felis pro instrumento tuo, sicut hoc faciet instrumenta tua impossibilia ad trigger pro claviaturis usoribus.

<!-- HTML to write -->
<a href="#" data-bs-toggle="tooltip" data-bs-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 disabledattributo 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".

html
<span class="d-inline-block" tabindex="0" data-bs-toggle="tooltip" data-bs-title="Disabled tooltip">
  <button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

Optiones

Cum optiones transeantur per data attributa vel JavaScript, potes appendere nomen optionis data-bs-, ut in data-bs-animation="{value}". Fac mutare casus genus optionis nominis ab " camelCase " ad " kebab-casum " cum transeundo optiones per data attributa. Exempli gratia data-bs-custom-class="beautifier"loco data-bs-customClass="beautifier".

Sicut de Bootstrap 5.2.0, omnia membra experimentalem datam reservatam sustinent data-bs-configquae figuram simplicem componentem sicut chorda JSON domum habere potest. Cum elementum habet data-bs-config='{"delay":0, "title":123}'et data-bs-title="456"attributa, valor finalis titleerit 456et attributa separata data valores supra datos vincent data-bs-config. Praeterea exsistentes notitiae attributae possunt domum JSON valores similes data-bs-delay='{"show":0,"hide":150}'.

Nota quod propter rationes securitatis sanitize, sanitizeFn, et allowListoptiones non possunt suppeditari usura attributa data.
Nomen Type Default Descriptio
allowList object Default valorem Obiectum quod continet concessa attributa et tags.
animation Boolean true Applicare CSS fade transitum ad tooltip.
boundary filum, elementum 'clippingParents' Superfluum coactionis limitis instrumenti instrumenti (solum applicat ad determinationem Popper scriptor preventsOverflow). Per defaltam, suus 'clippingParents'et HTMLElement reference (per JavaScript only). For more information refer to Popper's detectOverflow docs .
container chorda, elementum, fals false Adhibet tooltip ad elementum specificum. Exemplum: container: 'body'. Haec optio apprime utilis est in eo quod permittit te positionem instrumenti in fluxu tabellae prope elementum excitato - quod obstabit instrumentum, ne fluitantia ab elemento excitato in fenestra resize.
customClass filum, munus '' Classes ad tooltip addere monstratur. Nota has classes additas esse omnibus generibus in template specificatis. Ad multiplices classes, spatiis eas separa: 'class-1 class-2'. Munus praeterea praeterire potes quod chorda unica referat quae adiectis nominibus classis continentur.
delay numerus, object 0 Mora monstrans et occultans instrumentum (ms) — non pertinet ad genus felis manuale. Si numerus suppleatur, mora utrique operi/showi applicatur. Objectum structura est: delay: { "show": 500, "hide": 100 }.
fallbackPlacements ordinata ['top', 'right', 'bottom', 'left'] Define placements fallback providens indices placementorum in ordine (in ordine praepositorum). For more information refer to Popper's conversations docs .
html Boolean false HTML patitur in tooltip. Quod si verum est, HTML tags in instrumenti instrumenti ratione in tools titlereddetur. Si falsus, innerTextcontenta in possessionem adhibebitur dom. Utere textu si de oppugnationibus XSS sollicitus es.
offset ordinata, chorda, munus [0, 0] Offset tooltip relativum ad scopum suum. Filum transire potes in data attributis cum commate valores separatos similes: data-bs-offset="10,20". 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 ordinatim reddere debet cum duobus numeris: iaculatione , distantia . For more information refer to Popper's offset docs .
placement filum, munus 'top' Quomodo positionem tooltip: auto, summum, fundum, sinistram, dextram. Cum autospecificatur, tooltip alacriter reorient. Cum munus collocationis determinare adhibetur, cum instrumento instrumenti nodi dom nodi appellatur ut argumentum primum et elementum dom nodi excitato ut eius secundae. Contextus thispositus est ad instantiam instrumenti instrumenti.
popperConfig nullum, objectum, munus 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.
sanitize Boolean true Admitte vel disable sanitization. Si actum 'template', 'content'et 'title'bene sanitized.
sanitizeFn nullum, munus null Hic tu munus tuum inconsideratus supplere potes. Hoc utile esse potest si bibliotheca dedicata uti mavis sanitizationem praestare.
selector filum, falsus false Si electrix cautum est, instrumenta instrumentorum ad certa scuta delegabuntur. Re, hoc etiam instrumenta instrumenta ad dom elementa dynamice addita applicare ( jQuery.onauxilium). Vide hanc quaestionem et exemplum informativum . Nota : titleattributum non debet uti electrix.
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 titleinstrumentum in injicietur .tooltip-inner. .tooltip-arrowfiet sagitta tooltip est. Extremum elementum fasciculus debet habere .tooltipgenus et role="tooltip".
title filum, elementum, munus '' Default title valorem si titleattributum non est praesens. Si munus detur, vocabitur cum sua thisreferentia ad elementum quod adnexum est popover.
trigger filum 'hover focus' Quomodo tooltip utitur: preme, hove, focus, manuale. Plures triggers transire potes; eosque spatio. 'manual'indicat instrumentum ad grammatice per modum .tooltip('show')ac .tooltip('hide')modos .tooltip('toggle')impelli; Hoc valore cum aliqua alia felis componi non potest. 'hover'sponte autem proveniet in instrumentis quae per tincidunt adhiberi non possunt, et tantum adhibeantur si alterutrum modi ad easdem informationes perferendas adsunt claviaturarum usorum.

Data singulis tooltips tribuit

Optiones singulorum instrumentorum per usum attributorum datorum, ut supra dictum est, specificari possunt.

Munus cum usurapopperConfig

const tooltip = new bootstrap.Tooltip(element, {
  popperConfig(defaultBsPopperConfig) {
    // const 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 .

See our JavaScript documentation for more information .

Methodus Descriptio
disable Facultatem removet instrumentum ad ostensionem elementi. Instrumentum instrumentum tantum demonstrari poterit si re-paratur.
dispose Coria et instrumentum elementi destruit (reposita removet data in elementum dom). Instrumenta delegationis quae utuntur (quae optione utente creantur ) selectorsingulariter destrui non possunt in elementis felis descendentibus.
enable Instrumentum instrumentum elementi facultatem demonstrandi dat. Instrumenta per defaltam possunt.
getInstance Statica methodus, quae te permittit ut exemplum instrumenti cum elemento DOM adiunctum accipias, vel novum efficias si non initialized erat.
getOrCreateInstance Statica methodus, quae te permittit ut exemplum instrumenti cum elemento DOM adiunctum accipias, vel novum efficias si non initialized erat.
hide Instrumentum elementum celat. Redit ad RECENS antequam tooltip re vera absconditum (id est antequam hidden.bs.tooltipevenit). Hoc habetur "manual" excitato instrumenti instrumenti.
setContent Modum dat mutandi contentus instrumentum instrumenti post eius initializationem.
show Elementum demonstrat tooltip. RECENS prius redit ad instrumentum demonstratum (id est antequam shown.bs.tooltipevenit). Hoc habetur "manual" excitato instrumenti instrumenti. Instrumenta cum titulis zerum-longitudo numquam ostentantur.
toggle Toggles tooltip elementum est. RECENS redit ad instrumentum ante demonstratum vel absconditum (id est ante shown.bs.tooltipvel hidden.bs.tooltipeventum). Hoc habetur "manual" excitato instrumenti instrumenti.
toggleEnabled Toggles facultatem instrumenti elementi exhibendi vel absconditi.
update Renovat locum tooltip elementi.
const tooltip = bootstrap.Tooltip.getInstance('#example') // Returns a Bootstrap tooltip instance

// setContent example
tooltip.setContent({ '.tooltip-inner': 'another title' })
Modus argumentationem setContentaccipit object, ubi quaelibet proprietas-clavis stringintra popover templates validum est electrix, et quaelibet proprietas relativa esse potest string| element| function| null

Events

Eventus Descriptio
hide.bs.tooltip Hic eventus statim accensus est, cum hidemethodus instantia vocata est.
hidden.bs.tooltip Eventus hic accensus est cum popover ab usore celatum absolvit (exspectabit CSS transitus ad perficiendum).
inserted.bs.tooltip Hic eventus post eventum accensus est show.bs.tooltipcum instrumentum tabulae instrumentorum ad dom additum est.
show.bs.tooltip Huius rei accendit statim cum showinstantia methodus appellatur.
shown.bs.tooltip Eventus hic accensus est cum popover utenti utenti factus est (exspectabit CSS transitus ad perficiendum).
const myTooltipEl = document.getElementById('myTooltip')
const tooltip = bootstrap.Tooltip.getOrCreateInstance(myTooltipEl)

myTooltipEl.addEventListener('hidden.bs.tooltip', () => {
  // do something...
})

tooltip.hide()