Aqbeż għall-kontenut prinċipali Aqbeż għan-navigazzjoni tad-dokumenti
in English

Tooltips

Dokumentazzjoni u eżempji għaż-żieda ta 'tooltips Bootstrap personalizzati b'CSS u JavaScript bl-użu ta' CSS3 għal animazzjonijiet u data-bs-attributes għall-ħażna tat-titlu lokali.

Ħarsa ġenerali

Affarijiet li għandek tkun taf meta tuża l-plugin tooltip:

  • Tooltips jiddependu fuq il-librerija tal-parti 3 Popper għall-ippożizzjonar. Trid tinkludi popper.min.js qabel bootstrap.js jew tuża bootstrap.bundle.min.js/ bootstrap.bundle.jsli fih Popper sabiex it-tooltips jaħdmu!
  • Tooltips huma opt-in għal raġunijiet ta' prestazzjoni, għalhekk trid tinizjalizzahom lilek innifsek .
  • Tooltips b'titli ta' tul żero qatt ma jintwerew.
  • Speċifika container: 'body'biex tevita problemi ta' rendering f'komponenti aktar kumplessi (bħal gruppi ta' input tagħna, gruppi ta' buttuni, eċċ).
  • It-tqajjem tooltips fuq elementi moħbija mhux se jaħdem.
  • Tooltips għal .disabledjew disabledelementi għandhom jiġu attivati ​​fuq element tat-tgeżwir.
  • Meta jiġu attivati ​​minn hyperlinks li jkopru linji multipli, it-tooltips se jkunu ċċentrati. Uża white-space: nowrap;fuq tiegħek <a>biex tevita din l-imġieba.
  • Tooltips għandhom ikunu moħbija qabel ma l-elementi korrispondenti tagħhom ikunu tneħħew mid-DOM.
  • Tooltips jistgħu jiġu attivati ​​grazzi għal element ġewwa dell DOM.
B'mod awtomatiku, dan il-komponent juża sanitizer tal-kontenut inkorporat, li jneħħi kwalunkwe elementi HTML li mhumiex permessi b'mod espliċitu. Ara t- taqsima tas-sanitizer fid-dokumentazzjoni JavaScript tagħna għal aktar dettalji.
L-effett ta 'animazzjoni ta' dan il-komponent jiddependi fuq il prefers-reduced-motion-mistoqsija tal-midja. Ara t- taqsima tal-mozzjoni mnaqqsa tad-dokumentazzjoni tagħna dwar l-aċċessibbiltà .

Ghandek dak kollu? Kbir, ejja naraw kif jaħdmu ma 'xi eżempji.

Eżempju: Ippermetti tooltips kullimkien

Mod wieħed biex jiġu inizjalizzati l-għodda kollha fuq paġna jkun li tagħżelhom skont l- data-bs-toggleattribut tagħhom:

var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
  return new bootstrap.Tooltip(tooltipTriggerEl)
})

Eżempji

Passa fuq il-links hawn taħt biex tara l-għodda:

Test ta' placeholder biex juri xi links inline ma' tooltips. Dan issa huwa biss mili, l-ebda qattiel. Kontenut imqiegħed hawn biss biex jimita l-preżenza ta 'test reali . U dan kollu biex jagħtik idea ta' kif jidhru l-għodda tal-għodda meta jintużaw f'sitwazzjonijiet tad-dinja reali. Allura nisperaw li issa rajt kif dawn it-tooltips fuq links jistgħu jaħdmu fil-prattika, ladarba tużahom fuq is- sit jew il-proġett tiegħek stess .

Passa fuq il-buttuni ta' hawn taħt biex tara l-erba' direzzjonijiet tal-għodda: ta' fuq, tal-lemin, ta' isfel u tax-xellug. Id-direzzjonijiet huma riflessi meta tuża Bootstrap f'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>

U b'HTML personalizzat miżjud:

<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>

B'SVG:

Sass

Varjabbli

$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;

Użu

Il-plugin tooltip jiġġenera kontenut u markup fuq talba, u awtomatikament iqiegħed tooltips wara l-element grillu tagħhom.

Agħmel it-tooltip permezz ta' JavaScript:

var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, options)
Overflow autouscroll

Il-pożizzjoni tat-tooltip tipprova tinbidel awtomatikament meta kontenitur ġenitur ikollu overflow: autojew overflow: scrollbħal tagħna .table-responsive, iżda xorta jżomm il-pożizzjonament tat-tqegħid oriġinali. Biex issolvi dan, issettja l- boundarygħażla (għall-modifikatur flip bl-użu tal- popperConfiggħażla) għal kwalunkwe HTMLElement biex jegħleb il-valur default, 'clippingParents', bħal document.body:

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

