Téigh ar aghaidh chuig an bpríomhábhar Scipeáil chuig nascleanúint docs
in English

Leideanna uirlisí

Doiciméadú agus samplaí chun leideanna saincheaptha Bootstrap a chur le CSS agus JavaScript ag baint úsáide as CSS3 le haghaidh beochana agus sonraí-bs-tréithe le haghaidh stórála teidil áitiúil.

Forbhreathnú

Rudaí le fios agus an breiseán leid uirlisí á úsáid agat:

  • Braitheann leideanna uirlisí ar Phopper na leabharlainne 3ú páirtí le haghaidh suímh. Ní mór duit popper.min.js a chur san áireamh roimh bootstrap.js nó úsáid bootstrap.bundle.min.js/ bootstrap.bundle.jsina bhfuil Popper le go n-oibreoidh leideanna uirlisí!
  • Is rogha an diúltaithe iad leideanna uirlisí ar chúiseanna feidhmíochta, mar sin ní mór duit iad a thosú tú féin .
  • Ní thaispeántar leideanna uirlisí le teidil fad nialasacha riamh.
  • Sonraigh container: 'body'chun fadhbanna rindreála a sheachaint i gcomhpháirteanna níos casta (amhail ár ngrúpaí ionchuir, grúpaí cnaipí, srl).
  • Ní oibreoidh leideanna uirlisí ar eilimintí ceilte a spreagadh.
  • Ní mór leideanna uirlisí .disableddisabledeilimintí a spreagadh ar eilimint chumhdaigh.
  • Nuair a spreagtar iad ó hipearnasc a théann thar línte iolracha, díreofar leideanna uirlisí. Bain úsáid as white-space: nowrap;ar do <a>chuid chun an iompar seo a sheachaint.
  • Ní mór leideanna uirlisí a chur i bhfolach sula mbaintear na heilimintí comhfhreagracha den DOM.
  • Is féidir leideanna uirlisí a spreagadh a bhuíochas le heilimint taobh istigh de scáth DOM.
De réir réamhshocraithe, úsáideann an chomhpháirt seo an sanitizer ábhar ionsuite, a stiallacha amach aon eilimintí HTML nach bhfuil ceadaithe go sainráite. Féach an rannán sláintíochta inár ndoiciméadú JavaScript le haghaidh tuilleadh sonraí.
Tá éifeacht beochana an chomhpháirt seo ag brath ar prefers-reduced-motioncheist na meán. Féach an rannán tairiscint laghdaithe dár gcáipéisíocht inrochtaineachta .

Fuair ​​sin go léir? Go hiontach, déanaimis a fheiceáil conas a oibríonn siad le roinnt samplaí.

Sampla: Cumasaigh leideanna i ngach áit

Bealach amháin chun na leideanna uirlisí go léir ar leathanach a thosú ná iad a roghnú de réir a n- data-bs-toggletréith:

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

Samplaí

Aló thar na naisc thíos chun leideanna uirlisí a fheiceáil:

Téacs sealbhóir áitribh chun naisc inlíne le leideanna uirlisí a léiriú. Níl anseo anois ach filler, gan aon killer. Ábhar a chuirtear anseo díreach chun aithris a dhéanamh ar láithreacht téacs fíor . Agus sin go léir chun tuairim a thabhairt duit ar an gcuma a bheadh ​​ar leideanna uirlisí nuair a úsáidtear iad i gcásanna sa saol fíor. Mar sin tá súil agam go bhfeicfidh tú anois conas is féidir leis na leideanna uirlisí seo ar naisc oibriú go praiticiúil, nuair a úsáideann tú iad ar do shuíomh nó ar do thionscadal féin.

Ainligh thar na cnaipí thíos chun na ceithre threo leideanna uirlisí a fheiceáil: barr, ar dheis, ag bun agus ar chlé. Léirítear treoracha nuair a bhíonn Bootstrap in úsáid 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>

Agus le HTML saincheaptha curtha leis:

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

Le SVG:

Sass

Athróga

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

Úsáid

Gineann an breiseán leid uirlisí inneachar agus marcáil ar éileamh, agus de réir réamhshocraithe cuireann sé leideanna uirlisí i ndiaidh a n-eiliminte truicear.

Spreag an leid uirlisí trí JavaScript:

var exampleEl = document.getElementById('example')
var tooltip = new bootstrap.Tooltip(exampleEl, options)
Cur thar maoil autoagusscroll

Féachann suíomh Tooltip le hathrú go huathoibríoch nuair a bhíonn ár gcoimeádán tuismitheoraoverflow: auto nó nuair is overflow: scrollmaith leis an ár .table-responsivegcoimeádán , ach coinníonn sé suíomh an tsocrúcháin bhunaidh fós. Chun é seo a réiteach, socraigh an boundaryrogha (don mhodhnóir smeach ag baint úsáide as an popperConfigrogha) chuig aon eilimint HTML chun an luach réamhshocraithe a shárú, 'clippingParents', mar shampla document.body:

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

