Описи алатки
Документација и примери за додавање прилагођених Боотстрап описа алатки са ЦСС-ом и ЈаваСцрипт-ом користећи ЦСС3 за анимације и атрибуте података за локално складиштење наслова.
Преглед
Ствари које треба знати када користите додатак за опис алата:
- Савети се ослањају на библиотеку треће стране Поппер.јс за позиционирање. Морате укључити поппер.мин.јс пре боотстрап.јс или користити
bootstrap.bundle.min.js
/bootstrap.bundle.js
који садржи Поппер.јс да би описи функционисали! - Ако градите наш ЈаваСцрипт из извора, он захтева
util.js
. - Објашњења се могу укључити из разлога перформанси, тако да их морате сами иницијализирати .
- Објашњења са насловима нулте дужине се никада не приказују.
- Наведите
container: 'body'
да бисте избегли проблеме са приказивањем у сложенијим компонентама (као што су наше групе за унос, групе дугмади, итд.). - Покретање описа алатки на скривеним елементима неће радити.
- Објашњења за
.disabled
илиdisabled
елементе морају бити покренута на елементу омотача. - Када се активирају са хипервеза које обухватају више редова, описи алата ће бити центрирани. Користите
white-space: nowrap;
на вашем<a>
с да бисте избегли ово понашање. - Објашњења морају бити сакривена пре него што се њихови одговарајући елементи уклоне из ДОМ-а.
- Алати се могу покренути захваљујући елементу унутар ДОМ-а у сенци.
Ефекат анимације ове компоненте зависи од prefers-reduced-motion
медијског упита. Погледајте одељак о смањеном покрету наше документације о приступачности .
Имаш све то? Одлично, да видимо како раде на неким примерима.
Пример: Омогућите савете свуда
Један од начина да се иницијализују сви описи алата на страници био би да их изаберете према њиховом data-toggle
атрибуту:
Примери
Пређите курсором преко линкова испод да бисте видели савете:
Уске панталоне следећег нивоа кефије за које вероватно нисте чули. Фото штанд брада сирови тексас висока штампа веганска торба за гласнике стумптовн. Сеитан од фарме до стола, мцсвеенеи'с фикие одржива киноа 8-битна америчка одећа има винил цхамбраи од терри рицхардсон-а. Брада стумптовн, кардигани банх ми ломо тхундерцатс. Тофу биодизел Виллиамсбург марфа, четири локо мцсвеенеи'с цлеансе веган цхамбраи. Заиста ироничан занатлија без обзира на кеитар , сценестер од фарме до стола Банкси Аустин твиттер обрађује фрееган цред сирови тексас извор кафе једног порекла.
Пређите курсором преко дугмади испод да бисте видели четири упутства за савете: горе, десно, доле и лево.
И са додатком прилагођеног ХТМЛ-а:
Употреба
Додатак за опис алата генерише садржај и ознаке на захтев и подразумевано поставља описе алата након њиховог елемента окидача.
Покрени опис алатке преко ЈаваСцрипт-а:
Оверфлов auto
андscroll
Положај описа алатке покушава да се аутоматски промени када родитељски контејнер има overflow: auto
или overflow: scroll
воли наш .table-responsive
, али и даље задржава позиционирање оригиналног одредишта за пласман. Да бисте то решили, подесите boundary
опцију на било шта осим подразумеване вредности, 'scrollParent'
као што је 'window'
:
Означавање
Потребна ознака за опис алата је само data
атрибут и title
на ХТМЛ елементу желите да имате опис алата. Генерисана ознака описа алата је прилично једноставна, иако захтева позицију (подразумевано, постављену на top
додатак).
Омогућите да описи алата раде за кориснике тастатуре и помоћне технологије
Требало би да додајете само описе алата ХТМЛ елементима који се традиционално могу фокусирати на тастатуру и интерактивни (као што су везе или контроле обрасца). Иако произвољни ХТМЛ елементи (као што је <span>
с) могу бити фокусирани додавањем tabindex="0"
атрибута, ово ће додати потенцијално досадне и збуњујуће тачке табулатора на неинтерактивним елементима за кориснике тастатуре, а већина помоћних технологија тренутно не најављује опис алата у овој ситуацији. Поред тога, немојте се ослањати само на hover
окидач за свој опис алата, јер ће то онемогућити покретање ваших описа за кориснике тастатуре.
Онемогућени елементи
Елементи са disabled
атрибутом нису интерактивни, што значи да корисници не могу да се фокусирају, лебде или кликну на њих да би покренули опис алатке (или искачући прозор). Као заобилазно решење, желећете да покренете опис алатке из омотача <div>
или <span>
, идеално направљеног за фокусирање на тастатури помоћу tabindex="0"
, и заобилазите pointer-events
он дисаблед елемент.
Опције
Опције се могу пренети преко атрибута података или ЈаваСцрипт-а. За атрибуте података додајте име опције у data-
, као у data-animation=""
.
Имајте на уму да се из безбедносних разлога опције sanitize
и не могу доставити помоћу атрибута података.sanitizeFn
whiteList
Име | Тип | Уобичајено | Опис |
---|---|---|---|
анимација | боолеан | истинито | Примените прелаз са ЦСС фаде на опис алата |
контејнер | стринг | елемент | лажно | лажно | Додаје опис алата одређеном елементу. Пример: |
кашњење | број | објекат | 0 | Одлагање приказивања и сакривања описа алата (мс) – не примењује се на тип ручног окидача Ако је наведен број, кашњење се примењује и на сакривање/прикажи Структура објекта је: |
хтмл | боолеан | лажно | Дозволите ХТМЛ у опису алатке. Ако је тачно, ХТМЛ ознаке у опису алата Користите текст ако сте забринути због КССС напада. |
постављање | стринг | функција | 'врх' | Како поставити опис алата - ауто | врх | боттом | лево | јел тако. Када се функција користи за одређивање положаја, она се позива са ДОМ чвором алатке као првим аргументом и покретачким елементом ДОМ чвором као другим. Контекст |
селектор | стринг | лажно | лажно | Ако је обезбеђен селектор, објекти описа алата ће бити делегирани наведеним циљевима. У пракси, ово се такође користи за примену описа алата на динамички додане ДОМ елементе ( jQuery.on подршка). Погледајте ово и информативни пример . |
шаблон | низ | '<div class="tooltip" role="tooltip"><div class="arrow"></div><div class="tooltip-inner"></div></div>' |
Основни ХТМЛ који се користи приликом креирања описа алата. Објашњење
Најудаљенији елемент омотача треба да има |
наслов | стринг | елемент | функција | '' | Подразумевана вредност наслова ако Ако је дата функција, она ће бити позвана са својом |
Окидач | низ | 'фокус лебдења' | Како се покреће опис алата - кликните | ховер | фокус | упутство. Можете пренети више покретача; одвојите их размаком.
|
офсет | број | стринг | функција | 0 | Померање описа алатке у односу на циљ. Када се функција користи за одређивање офсета, она се позива са објектом који садржи податке о померању као први аргумент. Функција мора да врати објекат са истом структуром. ДОМ чвор покретачког елемента се прослеђује као други аргумент. За више информација погледајте Поппер.јс офсет документе . |
фаллбацкПлацемент | стринг | низ | 'флип' | Дозволите да одредите коју позицију ће Поппер користити на резервном. За више информација погледајте документе о понашању Поппер.јс |
граница | стринг | елемент | 'сцроллПарент' | Граница ограничења преливања описа. Прихвата вредности 'viewport' , 'window' , 'scrollParent' , или референце ХТМЛЕлемента (само ЈаваСцрипт). За више информација погледајте ПревенОверфлов документе Поппер.јс . |
оцистити | боолеан | истинито | Омогућите или онемогућите дезинфекцију. Ако се активира 'template' и 'title' опције ће бити дезинфициране. |
вхитеЛист | објекат | Задана вриједност | Објекат који садржи дозвољене атрибуте и ознаке |
санитизеФн | нулл | функција | нула | Овде можете обезбедити сопствену функцију дезинфекције. Ово може бити корисно ако више волите да користите наменску библиотеку за дезинфекцију. |
попперЦонфиг | нулл | објекат | нула | Да бисте променили Боотстрап-ову подразумевану Поппер.јс конфигурацију, погледајте конфигурацију Поппер.јс-а |
Атрибути података за појединачне описе алата
Опције за појединачне описе алата могу се алтернативно специфицирати коришћењем атрибута података, као што је објашњено горе.
Методе
Асинхроне методе и прелази
Све АПИ методе су асинхроне и покрећу транзицију . Они се враћају позиваоцу чим се транзиција започне, али пре него што се заврши . Поред тога, позив методе за прелазну компоненту биће занемарен .
Погледајте нашу ЈаваСцрипт документацију за више информација .
$().tooltip(options)
Припаја руковао описом алата колекцији елемената.
.tooltip('show')
Открива опис елемента. Враћа се позиваоцу пре него што је опис алатке заиста приказан (тј. пре него што се shown.bs.tooltip
догађај деси). Ово се сматра „ручним“ покретањем описа алата. Објашњења са насловима нулте дужине се никада не приказују.
.tooltip('hide')
Сакрива опис елемента. Враћа се позиваоцу пре него што је опис алата заправо сакривен (тј. пре него што се hidden.bs.tooltip
догађај деси). Ово се сматра „ручним“ покретањем описа алата.
.tooltip('toggle')
Укључује опис елемента. Враћа се позиваоцу пре него што је опис алатке заправо приказан или сакривен (тј. пре него што се деси догађај shown.bs.tooltip
или ). hidden.bs.tooltip
Ово се сматра „ручним“ покретањем описа алата.
.tooltip('dispose')
Сакрива и уништава опис елемента. Објашњење које користи делегирање (које се креира помоћу опције selector
) не може се појединачно уништити на елементима окидача потомака.
.tooltip('enable')
Даје могућност приказа алатке елемента. Објашњења су подразумевано омогућена.
.tooltip('disable')
Уклања могућност приказа описа елемента. Објашњење ће моћи да се прикаже само ако је поново омогућено.
.tooltip('toggleEnabled')
Укључује могућност приказивања или сакривања описа елемента.
.tooltip('update')
Ажурира позицију описа елемента.
Догађаји
Тип догађаја | Опис |
---|---|
схов.бс.тоолтип | Овај догађај се покреће одмах када show се позове метод инстанце. |
приказано.бс.опис | Овај догађај се покреће када опис алата постане видљив кориснику (сачекаће да се ЦСС транзиције доврше). |
хиде.бс.тоолтип | Овај догађај се покреће одмах када hide се позове метод инстанце. |
хидден.бс.тоолтип | Овај догађај се покреће када је опис алатке завршен са сакривањем од корисника (сачекаће да се ЦСС транзиције доврше). |
инсертед.бс.тоолтип | Овај догађај се покреће након show.bs.tooltip догађаја када је шаблон објашњења додат у ДОМ. |