Markup

Il-markup meħtieġ għal tooltip huwa biss dataattribut u titlefuq l-element HTML tixtieq li jkollok tooltip. Il-markup iġġenerat ta' tooltip huwa pjuttost sempliċi, għalkemm jeħtieġ pożizzjoni (b'mod awtomatiku, issettjat topmill-plugin).

Li tagħmel it-tooltips jaħdmu għall-utenti tat-tastiera u tat-teknoloġija assistiva

Għandek iżżid biss tooltips ma' elementi HTML li tradizzjonalment huma ffukati fuq it-tastiera u interattivi (bħal links jew kontrolli tal-formoli). Għalkemm elementi HTML arbitrarji (bħal <span>s) jistgħu jsiru ffukabbli billi żżid l- tabindex="0"attribut, dan iżid tab stops potenzjalment tedjanti u konfużi fuq elementi mhux interattivi għall-utenti tat-tastiera, u l-biċċa l-kbira tat-teknoloġiji ta 'assistenza bħalissa ma jħabbrux it-tooltip f'din is-sitwazzjoni. Barra minn hekk, tistrieħx biss fuq hoverbħala l-grillu għall-tooltip tiegħek, peress li dan jagħmel it-tooltips tiegħek impossibbli li jiġu attivati ​​għall-utenti tat-tastiera.

<!-- 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>

Elementi b'diżabilità

L-elementi bl- disabledattribut mhumiex interattivi, jiġifieri l-utenti ma jistgħux jiffokaw, jgħadduhom jew ikklikkjahom biex jagħtu bidu għal tooltip (jew popover). Bħala soluzzjoni alternattiva, tkun trid tiskatta l-għodda minn tgeżwir <div>jew <span>, idealment magħmula li tiffoka fuq it-tastiera billi tuża 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>

Għażliet

L-għażliet jistgħu jiġu mgħoddija permezz ta' attributi tad-dejta jew JavaScript. Għal attributi tad-dejta, ehmeż l-isem tal-għażla ma' data-bs-, bħal f' data-bs-animation="". Kun żgur li tibdel it-tip tal-każ tal-isem tal-għażla minn camelCase għal kebab-case meta tgħaddi l-għażliet permezz tal-attributi tad-dejta. Per eżempju, minflok tuża data-bs-customClass="beautifier", uża data-bs-custom-class="beautifier".

Innota li għal raġunijiet ta' sigurtà l- għażliet sanitize, sanitizeFn, u allowListma jistgħux jiġu forniti bl-użu ta' attributi tad-dejta.
Isem Tip Default Deskrizzjoni
animation boolean true Applika transizzjoni ta' fade CSS għall-tooltip
container spag | element | falza false

Jwaħħal it-tooltip ma' element speċifiku. Eżempju: container: 'body'. Din l-għażla hija partikolarment utli peress li tippermettilek li tpoġġi l-tooltip fil-fluss tad-dokument ħdejn l-element triggering - li jipprevjeni l-tooltip milli jżomm f'wiċċ l-ilma 'l bogħod mill-element triggering waqt tibdil tad-daqs tat-tieqa.

delay numru | oġġett 0

Dewmien biex juri u jaħbi l-tooltip (ms) - ma japplikax għat-tip ta' grillu manwali

Jekk jiġi fornut numru, id-dewmien jiġi applikat kemm biex jaħbu/juri

L-istruttura tal-oġġett hija:delay: { "show": 500, "hide": 100 }

html boolean false

Ħalli HTML fit-tooltip.

Jekk veru, it-tikketti HTML fil-tooltip's titlese jiġu mogħtija fil-tooltip. Jekk falza, innerTextil-proprjetà tintuża biex tiddaħħal kontenut fid-DOM.

Uża test jekk int inkwetat dwar attakki XSS.

placement spag | funzjoni 'top'

Kif tpoġġi l-tooltip - auto | fuq | qiegħ | xellug | dritt.
Meta autotkun speċifikata, se jorjenta mill-ġdid b'mod dinamiku l-tooltip.

Meta tintuża funzjoni biex tiddetermina t-tqegħid, tissejjaħ bin-node DOM tal-għodda bħala l-ewwel argument tagħha u n-nodu DOM tal-element triggering bħala t-tieni. Il- thiskuntest huwa ssettjat għall-istanza tooltip.