Marcáil

Níl sa mharcáil riachtanach do leid uirlisí ach datatréith agus titlear an eilimint HTML is mian leat leid uirlisí a bheith agat. Tá an marcáil ginte ar leid uirlisí sách simplí, cé go dteastaíonn suíomh uaidh (de réir réamhshocraithe, socraithe topag an mbreiseán).

Feidhmíonn leideanna uirlisí d’úsáideoirí méarchláir agus d’úsáideoirí teicneolaíochta cúnta

Níor cheart duit ach leideanna uirlisí a chur le heilimintí HTML atá go traidisiúnta dírithe ar mhéarchlár agus idirghníomhach (cosúil le naisc nó rialuithe foirmeacha). Cé gur féidir gnéithe treallach HTML (cosúil le <span>s) a dhíriú tríd an tabindex="0"tréith a chur leis, cuirfidh sé seo stadanna cluaisíní a d’fhéadfadh a bheith corraitheach agus mearbhall ar eilimintí neamh-idirghníomhacha d’úsáideoirí méarchláir, agus faoi láthair ní fhógraíonn formhór na dteicneolaíochtaí cúnta an leid uirlisí sa chás seo. Ina theannta sin, ná bí ag brath go hiomlán hovermar thruicear do leid uirlisí, mar go mbeidh sé dodhéanta do leideanna uirlisí a spreagadh d'úsáideoirí méarchláir.

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

Eilimintí faoi mhíchumas

Níl na heilimintí leis an disabledtréith idirghníomhach, rud a chiallaíonn nach féidir le húsáideoirí díriú orthu, iad a ainliú nó a chliceáil chun leid uirlisí (nó aníos aníos) a spreagadh. Mar réiteach oibre, beidh tú ag iarraidh an leid uirlisí a spreagadh ó fhillteán <div><span>, atá dírithe ar mhéarchlár go hidéalach ag baint úsáide as 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>

Roghanna

Is féidir roghanna a chur ar aghaidh trí tréithe sonraí nó JavaScript. Maidir le tréithe sonraí, cuir ainm na rogha i gceangal le data-bs-, mar atá i data-bs-animation="". Bí cinnte cineál an cháis den ainm rogha a athrú ó camelCase go cás ceibeab agus tú ag dul thar na roghanna trí tréithe sonraí. Mar shampla, in ionad úsáid a bhaint as data-bs-customClass="beautifier", bain úsáid as data-bs-custom-class="beautifier".

Tabhair faoi deara, ar chúiseanna slándála, nach féidir an sanitize, sanitizeFn, agus allowListroghanna a sholáthar trí úsáid a bhaint as tréithe sonraí.
Ainm Cineál Réamhshocrú Cur síos
animation Boole true Cuir trasdul céimnithe CSS i bhfeidhm ar an leid uirlisí
container teaghrán | eilimint | bréagach false

Cuireann sé an leid uirlisí le heilimint ar leith. Sampla: container: 'body'. Tá an rogha seo úsáideach go háirithe sa mhéid is go gceadaíonn sé duit an leid uirlisí a shuíomh i sreabhadh an doiciméid in aice leis an eilimint truicearaithe - rud a chuirfidh cosc ​​ar an leid uirlisí ó snámh ón eilimint spreagaithe le linn athrú méide fuinneoige.

delay uimhir | réad 0

Moill ag taispeáint agus ag cur i bhfolach an leid uirlisí (ms) - ní bhaineann sé le cineál truicear láimhe

Má chuirtear uimhir ar fáil, cuirtear moill i bhfeidhm ar an dá cheilt/seó

Is é struchtúr an ábhair:delay: { "show": 500, "hide": 100 }

html Boole false

Ceadaigh HTML sa leid uirlisí.

Más fíor, déanfar clibeanna HTML sna leideanna uirlisí titlea rindreáil sa leid uirlisí. Má tá sé bréagach, innerTextbainfear úsáid as maoin chun ábhar a chur isteach sa DOM.

Úsáid téacs má tá imní ort faoi ionsaithe XSS.

placement teaghrán | feidhm 'top'

Conas an leid uirlisí a shuíomh - uathoibríoch | barr | bun | chlé | ceart.
Nuair autoa shonraítear é, athróidh sé an leid uirlisí go dinimiciúil.

Nuair a úsáidtear feidhm chun an socrúchán a chinneadh, tugtar an nód DOM leid uirlisí mar a chéad argóint agus nód DOM na heiliminte spreagúla mar an dara háit. Tá an thiscomhthéacs socraithe don ásc leid uirlisí.

