Cynghorion offer
Dogfennaeth ac enghreifftiau ar gyfer ychwanegu awgrymiadau cymorth Bootstrap wedi'u teilwra gyda CSS a JavaScript gan ddefnyddio CSS3 ar gyfer animeiddiadau a phriodoleddau data ar gyfer storio teitlau lleol.
Trosolwg
Pethau i'w gwybod wrth ddefnyddio'r ategyn cyngor:
- Mae cynghorion offer yn dibynnu ar Popper y llyfrgell 3ydd parti ar gyfer lleoli. Rhaid i chi gynnwys popper.min.js cyn bootstrap.js neu use
bootstrap.bundle.min.js
/bootstrap.bundle.js
sy'n cynnwys Popper er mwyn i tooltips weithio! - Os ydych chi'n adeiladu ein JavaScript o'r ffynhonnell, mae angen
util.js
. - Mae awgrymiadau offer yn optio i mewn am resymau perfformiad, felly mae'n rhaid i chi eu cychwyn eich hun .
- Nid yw awgrymiadau offer gyda theitlau hyd sero byth yn cael eu harddangos.
- Nodwch
container: 'body'
er mwyn osgoi problemau rendro mewn cydrannau mwy cymhleth (fel ein grwpiau mewnbwn, grwpiau botwm, ac ati). - Ni fydd ysgogi awgrymiadau offer ar elfennau cudd yn gweithio.
- Rhaid ysgogi awgrymiadau offer ar gyfer
.disabled
neudisabled
elfennau ar elfen lapio. - Pan gânt eu hysgogi gan hyperddolenni sy'n ymestyn dros linellau lluosog, bydd cynghorion offer yn cael eu canoli. Defnyddiwch
white-space: nowrap;
ar eich<a>
s i osgoi'r ymddygiad hwn. - Rhaid cuddio awgrymiadau offer cyn i'w helfennau cyfatebol gael eu tynnu o'r DOM.
- Gellir sbarduno cynghorion offer diolch i elfen y tu mewn i DOM cysgodol.
prefers-reduced-motion
ymholiad y cyfryngau. Gweler
adran cynnig gostyngol ein dogfennaeth hygyrchedd .
Wedi cael hynny i gyd? Gwych, gadewch i ni weld sut maen nhw'n gweithio gyda rhai enghreifftiau.
Enghraifft: Galluogi cynghorion offer ym mhobman
Un ffordd o gychwyn pob cyngor offer ar dudalen fyddai eu dewis yn ôl eu data-toggle
priodoledd:
$(function () {
$('[data-toggle="tooltip"]').tooltip()
})
Enghreifftiau
Hofran dros y dolenni isod i weld awgrymiadau offer:
Testun dalfan i ddangos rhai cysylltiadau mewnol ag awgrymiadau offer. Mae hyn yn awr yn unig llenwi, dim llofrudd. Cynnwys a osodir yma dim ond i ddynwared presenoldeb testun go iawn . A hynny i gyd dim ond i roi syniad i chi o sut y byddai awgrymiadau offer yn edrych pan gânt eu defnyddio mewn sefyllfaoedd byd go iawn. Felly gobeithio eich bod bellach wedi gweld sut y gall yr awgrymiadau hyn ar ddolenni weithio'n ymarferol, ar ôl i chi eu defnyddio ar eich gwefan neu brosiect eich hun.
Hofran dros y botymau isod i weld y pedwar cyfarwyddyd cyngor offer: top, dde, gwaelod, a chwith.
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="top" title="Tooltip on top">
Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="right" title="Tooltip on right">
Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="bottom" title="Tooltip on bottom">
Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-placement="left" title="Tooltip on left">
Tooltip on left
</button>
A chyda HTML personol wedi'i ychwanegu:
<button type="button" class="btn btn-secondary" data-toggle="tooltip" data-html="true" title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
Tooltip with HTML
</button>
Defnydd
Mae'r ategyn tooltip yn cynhyrchu cynnwys a marcio yn ôl y galw, ac yn ddiofyn yn gosod awgrymiadau offer ar ôl eu helfen sbarduno.
Sbardunwch y cyngor trwy JavaScript:
$('#example').tooltip(options)
gorlif auto
ascroll
Mae safle Tooltip yn ceisio newid yn awtomatig pan fydd gan gynhwysydd rhiant overflow: auto
neu'n overflow: scroll
hoffi ein .table-responsive
, ond mae'n dal i gadw safle'r lleoliad gwreiddiol. I ddatrys, gosodwch yr boundary
opsiwn i unrhyw beth heblaw gwerth diofyn, 'scrollParent'
, megis 'window'
:
$('#example').tooltip({ boundary: 'window' })
Marcio
Priodoledd yn unig yw'r marcio gofynnol ar gyfer cyngor offer data
ac title
ar yr elfen HTML rydych chi'n dymuno cael cyngor. Mae'r marcio a gynhyrchir o gyngor offer braidd yn syml, er bod angen safle (yn ddiofyn, wedi'i osod top
gan yr ategyn).
Gwneud i awgrymiadau cymorth weithio ar gyfer defnyddwyr bysellfwrdd a thechnoleg gynorthwyol
Dim ond elfennau HTML sy'n draddodiadol yn canolbwyntio ar fysellfyrddau ac yn rhyngweithiol y dylech eu hychwanegu (fel dolenni neu reolaethau ffurf). <span>
Er y gellir gwneud elfennau HTML mympwyol (fel s) yn ffocws trwy ychwanegu'r tabindex="0"
nodwedd, bydd hyn yn ychwanegu stopiau tab a allai fod yn annifyr a dryslyd ar elfennau nad ydynt yn rhyngweithiol ar gyfer defnyddwyr bysellfwrdd, ac ar hyn o bryd nid yw'r rhan fwyaf o dechnolegau cynorthwyol yn cyhoeddi'r cyngor yn y sefyllfa hon. Yn ogystal, peidiwch â dibynnu'n llwyr arno hover
fel sbardun ar gyfer eich cyngor, gan y bydd hyn yn gwneud eich cynghorion offer yn amhosibl eu sbarduno i ddefnyddwyr bysellfwrdd.
<!-- HTML to write -->
<a href="#" data-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="arrow"></div>
<div class="tooltip-inner">
Some tooltip text!
</div>
</div>
Elfennau anabl
Nid yw elfennau gyda'r disabled
priodoledd yn rhyngweithiol, sy'n golygu na all defnyddwyr ganolbwyntio, hofran na chlicio arnynt i sbarduno cyngor (neu popover). Fel ateb i'r broblem, byddwch chi eisiau sbarduno'r cyngor offer o ddeunydd lapio <div>
neu <span>
, sy'n ddelfrydol wedi'i wneud â ffocws bysellfwrdd gan ddefnyddio tabindex="0"
, a diystyru'r pointer-events
elfen ar yr anabl.
<span class="d-inline-block" tabindex="0" data-toggle="tooltip" title="Disabled tooltip">
<button class="btn btn-primary" style="pointer-events: none;" type="button" disabled>Disabled button</button>
</span>
Opsiynau
Gellir trosglwyddo opsiynau trwy briodoleddau data neu JavaScript. Ar gyfer priodoleddau data, atodwch enw'r opsiwn i data-
, fel yn data-animation=""
.
sanitize
,
sanitizeFn
ac
opsiynau gan ddefnyddio priodoleddau data.whiteList
Enw | Math | Diofyn | Disgrifiad |
---|---|---|---|
animeiddiad | boolaidd | gwir | Cymhwyso trawsnewidiad pylu CSS i'r cyngor |
cynhwysydd | llinyn | elfen | ffug | ffug | Yn atodi'r cyngor i elfen benodol. Enghraifft: |
oedi | rhif | gwrthrych | 0 | Oedi wrth ddangos a chuddio'r cyngor (ms) - nid yw'n berthnasol i'r math o sbardun â llaw Os bydd rhif yn cael ei gyflenwi, bydd oedi yn cael ei gymhwyso i'r ddwy guddfan/sioe Strwythur gwrthrych yw: |
html | boolaidd | ffug | Caniatáu HTML yn y cyngor. Os yn wir, bydd tagiau HTML yn y cyngor yn Defnyddiwch destun os ydych chi'n poeni am ymosodiadau XSS. |
lleoliad | llinyn | swyddogaeth | 'top' | Sut i leoli'r cyngor - auto | brig | gwaelod | chwith | iawn. Pan ddefnyddir swyddogaeth i benderfynu ar y lleoliad, fe'i gelwir gyda'r nod DOM cyngor offer fel ei ddadl gyntaf a'r elfen sbarduno nod DOM fel ei ail. Mae'r |
detholwr | llinyn | ffug | ffug | Os darperir dewisydd, bydd gwrthrychau cyngor offer yn cael eu dirprwyo i'r targedau penodedig. Yn ymarferol, defnyddir hwn hefyd i gymhwyso awgrymiadau offer i elfennau DOM ( jQuery.on cymorth) a ychwanegwyd yn ddeinamig. Gweler hyn ac enghraifft llawn gwybodaeth . |
templed | llinyn | '<div class="tooltip" role="tooltip"><div class="arrow"></div><div class="tooltip-inner"></div></div>' |
Sylfaen HTML i'w ddefnyddio wrth greu'r cyngor. Bydd y cynghorion offer yn
Dylai'r elfen lapio allanol gynnwys y |
teitl | llinyn | elfen | swyddogaeth | '' | Gwerth teitl diofyn os Os rhoddir ffwythiant, fe'i gelwir gyda'i |
sbardun | llinyn | 'ffocws hofran' | Sut mae cyngor yn cael ei sbarduno - cliciwch | hofran | ffocws | llaw. Efallai y byddwch yn pasio sbardunau lluosog; eu gwahanu â gofod.
|
gwrthbwyso | rhif | llinyn | swyddogaeth | 0 | Gwrthbwyso'r cyngor mewn perthynas â'i darged. Pan ddefnyddir swyddogaeth i bennu'r gwrthbwyso, fe'i gelwir gyda gwrthrych sy'n cynnwys y data gwrthbwyso fel ei ddadl gyntaf. Rhaid i'r swyddogaeth ddychwelyd gwrthrych gyda'r un strwythur. Mae nod DOM yr elfen sbarduno yn cael ei basio fel yr ail ddadl. Am ragor o wybodaeth cyfeiriwch at ddogfennau gwrthbwyso Popper . |
Lleoliad wrth gefn | llinyn | arae | 'fflip' | Caniatewch i nodi pa safle y bydd Popper yn ei ddefnyddio wrth gefn. Am ragor o wybodaeth cyfeiriwch at ddogfennau ymddygiad Popper |
arferDosbarth | llinyn | swyddogaeth | '' | Ychwanegwch ddosbarthiadau i'r cyngor pan fydd yn cael ei ddangos. Sylwch y bydd y dosbarthiadau hyn yn cael eu hychwanegu yn ychwanegol at unrhyw ddosbarthiadau a nodir yn y templed. I ychwanegu dosbarthiadau lluosog, gwahanwch nhw gyda bylchau: Gallwch hefyd basio swyddogaeth a ddylai ddychwelyd un llinyn yn cynnwys enwau dosbarth ychwanegol. |
ffin | llinyn | elfen | 'sgrolio Rhiant' | Ffin cyfyngiad gorlif y cyngor. Yn derbyn gwerthoedd 'viewport' , 'window' , 'scrollParent' , neu gyfeirnod HTMLElement (JavaScript yn unig). I gael rhagor o wybodaeth, cyfeiriwch at ddogfennau preventOverflow Popper . |
glanweithdra | boolaidd | gwir | Galluogi neu analluogi'r glanweithdra. Os caiff ei actifadu 'template' a 'title' bydd yr opsiynau'n cael eu diheintio. Gweler yr adran glanweithydd yn ein dogfennaeth JavaScript . |
gwynRhestr | gwrthrych | Gwerth diofyn | Gwrthrych sy'n cynnwys priodoleddau a thagiau a ganiateir |
glanweithdraFn | null | swyddogaeth | null | Yma gallwch gyflenwi eich swyddogaeth glanweithdra eich hun. Gall hyn fod yn ddefnyddiol os yw'n well gennych ddefnyddio llyfrgell bwrpasol i wneud glanweithdra. |
popperConfig | null | gwrthrych | null | I newid ffurfweddiad Popper rhagosodedig Bootstrap, gweler cyfluniad Popper |
Priodoleddau data ar gyfer cynghorion offer unigol
Fel arall, gellir nodi opsiynau ar gyfer cynghorion offer unigol trwy ddefnyddio priodoleddau data, fel yr eglurir uchod.
Dulliau
Dulliau a thrawsnewidiadau anghydamserol
Mae pob dull API yn asyncronaidd ac yn dechrau cyfnod pontio . Maen nhw'n dychwelyd at y galwr cyn gynted ag y bydd y cyfnod pontio wedi dechrau ond cyn iddo ddod i ben . Yn ogystal, bydd galwad dull ar gydran trawsnewid yn cael ei anwybyddu .
$().tooltip(options)
Yn cysylltu triniwr cyngor offer wrth gasgliad elfennau.
.tooltip('show')
Yn datgelu cyngor offer elfen. Yn dychwelyd at y galwr cyn i'r cyngor gael ei ddangos (hy cyn i'r shown.bs.tooltip
digwyddiad ddigwydd). Ystyrir hyn yn sbardun “â llaw” o'r cyngor. Nid yw awgrymiadau offer gyda theitlau hyd sero byth yn cael eu harddangos.
$('#element').tooltip('show')
.tooltip('hide')
Yn cuddio cyngor offer elfen. Yn dychwelyd at y galwr cyn i'r cyngor gael ei guddio (hy cyn i'r hidden.bs.tooltip
digwyddiad ddigwydd). Ystyrir hyn yn sbardun “â llaw” o'r cyngor.
$('#element').tooltip('hide')
.tooltip('toggle')
Toglo cyngor offer elfen. Yn dychwelyd i'r galwr cyn i'r cyngor gael ei ddangos neu ei guddioshown.bs.tooltip
( hy cyn i'r hidden.bs.tooltip
digwyddiad ddigwydd). Ystyrir hyn yn sbardun “â llaw” o'r cyngor.
$('#element').tooltip('toggle')
.tooltip('dispose')
Yn cuddio ac yn dinistrio cyngor offer elfen. Ni all awgrymiadau offer sy'n defnyddio dirprwyo (sy'n cael eu creu gan ddefnyddio'r opsiwnselector
) gael eu dinistrio'n unigol ar elfennau sbardun disgynnydd .
$('#element').tooltip('dispose')
.tooltip('enable')
Yn rhoi'r gallu i gyngor offer elfen gael ei ddangos. Mae awgrymiadau offer yn cael eu galluogi yn ddiofyn.
$('#element').tooltip('enable')
.tooltip('disable')
Yn dileu'r gallu i ddangos cyngor offer elfen. Dim ond os caiff ei ail-alluogi y bydd modd dangos y cyngor.
$('#element').tooltip('disable')
.tooltip('toggleEnabled')
Toglo'r gallu i awgrym offer elfen gael ei ddangos neu ei guddio.
$('#element').tooltip('toggleEnabled')
.tooltip('update')
Yn diweddaru lleoliad cyngor offer elfen.
$('#element').tooltip('update')
Digwyddiadau
Math o Ddigwyddiad | Disgrifiad |
---|---|
cyngor.bs | Mae'r digwyddiad hwn yn tanio ar unwaith pan show elwir y dull enghraifft. |
cyngor.bs | Mae'r digwyddiad hwn yn cael ei danio pan fydd y cyngor wedi'i wneud yn weladwy i'r defnyddiwr (bydd yn aros i'r trawsnewidiadau CSS gael eu cwblhau). |
cyngor.cuddio.bs | Mae'r digwyddiad hwn yn cael ei danio ar unwaith pan fydd y hide dull enghraifft wedi'i alw. |
cyngor.bs.cudd | Mae'r digwyddiad hwn yn cael ei danio pan fydd y cyngor wedi gorffen cael ei guddio rhag y defnyddiwr (bydd yn aros i'r trawsnewidiadau CSS gael eu cwblhau). |
mewnosod.bs.tooltip | Mae'r digwyddiad hwn yn cael ei danio ar ôl y show.bs.tooltip digwyddiad pan fydd y templed cyngor wedi'i ychwanegu at y DOM. |
$('#myTooltip').on('hidden.bs.tooltip', function () {
// do something...
})