selector spag | falza false Jekk jiġi pprovdut selettur, l-oġġetti tat-tooltip jiġu delegati lill-miri speċifikati. Fil-prattika, dan jintuża biex japplika wkoll tooltips għal elementi DOM miżjuda b'mod dinamiku ( jQuery.onappoġġ). Ara dan u eżempju informattiv .
template spag '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'

Bażi HTML biex tuża meta toħloq it-tooltip.

It-tooltip's titlese jiġu injettati fil- .tooltip-inner.

.tooltip-arrowse ssir il-vleġġa tal-għodda.

L-element tat-tgeżwir l-aktar 'il barra għandu jkollu l- .tooltipklassi u role="tooltip".

title spag | element | funzjoni ''

Valur tat-titlu default jekk titlel-attribut ma jkunx preżenti.

Jekk tingħata funzjoni, tissejjaħ bir- thisreferenza tagħha ssettjata għall-element li l-għodda hija mwaħħla miegħu.

trigger spag 'hover focus'

Kif tiġi attivata tooltip - ikklikkja | iddur | tiffoka | manwal. Inti tista 'tgħaddi triggers multipli; jifredhom bi spazju.

'manual'jindika li l-tooltip se jiġi attivat b'mod programmatiku permezz tal- .show(), .hide()u .toggle()metodi; dan il-valur ma jistax jiġi kkombinat ma' kwalunkwe trigger ieħor.

'hover'waħdu se jirriżulta f'tooltips li ma jistgħux jiġu attivati ​​permezz tat-tastiera, u għandhom jintużaw biss jekk ikunu preżenti metodi alternattivi biex titwassal l-istess informazzjoni għall-utenti tat-tastiera.