selector teaghrán | bréagach false Má chuirtear roghnóir ar fáil, déanfar cuspóirí na leideanna uirlisí a tharmligean chuig na spriocanna sonraithe. Go praiticiúil, úsáidtear é seo chun leideanna uirlisí a chur i bhfeidhm ar eilimintí DOM ( jQuery.ontacaíocht) a chuirtear leis go dinimiciúil. Féach é seo agus sampla faisnéiseach .
template teaghrán '<div class="tooltip" role="tooltip"><div class="tooltip-arrow"></div><div class="tooltip-inner"></div></div>'

Bunús HTML le húsáid agus an leid uirlisí á chruthú.

Déanfar na leideanna uirlisí titlea instealladh isteach sa .tooltip-inner.

.tooltip-arrowbeidh saighead an leid uirlisí.

.tooltipBa chóir go mbeadh an rang agus an eilimint fillte is forimeallaí role="tooltip".

title teaghrán | eilimint | feidhm ''

Luach teidil réamhshocraithe mura titlebhfuil an aitreabúid i láthair.

Má thugtar feidhm, glaofar í lena thistacar tagartha don eilimint a bhfuil an leid uirlisí ceangailte léi.

trigger teaghrán 'hover focus'

Conas a spreagtar leid uirlisí - cliceáil | ainlíon | fócas | lámhleabhar. Is féidir leat pas a fháil truicear iolrach; iad a scaradh le spás.

'manual'go gcuireann sé in iúl go spreagfar an leid uirlisí go ríomhchláraithe trí bhíthin .show(), .hide()agus .toggle()modhanna; ní féidir an luach seo a chomhcheangal le haon truicear eile.

'hover'ina n-aonar beidh leideanna uirlisí ann nach féidir a spreagadh tríd an méarchlár, agus níor cheart iad a úsáid ach amháin má tá modhanna eile ann chun an fhaisnéis chéanna a chur in iúl d'úsáideoirí méarchláir.

fallbackPlacements eagar ['top', 'right', 'bottom', 'left'] Sainmhínigh socrúcháin chúltaca trí liosta socrúcháin a sholáthar in eagar (in ord tosaíochta). Le haghaidh tuilleadh eolais déan tagairt do dhoiciméid iompair Popper
boundary teaghrán | eilimint 'clippingParents' Teorainn shrianta thar maoil an leid uirlisí (ní bhaineann sé ach le modhnóir preventOverflow Popper). De réir réamhshocraithe tá sé 'clippingParents'agus is féidir glacadh le tagairt HTMLElement (trí JavaScript amháin). Le haghaidh tuilleadh faisnéise déan tagairt do dhoiciméid detectOverflow Popper .
customClass teaghrán | feidhm ''

Cuir ranganna leis an leid uirlisí nuair a thaispeánfar é. Tabhair faoi deara go gcuirfear na ranganna seo i dteannta le ranganna ar bith a shonraítear sa teimpléad. Chun ranganna iolracha a chur leis, scar iad le spásanna: 'class-1 class-2'.

Is féidir leat feidhm a rith freisin ar cheart di teaghrán amháin a thabhairt ar ais ina bhfuil ainmneacha ranga breise.

sanitize Boole true Cumasaigh nó díchumasaigh an sláintíocht. Má chuirtear i ngníomh é 'template'agus 'title'déanfar na roghanna a shláintiú. Féach an rannán sláintíochta inár ndoiciméadú JavaScript .
allowList réad Luach réamhshocraithe Réad ina bhfuil tréithe agus clibeanna ceadaithe
sanitizeFn null | feidhm null Anseo is féidir leat d'fheidhm sláintíochta féin a sholáthar. Féadfaidh sé seo a bheith úsáideach más fearr leat leabharlann thiomanta a úsáid chun sláintíocht a dhéanamh.
offset eagar | teaghrán | feidhm [0, 0]

Fritháireamh an leid uirlisí i gcoibhneas lena sprioc. Is féidir leat teaghrán a chur isteach i tréithe sonraí le luachanna scartha le camóg mar:data-bs-offset="10,20"

Nuair a úsáidtear feidhm chun an fhritháireamh a chinneadh, tugtar le réad ina bhfuil an socrúchán popper, an tagairt, agus rects popper mar a chéad argóint. Ritear an nód DOM na heiliminte spreagúla mar an dara argóint. Caithfidh an fheidhm eagar a thabhairt ar ais le dhá uimhir: .[skidding, distance]

Le haghaidh tuilleadh eolais déan tagairt do dhoiciméid fhritháireamh Popper .

popperConfig null | réad | feidhm null

Chun cumraíocht réamhshocraithe Bootstrap Popper a athrú, féach cumraíocht Popper .

