Alati
Dokumentacija i primjeri za dodavanje prilagođenih Bootstrap opisa alata sa CSS-om i JavaScript-om koristeći CSS3 za animacije i atribute podataka za lokalno skladištenje naslova.
Pregled
Stvari koje trebate znati kada koristite dodatak za opis alata:
- Alati se oslanjaju na biblioteku treće strane Popper.js za pozicioniranje. Morate uključiti popper.min.js prije bootstrap.js ili koristiti
bootstrap.bundle.min.js
/bootstrap.bundle.js
koji sadrži Popper.js da bi opisi radili! - Ako gradite naš JavaScript iz izvora, on zahtijeva
util.js
. - Alati su uključeni iz razloga performansi, tako da ih morate sami inicijalizirati .
- Alati sa naslovima nulte dužine se nikada ne prikazuju.
- Navedite
container: 'body'
kako biste izbjegli probleme s prikazivanjem u složenijim komponentama (kao što su naše grupe za unos, grupe dugmadi, itd.). - Aktiviranje opisa alata na skrivenim elementima neće raditi.
- Oznake za
.disabled
ilidisabled
elemente moraju se pokrenuti na elementu omotača. - Kada se aktiviraju od hiperveza koje se protežu na više redova, opisi alata će biti centrirani. Koristite
white-space: nowrap;
na vašem<a>
s da biste izbjegli ovo ponašanje. - Alati moraju biti skriveni prije nego što se njihovi odgovarajući elementi uklone iz DOM-a.
- Alati se mogu pokrenuti zahvaljujući elementu unutar DOM-a u sjeni.
Efekt animacije ove komponente ovisi o prefers-reduced-motion
medijskom upitu. Pogledajte odjeljak o smanjenom pokretu u našoj dokumentaciji o pristupačnosti .
Imaš sve to? Sjajno, da vidimo kako rade na nekim primjerima.
Primjer: Omogućite opise svuda
Jedan od načina da se inicijaliziraju svi opisi alata na stranici bio bi da ih odaberete prema njihovom data-toggle
atributu:
Primjeri
Zadržite pokazivač miša preko linkova ispod da vidite opise alata:
Uske pantalone sledećeg nivoa kefije za koje verovatno niste čuli. Foto štand za bradu od sirovog trapera za visoku štampu veganske torbe za glasnike stumptown. Seitan od farme do stola, mcsweeney's fixie održiva 8-bitna američka odjeća od kvinoje ima vinil chambray od terry richardsona. Brada stumptown, kardigani banh mi lomo thundercats. Tofu biodizel williamsburg marfa, četiri loko mcsweeney's cleanse veganski chambray. Zaista ironičan majstor bez obzira na keytar , scenester od farme do stola Banksy Austin twitter obrađuje freegan cred sirovi traper izvorne kave jednog porijekla.
Zadržite pokazivač iznad dugmadi ispod da vidite četiri smjera opisa alata: gore, desno, dolje i lijevo.
I sa dodatkom prilagođenog HTML-a:
Upotreba
Dodatak za opis alata generira sadržaj i oznake na zahtjev, a prema zadanim postavkama postavlja opise alata nakon njihovog elementa okidača.
Aktivirajte opis alata putem JavaScripta:
Overflow auto
andscroll
Položaj opisa alata pokušava se automatski promijeniti kada roditeljski kontejner ima overflow: auto
ili overflow: scroll
kao naš .table-responsive
, ali i dalje zadržava pozicioniranje originalnog položaja. Da biste to riješili, postavite boundary
opciju na bilo što osim zadane vrijednosti, 'scrollParent'
kao što je 'window'
:
Markup
Potrebna oznaka za opis alata je samo data
atribut i title
na HTML elementu želite da imate opis alata. Generirana oznaka opisa alata je prilično jednostavna, iako zahtijeva poziciju (podrazumevano, postavljena na top
dodatak).
Omogućavanje rada savjeta za korisnike tipkovnice i pomoćne tehnologije
Trebali biste dodati samo opise alata HTML elementima koji su tradicionalno fokusirani na tastaturu i interaktivni (kao što su veze ili kontrole obrasca). Iako se proizvoljni HTML elementi (kao što je <span>
s) mogu fokusirati dodavanjem tabindex="0"
atributa, ovo će dodati potencijalno dosadne i zbunjujuće tab stope na neinteraktivnim elementima za korisnike tastature, a većina pomoćnih tehnologija trenutno ne najavljuje opis alata u ovoj situaciji. Osim toga, nemojte se oslanjati samo na hover
okidač za svoj opis alata, jer će to učiniti da vaše opise alata nije moguće pokrenuti korisnicima tipkovnice.
Onemogućeni elementi
Elementi sa disabled
atributom nisu interaktivni, što znači da korisnici ne mogu da se fokusiraju, lebde ili kliknu na njih da bi pokrenuli opis alata (ili skočni prozor). Kao zaobilazno rješenje, željet ćete pokrenuti opis alata iz omotača <div>
ili <span>
, idealno napravljenog za fokusiranje na tastaturi pomoću tabindex="0"
, i nadjačati pointer-events
on disabled element.
Opcije
Opcije se mogu proslijediti putem atributa podataka ili JavaScript-a. Za atribute podataka dodajte naziv opcije u data-
, kao u data-animation=""
.
Imajte na umu da se iz sigurnosnih razloga opcije sanitize
i ne mogu dostaviti korištenjem atributa podataka.sanitizeFn
whiteList
Ime | Tip | Default | Opis |
---|---|---|---|
animacija | boolean | tačno | Primijenite CSS fade prijelaz na opis alata |
kontejner | string | element | false | false | Dodaje opis alata određenom elementu. Primjer: |
kašnjenje | broj | objekt | 0 | Odgoda prikazivanja i skrivanja opisa alata (ms) - ne odnosi se na tip ručnog okidača Ako je naveden broj, kašnjenje se primjenjuje i na sakrivanje/prikaži Struktura objekta je: |
html | boolean | false | Dozvolite HTML u opisu alata. Ako je tačno, HTML oznake u opisu alata Koristite tekst ako ste zabrinuti zbog XSS napada. |
plasman | string | funkcija | 'vrh' | Kako pozicionirati tooltip - auto | vrh | dno | lijevo | u pravu. Kada se funkcija koristi za određivanje položaja, ona se poziva sa DOM čvorom sa opisom alata kao prvim argumentom i pokretačkim elementom DOM čvorom kao drugim. Kontekst |
selektor | string | false | false | Ako je osiguran selektor, objekti opisa alata će biti delegirani navedenim ciljevima. U praksi, ovo se takođe koristi za primenu alata na dinamički dodane DOM elemente ( jQuery.on podrška). Pogledajte ovo i informativni primjer . |
šablon | string | '<div class="tooltip" role="tooltip"><div class="arrow"></div><div class="tooltip-inner"></div></div>' |
Osnovni HTML za korištenje prilikom kreiranja opisa alata. Opis alata
Najudaljeniji element omotača trebao bi imati |
naslov | string | element | funkcija | '' | Zadana vrijednost naslova ako Ako je data funkcija, ona će biti pozvana sa svojom |
okidač | string | 'hover fokus' | Kako se pokreće opis alata - kliknite | lebdjeti | fokus | priručnik. Možete proslijediti više okidača; odvojite ih razmakom.
|
offset | broj | string | funkcija | 0 | Pomak opisa alata u odnosu na cilj. Kada se funkcija koristi za određivanje pomaka, ona se poziva s objektom koji sadrži podatke o pomaku kao prvi argument. Funkcija mora vratiti objekt sa istom strukturom. Okidač elementa DOM čvor se prosljeđuje kao drugi argument. Za više informacija pogledajte offset dokumente Popper.js . |
backbackPlacement | string | niz | 'okreni' | Dozvolite da odredite koju će poziciju Popper koristiti na rezervnom. Za više informacija pogledajte dokumente o ponašanju Popper.js |
granica | string | element | 'scrollParent' | Granica ograničenja preljeva opisa alata. Prihvata vrijednosti 'viewport' , 'window' , 'scrollParent' , ili reference HTMLElementa (samo JavaScript). Za više informacija pogledajte PrevenOverflow dokumente Popper.js . |
sanirati | boolean | tačno | Omogućite ili onemogućite dezinfekciju. Ako se aktivira 'template' i 'title' opcije će biti sanirane. |
whiteList | objekt | Zadana vrijednost | Objekt koji sadrži dozvoljene atribute i oznake |
sanitizeFn | null | funkcija | null | Ovdje možete ponuditi vlastitu funkciju dezinfekcije. Ovo može biti korisno ako više volite koristiti namjensku biblioteku za dezinfekciju. |
popperConfig | null | objekt | null | Da biste promijenili Bootstrap-ovu zadanu Popper.js konfiguraciju, pogledajte konfiguraciju Popper.js-a |
Atributi podataka za pojedinačne opise alata
Opcije za pojedinačne opise alata mogu se alternativno specificirati korištenjem atributa podataka, kao što je gore objašnjeno.
Metode
Asinhrone metode i prijelazi
Sve API metode su asinhrone i pokreću tranziciju . Oni se vraćaju pozivaocu čim prijelaz započne, ali prije nego što se završi . Osim toga, poziv metode na prelaznu komponentu će biti zanemaren .
Pogledajte našu JavaScript dokumentaciju za više informacija .
$().tooltip(options)
Prilaže rukovao opisom alata kolekciji elemenata.
.tooltip('show')
Otkriva opis elementa. Vraća se pozivaocu prije nego što je opis alata zapravo prikazan (tj. prije nego što se shown.bs.tooltip
događaj dogodi). Ovo se smatra "ručnim" pokretanjem opisa alata. Alati sa naslovima nulte dužine se nikada ne prikazuju.
.tooltip('hide')
Sakriva opis elementa. Vraća se pozivaocu prije nego što je opis alata zapravo skriven (tj. prije nego što se hidden.bs.tooltip
događaj dogodi). Ovo se smatra "ručnim" pokretanjem opisa alata.
.tooltip('toggle')
Prebacuje opis elementa. Vraća se pozivaocu prije nego što je opis alata zapravo prikazan ili skriven (tj. prije nego što se dogodi događaj shown.bs.tooltip
ili ). hidden.bs.tooltip
Ovo se smatra "ručnim" pokretanjem opisa alata.
.tooltip('dispose')
Sakriva i uništava opis elementa. Oznake alata koje koriste delegiranje (koje su kreirane pomoću opcije selector
) ne mogu se pojedinačno uništiti na elementima okidača potomaka.
.tooltip('enable')
Daje mogućnost prikaza alata elementa. Objašnjenja su podrazumevano omogućena.
.tooltip('disable')
Uklanja mogućnost prikaza alata za element. Alat će se moći prikazati samo ako je ponovo omogućen.
.tooltip('toggleEnabled')
Uključuje mogućnost prikaza ili sakrivanja opisa elementa.
.tooltip('update')
Ažurira poziciju opisa elementa.
Događaji
Vrsta događaja | Opis |
---|---|
show.bs.tooltip | Ovaj događaj se aktivira odmah kada show se pozove metoda instance. |
prikazano.bs.opis | Ovaj događaj se pokreće kada je opis alata vidljiv korisniku (sačekaće da se CSS tranzicije dovrše). |
hide.bs.tooltip | Ovaj događaj se pokreće odmah kada se hide pozove metoda instance. |
hidden.bs.tooltip | Ovaj događaj se pokreće kada je opis alata završen sa sakrivanjem od korisnika (će čekati da se CSS prijelazi dovrše). |
inserted.bs.tooltip | Ovaj događaj se pokreće nakon show.bs.tooltip događaja kada je predložak opisa alata dodan u DOM. |