fallbackPlacements firxa ['top', 'right', 'bottom', 'left'] Iddefinixxi pjazzamenti ta' riżerva billi tipprovdi lista ta' pjazzamenti f'firxa (f'ordni ta' preferenza). Għal aktar informazzjoni irreferi għad-dokumenti tal- imġieba ta’ Popper
boundary spag | element 'clippingParents' Limitu tar-restrizzjoni ta' overflow tal-għodda (japplika biss għall-modifikatur preventOverflow ta' Popper). B'mod awtomatiku huwa 'clippingParents'u jista 'jaċċetta referenza HTMLElement (permezz ta' JavaScript biss). Għal aktar informazzjoni irreferi għad- dokumenti detectOverflow ta’ Popper .
customClass spag | funzjoni ''

Żid klassijiet mal-tooltip meta jintwera. Innota li dawn il-klassijiet se jiġu miżjuda flimkien ma' kwalunkwe klassi speċifikata fil-mudell. Biex iżżid klassijiet multipli, isseparahom bi spazji: 'class-1 class-2'.

Tista 'wkoll tgħaddi funzjoni li għandha tirritorna string waħda li fiha ismijiet ta' klassi addizzjonali.

sanitize boolean true Ippermetti jew tiddiżattiva s-sanitizzazzjoni. Jekk jiġi attivat 'template'u l- 'title'għażliet se jiġu sanitizzati. Ara s- sezzjoni ta' sanitizer fid-dokumentazzjoni JavaScript tagħna .
allowList oġġett Valur default Oġġett li fih attributi u tags permessi
sanitizeFn null | funzjoni null Hawnhekk tista 'tforni l-funzjoni ta' sanitizza tiegħek stess. Dan jista 'jkun utli jekk tippreferi tuża librerija ddedikata biex twettaq sanitizzazzjoni.
offset firxa | spag | funzjoni [0, 0]

Offset tal-tooltip relattiv għall-mira tiegħu. Tista' tgħaddi string fl-attributi tad-dejta b'valuri separati bil-virgola bħal:data-bs-offset="10,20"

Meta tintuża funzjoni biex tiddetermina l-offset, tissejjaħ b'oġġett li jkun fih it-tqegħid tal-popper, ir-referenza u l-popper rects bħala l-ewwel argument tagħha. L-element triggering node DOM huwa mgħoddi bħala t-tieni argument. Il-funzjoni trid tirritorna firxa b'żewġ numri: .[skidding, distance]

Għal aktar informazzjoni irreferi għad-dokumenti tal- offset ta’ Popper .

popperConfig null | oġġett | funzjoni null

Biex tibdel il-konfigurazzjoni default Popper ta' Bootstrap, ara l-konfigurazzjoni ta' Popper .

Meta tintuża funzjoni biex tinħoloq il-konfigurazzjoni Popper, tissejjaħ b'oġġett li fih il-konfigurazzjoni Popper default tal-Bootstrap. Jgħinek tuża u tgħaqqad id-default mal-konfigurazzjoni tiegħek stess. Il-funzjoni trid tirritorna oġġett ta 'konfigurazzjoni għal Popper.

Attributi tad-dejta għal tooltips individwali

Għażliet għal tooltips individwali jistgħu alternattivament jiġu speċifikati permezz tal-użu tal-attributi tad-dejta, kif spjegat hawn fuq.

Bl-użu tal-funzjoni mapopperConfig

var tooltip = new bootstrap.Tooltip(element, {
  popperConfig: function (defaultBsPopperConfig) {
    // var newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})

Metodi

Metodi asinkroniċi u tranżizzjonijiet

Il-metodi kollha tal-API huma asinkroniċi u jibdew transizzjoni . Jirritornaw għand min iċempel hekk kif tinbeda t-tranżizzjoni iżda qabel ma tispiċċa . Barra minn hekk, sejħa ta' metodu fuq komponent ta' tranżizzjoni se tiġi injorata .

Ara d-dokumentazzjoni JavaScript tagħna għal aktar informazzjoni .

juru

Tiżvela tooltip ta' element. Jirritorna lil min iċempel qabel ma jkun intwera l-għodda (jiġifieri qabel ma shown.bs.tooltipjseħħ l-avveniment). Dan huwa meqjus bħala attivazzjoni "manwali" tal-tooltip. Tooltips b'titli ta' tul żero qatt ma jintwerew.

tooltip.show()

ħabi

Jaħbi tooltip ta' element. Jirritorna lil min iċempel qabel ma l-għodda tkun ġiet moħbija (jiġifieri qabel ma hidden.bs.tooltipjseħħ l-avveniment). Dan huwa meqjus bħala attivazzjoni "manwali" tal-tooltip.

tooltip.hide()

toggle

Jiddawwar il-tooltip ta' element. Jirritorna lil min iċempel qabel ma l-għodda tkun intweriet jew moħbija (jiġifieri qabel ma jseħħ l-avveniment shown.bs.tooltipjew ). hidden.bs.tooltipDan huwa meqjus bħala attivazzjoni "manwali" tal-tooltip.

tooltip.toggle()

jiddisponi

Jaħbi u jeqred it-tooltip ta' element (Tneħħi d-dejta maħżuna fuq l-element DOM). Tooltips li jużaw id-delega (li huma maħluqa bl -użu tal - selectorgħażla ) ma jistgħux jinqerdu individwalment fuq elementi ta 'grillu dixxendenti.

tooltip.dispose()

jippermettu

Jagħti l-abbiltà li jintwera tooltip ta' element. Tooltips huma attivati ​​awtomatikament.

tooltip.enable()

jiskonnettja

Tneħħi l-abbiltà li l-tooltip ta' element jintwera. It-tooltip tkun tista' tintwera biss jekk terġa' tiġi attivata.

tooltip.disable()

toggleEnabled

Jiddawwar l-abbiltà li l-tooltip ta' element jintwera jew moħbi.

tooltip.toggleEnabled()

aġġornament

Taġġorna l-pożizzjoni tat-tooltip ta' element.

tooltip.update()

getInstance

Metodu statiku li jippermettilek li tikseb l-istanza tooltip assoċjata ma 'element DOM

var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance

getOrCreateInstance

Metodu statiku li jippermettilek tikseb l-istanza tat-tooltip assoċjata ma' element DOM, jew toħloq waħda ġdida f'każ li ma kienx inizjalizzat

var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance

Avvenimenti

Tip ta' avveniment Deskrizzjoni
show.bs.tooltip Dan l-avveniment jispara immedjatament meta showjissejjaħ il-metodu tal-istanza.
shown.bs.tooltip Dan l-avveniment jiġi sparat meta l-tooltip tkun saret viżibbli għall-utent (se jistenna li t-tranżizzjonijiet CSS jitlestew).
hide.bs.tooltip Dan l-avveniment jiġi sparat immedjatament meta l- hidemetodu tal-istanza jkun ġie msejjaħ.
hidden.bs.tooltip Dan l-avveniment jiġi sparat meta l-tooltip spiċċa moħbi mill-utent (se jistenna li jitlestew it-tranżizzjonijiet CSS).
inserted.bs.tooltip Dan l-avveniment jiġi sparat wara l- show.bs.tooltipavveniment meta l-mudell tat-tooltip ikun ġie miżjud mad-DOM.
var myTooltipEl = document.getElementById('myTooltip')
var tooltip = new bootstrap.Tooltip(myTooltipEl)

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

tooltip.hide()