Rīku padomi
Dokumentācija un piemēri pielāgotu Bootstrap rīkpadomu pievienošanai ar CSS un JavaScript, izmantojot CSS3 animācijām un data-bs-atribūtus vietējai virsrakstu glabāšanai.
Pārskats
Lietas, kas jāzina, izmantojot rīka padomu spraudni:
- Rīka padomi pozicionēšanai balstās uz trešās puses bibliotēku Popper . Lai rīka padomi darbotos, pirms bootstrap.js jāiekļauj popper.min.js vai jāizmanto
bootstrap.bundle.min.js
/bootstrap.bundle.js
kas satur Popper! - Rīka padomi tiek izvēlēti veiktspējas iemeslu dēļ, tāpēc jums tie ir jāinicializē pašam .
- Rīka padomi ar nulles garuma virsrakstiem nekad netiek rādīti.
- Norādiet
container: 'body'
, lai izvairītos no renderēšanas problēmām sarežģītākos komponentos (piemēram, mūsu ievades grupās, pogu grupās utt.). - Rīka padomu aktivizēšana slēptajos elementos nedarbosies.
- Rīka padomi
.disabled
vaidisabled
elementi ir jāaktivizē iesaiņojuma elementā. - Ja to aktivizē hipersaites, kas aptver vairākas rindiņas, rīka padomi tiks centrēti. Izmantojiet
white-space: nowrap;
,<a>
lai izvairītos no šādas uzvedības. - Rīka padomi ir jāpaslēpj, pirms tiem atbilstošie elementi tiek noņemti no DOM.
- Rīka padomus var aktivizēt, pateicoties elementam ēnu DOM iekšpusē.
prefers-reduced-motion
multivides vaicājuma. Skatiet
mūsu pieejamības dokumentācijas sadaļu samazinātas kustības .
Vai to visu sapratāt? Lieliski, redzēsim, kā viņi strādā ar dažiem piemēriem.
Piemērs: iespējojiet rīka padomus visur
Viens veids, kā inicializēt visus rīka padomus lapā, būtu atlasīt tos pēc to data-bs-toggle
atribūta:
var tooltipTriggerList = [].slice.call(document.querySelectorAll('[data-bs-toggle="tooltip"]'))
var tooltipList = tooltipTriggerList.map(function (tooltipTriggerEl) {
return new bootstrap.Tooltip(tooltipTriggerEl)
})
Piemēri
Virziet kursoru virs tālāk esošajām saitēm, lai skatītu rīka padomus:
Viettura teksts, lai parādītu dažas iekļautās saites ar rīka padomiem. Tagad tas ir tikai pildījums, nevis slepkava. Šeit ievietots saturs, lai atdarinātu reāla teksta klātbūtni . Un tas viss, lai sniegtu jums priekšstatu par to, kā rīka padomi izskatītos, ja tos izmantotu reālās situācijās. Cerams, ka tagad esat redzējis , kā šie saišu rīka padomi var darboties praksē, kad tos izmantosit savā vietnē vai projektā.
Novietojiet kursoru virs tālāk esošajām pogām, lai skatītu četrus rīka padomu norādes: augšā, pa labi, apakšā un pa kreisi. Norādes tiek atspoguļotas, izmantojot Bootstrap 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>
Un ar pievienotu pielāgotu HTML:
<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>
Ar SVG:
Sass
Mainīgie lielumi
$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;
Lietošana
Rīkpadomu spraudnis ģenerē saturu un marķējumu pēc pieprasījuma un pēc noklusējuma ievieto rīka padomus aiz to aktivizētāja elementa.
Aktivizējiet rīka padomu, izmantojot JavaScript:
var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, options)
Pārplūde auto
unscroll
Rīka padoma pozīcija mēģina automātiski mainīties, ja vecākkonteinerā ir overflow: auto
vai overflow: scroll
patīk mūsu .table-responsive
, taču joprojām tiek saglabāta sākotnējā izvietojuma pozīcija. Lai to atrisinātu, iestatiet boundary
opciju (apvēršanas modifikatoram, izmantojot popperConfig
opciju) uz jebkuru HTMLElement, lai ignorētu noklusējuma vērtību 'clippingParents'
, piemēram document.body
:
var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, {
boundary: document.body // or document.querySelector('#boundary')
})
Atzīmes
Rīka padomam nepieciešamais marķējums ir tikai data
atribūts title
, un HTML elementā, kuram vēlaties izveidot rīka padomu. Rīka padoma ģenerētais marķējums ir diezgan vienkāršs, lai gan tam ir nepieciešama pozīcija (pēc noklusējuma to iestatījis top
spraudnis).
Rīka padomu izmantošana tastatūras un palīgtehnoloģiju lietotājiem
Rīka padomi jāpievieno tikai tiem HTML elementiem, kas tradicionāli ir orientēti uz tastatūru un ir interaktīvi (piemēram, saites vai veidlapas vadīklas). Lai gan patvaļīgus HTML elementus (piemēram, <span>
s) var padarīt fokusējamus, pievienojot tabindex="0"
atribūtu, tastatūras lietotājiem tiks pievienotas potenciāli kaitinošas un mulsinošas tabulēšanas pieturas neinteraktīvos elementos, un lielākā daļa palīgtehnoloģiju pašlaik nepaziņo rīka padomu šajā situācijā. Turklāt nepaļaujieties tikai uz hover
jūsu rīka padoma aktivizētāju, jo tas padarīs jūsu rīka padomus neiespējamu tastatūras lietotājiem.
<!-- 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>
Atspējotie elementi
Elementi ar disabled
atribūtu nav interaktīvi, tas nozīmē, ka lietotāji nevar fokusēt, virzīt kursoru vai noklikšķināt uz tiem, lai aktivizētu rīka padomu (vai uznirstošo logu). Kā risinājums ir jāiedarbina rīka padoms no iesaiņojuma <div>
vai <span>
ideālā gadījumā tastatūras fokusēšanas, izmantojot 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>
Iespējas
Opcijas var nodot, izmantojot datu atribūtus vai JavaScript. Datu atribūtiem pievienojiet opcijas nosaukumu data-bs-
, tāpat kā data-bs-animation=""
. Nododot opcijas, izmantojot datu atribūtus, noteikti nomainiet opcijas nosaukuma reģistra veidu no camelCase uz kebab-case. Piemēram, tā vietā, lai izmantotu data-bs-customClass="beautifier"
, izmantojiet data-bs-custom-class="beautifier"
.
sanitize
opcijas
sanitizeFn
, un
allowList
opcijas nevar nodrošināt, izmantojot datu atribūtus.
Vārds | Tips | Noklusējums | Apraksts |
---|---|---|---|
animation |
Būla | true |
Rīka padomam izmantojiet CSS izbalēšanas pāreju |
container |
stīga | elements | viltus | false |
Pievieno rīka padomu noteiktam elementam. Piemērs: |
delay |
numurs | objektu | 0 |
Rīka padoma rādīšanas un slēpšanas aizkave (ms) — neattiecas uz manuālo palaišanas veidu Ja tiek norādīts numurs, aizkave tiek piemērota gan slēpšanai/rādīšanai Objekta struktūra ir šāda: |
html |
Būla | false |
Atļaut HTML rīka padomos. Ja vērtība ir patiesa, rīka padomos HTML tagi Izmantojiet tekstu, ja uztraucaties par XSS uzbrukumiem. |
placement |
stīga | funkciju | 'top' |
Kā novietot rīka padomu - auto | uz augšu | apakšā | pa kreisi | pa labi. Ja funkcija tiek izmantota, lai noteiktu izvietojumu, tā tiek izsaukta ar rīka padoma DOM mezglu kā pirmo argumentu un trigerēšanas elementu DOM mezglu kā otro. Konteksts |
selector |
stīga | viltus | false |
Ja ir nodrošināts atlasītājs, rīka padomu objekti tiks deleģēti norādītajiem mērķiem. Praksē to izmanto arī, lai lietotu rīka padomus dinamiski pievienotajiem DOM elementiem ( jQuery.on atbalsts). Skatiet šo un informatīvo piemēru . |
template |
stīga | '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>' |
Pamata HTML, kas jāizmanto, veidojot rīka padomu. Rīka padoms
Vistālākajam iesaiņojuma elementam jābūt |
title |
stīga | elements | funkciju | '' |
Noklusējuma nosaukuma vērtība, ja Ja funkcija ir norādīta, tā tiks izsaukta ar |
trigger |
stīga | 'hover focus' |
Kā tiek aktivizēts rīka padoms — noklikšķiniet uz | lidināties | fokuss | rokasgrāmata. Jūs varat nodot vairākus trigerus; atdaliet tos ar atstarpi.
|
fallbackPlacements |
masīvs | ['top', 'right', 'bottom', 'left'] |
Definējiet rezerves izvietojumus, nodrošinot izvietojumu sarakstu masīvā (priekšrocību secībā). Papildinformāciju skatiet Popera uzvedības dokumentos |
boundary |
stīga | elements | 'clippingParents' |
Rīka padoma pārpildes ierobežojuma robeža (attiecas tikai uz Popera preventīvā pārpildes modifikatoru). Pēc noklusējuma tas ir 'clippingParents' un var pieņemt HTMLElement atsauci (tikai izmantojot JavaScript). Lai iegūtu papildinformāciju, skatiet Popper's detectOverflow dokumentus . |
customClass |
stīga | funkciju | '' |
Pievienojiet klases rīka padomam, kad tas tiek parādīts. Ņemiet vērā, ka šīs klases tiks pievienotas papildus visām veidnē norādītajām klasēm. Lai pievienotu vairākas klases, atdaliet tās ar atstarpēm: Varat arī nodot funkciju, kurai jāatgriež viena virkne, kas satur papildu klašu nosaukumus. |
sanitize |
Būla | true |
Iespējojiet vai atspējojiet dezinfekciju. Ja tas ir aktivizēts 'template' , 'title' opcijas tiks dezinficētas. Skatiet mūsu JavaScript dokumentācijas sadaļu par dezinfekcijas līdzekļiem . |
allowList |
objektu | Noklusējuma vērtība | Objekts, kurā ir atļauti atribūti un tagi |
sanitizeFn |
null | funkciju | null |
Šeit jūs varat nodrošināt savu dezinfekcijas funkciju. Tas var būt noderīgi, ja vēlaties dezinficēšanai izmantot īpašu bibliotēku. |
offset |
masīvs | stīga | funkciju | [0, 0] |
Rīka padoma nobīde attiecībā pret tā mērķi. Datu atribūtos varat nodot virkni ar komatu atdalītām vērtībām, piemēram: Ja funkcija tiek izmantota, lai noteiktu nobīdi, tā tiek izsaukta ar objektu, kurā kā pirmais arguments ir popper izvietojums, atsauce un popper rects. Aktivizējošais elements DOM mezgls tiek nodots kā otrais arguments. Funkcijai jāatgriež masīvs ar diviem cipariem: . Papildinformāciju skatiet Poppera nobīdes dokumentos . |
popperConfig |
null | objekts | funkciju | null |
Lai mainītu Bootstrap noklusējuma Popper konfigurāciju, skatiet Popper konfigurāciju . Ja funkcija tiek izmantota, lai izveidotu Popper konfigurāciju, tā tiek izsaukta ar objektu, kas satur Bootstrap noklusējuma Popper konfigurāciju. Tas palīdz izmantot un apvienot noklusējuma iestatījumus ar savu konfigurāciju. Funkcijai ir jāatgriež Popper konfigurācijas objekts. |
Datu atribūti atsevišķiem rīka padomiem
Atsevišķu rīka padomu opcijas var arī norādīt, izmantojot datu atribūtus, kā paskaidrots iepriekš.
Izmantojot funkciju arpopperConfig
var tooltip = new bootstrap.Tooltip(element, {
popperConfig: function (defaultBsPopperConfig) {
// var newPopperConfig = {...}
// use defaultBsPopperConfig if needed...
// return newPopperConfig
}
})
Metodes
Asinhronās metodes un pārejas
Visas API metodes ir asinhronas un sāk pāreju . Viņi atgriežas pie zvanītāja, tiklīdz ir sākta pāreja, bet pirms tās beigām . Turklāt pārejas komponenta metodes izsaukums tiks ignorēts .
parādīt
Parāda elementa rīka padomu. Atgriežas pie zvanītāja, pirms rīka padoms ir faktiski parādīts (ti, pirms shown.bs.tooltip
notikuma). To uzskata par rīka padoma “manuālu” aktivizēšanu. Rīka padomi ar nulles garuma virsrakstiem nekad netiek rādīti.
tooltip.show()
paslēpties
Paslēpj elementa rīka padomu. Atgriežas pie zvanītāja, pirms rīka padoms faktiski ir paslēpts (ti, pirms hidden.bs.tooltip
notikuma). To uzskata par rīka padoma “manuālu” aktivizēšanu.
tooltip.hide()
pārslēgt
Pārslēdz elementa rīka padomu. Atgriežas pie zvanītāja, pirms rīka padoms ir faktiski parādīts vai paslēpts (ti, pirms shown.bs.tooltip
vai hidden.bs.tooltip
notikuma). To uzskata par rīka padoma “manuālu” aktivizēšanu.
tooltip.toggle()
atbrīvoties
Paslēpj un iznīcina elementa rīka padomu (noņem DOM elementā saglabātos datus). Rīka padomus, kuros tiek izmantota deleģēšana (kas tiek izveidoti, izmantojot opciju selector
) , nevar atsevišķi iznīcināt pēcnācēju aktivizētāja elementiem.
tooltip.dispose()
iespējot
Nodrošina elementa rīka padomam iespēju tikt parādītam. Rīka padomi ir iespējoti pēc noklusējuma.
tooltip.enable()
atspējot
Noņem iespēju rādīt elementa rīka padomu. Rīka padomu varēs parādīt tikai tad, ja tas būs atkārtoti iespējots.
tooltip.disable()
pārslēgtIespējots
Pārslēdz iespēju rādīt vai paslēpt elementa rīka padomu.
tooltip.toggleEnabled()
Atjaunināt
Atjaunina elementa rīka padoma pozīciju.
tooltip.update()
getInstance
Statiskā metode, kas ļauj iegūt rīka padoma gadījumu, kas saistīts ar DOM elementu
var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance
getOrCreateInstance
Statiskā metode, kas ļauj iegūt rīka padoma gadījumu, kas saistīts ar DOM elementu, vai izveidot jaunu, ja tas nav inicializēts
var exampleTriggerEl = document.getElementById('example')
var tooltip = bootstrap.Tooltip.getOrCreateInstance(exampleTriggerEl) // Returns a Bootstrap tooltip instance
Pasākumi
Pasākuma veids | Apraksts |
---|---|
show.bs.tooltip |
Šis notikums tiek aktivizēts nekavējoties, kad show tiek izsaukta instances metode. |
shown.bs.tooltip |
Šis notikums tiek aktivizēts, kad rīka padoms ir padarīts redzams lietotājam (pagaidīs, kamēr CSS pārejas tiks pabeigtas). |
hide.bs.tooltip |
Šis notikums tiek aktivizēts nekavējoties, kad hide ir izsaukta instances metode. |
hidden.bs.tooltip |
Šis notikums tiek aktivizēts, kad rīka padoms ir beidzies paslēpt no lietotāja (tiks gaidīts, līdz tiks pabeigtas CSS pārejas). |
inserted.bs.tooltip |
Šis notikums tiek aktivizēts pēc show.bs.tooltip notikuma, kad rīka padoma veidne ir pievienota DOM. |
var myTooltipEl = document.getElementById('myTooltip')
var tooltip = new bootstrap.Tooltip(myTooltipEl)
myTooltipEl.addEventListener('hidden.bs.tooltip', function () {
// do something...
})
tooltip.hide()