Nuair a úsáidtear feidhm chun cumraíocht Popper a chruthú, tugtar réad a bhfuil cumraíocht réamhshocraithe Popper ann do Bootstrap. Cabhraíonn sé leat an réamhshocrú a úsáid agus a chumasc le do chumraíocht féin. Caithfidh an fheidhm réad cumraíochta a thabhairt ar ais do Popper.

Tréithe sonraí le haghaidh leideanna uirlisí aonair

De rogha air sin, is féidir roghanna le haghaidh leideanna aonair a shonrú trí úsáid a bhaint as tréithe sonraí, mar a mhínítear thuas.

Ag baint úsáide as feidhm lepopperConfig

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

Modhanna

Modhanna agus aistrithe asincrónacha

Tá gach modh API asincrónach agus cuireann siad tús le haistriú . Filleann siad ar an nglaoiteoir chomh luath agus a chuirtear tús leis an aistriú ach sula gcríochnaíonn sé . Ina theannta sin, ní thabharfar aird ar ghlao modha ar chomhpháirt trasdula .

Féach ar ár gcáipéisíocht JavaScript le haghaidh tuilleadh eolais .

seó

Nochtann leid uirlisí eilimint. Filleann sé ar an nglaoiteoir sula dtaispeántar an leid uirlisí (ie sula shown.bs.tooltipdtarlaíonn an teagmhas). Meastar gur spreagadh “láimhe” é seo don leid uirlisí. Ní thaispeántar leideanna uirlisí le teidil fad nialasacha riamh.

tooltip.show()

ceilt

Folaigh leid uirlisí eiliminte. Filleann sé ar an nglaoiteoir sula mbeidh an leid uirlisí curtha i bhfolach (ie sula hidden.bs.tooltipdtarlaíonn an t-imeacht). Meastar gur spreagadh “láimhe” é seo don leid uirlisí.

tooltip.hide()

scoránaigh

Scoránaigh an leid uirlisí eilimint. Filleann sé ar an nglaoiteoir sula dtaispeántar nó sula gcuirtear i bhfolach an leid uirlisí (.i. sula dtarlaíonn shown.bs.tooltipnó sula hidden.bs.tooltipdtarlaíonn an teagmhas). Meastar gur spreagadh “láimhe” é seo don leid uirlisí.

tooltip.toggle()

a dhiúscairt

Seithí agus scriosann leid uirlisí eilimint (Baintear sonraí stóráilte ar an eilimint DOM). Ní féidir leideanna uirlisí a úsáideann tarmligean (a chruthaítear leis an selectorrogha ) a scrios ina n-aonar ar eilimintí truicear sliocht.

tooltip.dispose()

chumasú

Tugann sé seo leid uirlisí eilimint an cumas a thaispeáint. Tá leideanna uirlisí cumasaithe de réir réamhshocraithe.

tooltip.enable()

dhíchumasú

Baintear an cumas chun leid uirlisí eiliminte a thaispeáint. Ní bheidh an leid uirlisí in ann a thaispeáint ach amháin má tá sé ath-chumasaithe.

tooltip.disable()

scoránaigh Cumasaithe

Scoránaigh an cumas chun leid uirlisí eiliminte a thaispeáint nó a fholach.

tooltip.toggleEnabled()

nuashonrú

Nuashonraítear suíomh leid uirlisí eiliminte.

tooltip.update()

faighInstance

Modh statach a ligeann duit an t-ásc leid uirlisí a bhaineann le heilimint DOM a fháil

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

getOrCreateInstance

Modh statach a cheadaíonn duit an t-ásc leid uirlisí a bhaineann le heilimint DOM a fháil, nó ceann nua a chruthú ar eagla nach dtosaíodh é

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

Imeachtaí

Cineál imeachta Cur síos
show.bs.tooltip Téann an teagmhas seo chun solais láithreach nuair showa ghlaoitear an modh ásc.
shown.bs.tooltip Cuirtear an teagmhas seo ar ceal nuair a bheidh an leid uirlisí infheicthe don úsáideoir (fanfaidh sé go mbeidh na haistrithe CSS curtha i gcrích).
hide.bs.tooltip Cuirtear an teagmhas seo ar ceal láithreach nuair a bhíonn an hidemodh ásc glaoite.
hidden.bs.tooltip Tá an teagmhas seo bréan nuair a bhíonn an leid uirlisí curtha i bhfolach ón úsáideoir (fanacht go dtí go gcríochnófar na haistrithe CSS).
inserted.bs.tooltip Bristear an teagmhas seo tar éis na show.bs.tooltiphócáide nuair a cuireadh an teimpléad leid uirlisí leis an DOM.
var myTooltipEl = document.getElementById('myTooltip')
var tooltip = new bootstrap.Tooltip(myTooltipEl)

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

tooltip.hide()