JavaScript

Atgaivinkite „Bootstrap“ naudodami pasirenkamus „JavaScript“ papildinius, sukurtus „jQuery“. Sužinokite apie kiekvieną papildinį, mūsų duomenų ir programinės API parinktis ir dar daugiau.

Individualus arba sudarytas

Papildiniai gali būti įtraukti atskirai (naudojant Bootstrap individualų js/dist/*.js) arba visus iš karto, naudojant bootstrap.jsarba sumažintą bootstrap.min.js(neįtraukti abiejų).

Jei naudojate rinktuvą (Webpack, Rollup…), galite naudoti /js/dist/*.jsUMD paruoštus failus.

Priklausomybės

Kai kurie papildiniai ir CSS komponentai priklauso nuo kitų papildinių. Jei įskiepius įtraukiate atskirai, būtinai patikrinkite, ar dokumentuose nėra šių priklausomybių. Taip pat atminkite, kad visi papildiniai priklauso nuo jQuery (tai reiškia, kad jQuery turi būti įtrauktas prieš papildinio failus). Norėdami sužinoti, kurios jQuery versijos palaikomos, kreipkitės į mus .package.json

Mūsų išskleidžiamieji meniu, iššokantys langai ir patarimai taip pat priklauso nuo Popper.js .

Duomenų atributai

Beveik visus „Bootstrap“ papildinius galima įjungti ir konfigūruoti naudojant tik HTML su duomenų atributais (mūsų pageidaujamas „JavaScript“ funkcijos naudojimo būdas). Įsitikinkite, kad viename elemente naudojate tik vieną duomenų atributų rinkinį (pvz., negalite suaktyvinti patarimo ir modalo iš to paties mygtuko).

Tačiau kai kuriais atvejais gali būti pageidautina išjungti šią funkciją. Norėdami išjungti duomenų atributo API, atjunkite visus įvykius dokumente, kurių vardų sritis yra data-apitokia:

$(document).off('.data-api')

Arba, jei norite taikyti konkretų papildinį, tiesiog įtraukite papildinio pavadinimą kaip vardų erdvę kartu su data-api vardų erdve, pvz.:

$(document).off('.alert.data-api')

Renginiai

„Bootstrap“ teikia tinkintus įvykius daugumos unikalių papildinių veiksmams. Paprastai jie būna įnagininko ir būtojo laiko formos – kai įnagininkas (pvz. show, ) suaktyvinamas įvykio pradžioje, o jo būtojo laiko forma (pvz. shown, ) – baigus veiksmą.

Visi begaliniai įvykiai suteikia preventDefault()funkcionalumo. Tai suteikia galimybę sustabdyti veiksmo vykdymą prieš jam pradedant. Grąžinus false iš įvykių tvarkyklės taip pat bus automatiškai iškviesta preventDefault().

$('#myModal').on('show.bs.modal', function (event) {
  if (!data) {
    return event.preventDefault() // stops modal from being shown
  }
})

Programinė API

Taip pat manome, kad turėtumėte turėti galimybę naudoti visus „Bootstrap“ papildinius tik per „JavaScript“ API. Visos viešosios API yra pavieniai, grandininiai metodai ir grąžina rinkinį, pagal kurį buvo imtasi veiksmų.

$('.btn.danger').button('toggle').addClass('fat')

Visi metodai turi priimti pasirenkamų parinkčių objektą, eilutę, kuri taikoma tam tikram metodui, arba nieko (kuris inicijuoja papildinį su numatytuoju elgesiu):

$('#myModal').modal() // initialized with defaults
$('#myModal').modal({ keyboard: false }) // initialized with no keyboard
$('#myModal').modal('show') // initializes and invokes show immediately

Kiekvienas papildinys taip pat atskleidžia savo neapdorotą konstruktorių Constructornuosavybėje: $.fn.popover.Constructor. Jei norite gauti konkretų papildinio egzempliorių, gaukite jį tiesiai iš elemento: $('[rel="popover"]').data('popover').

Asinchroninės funkcijos ir perėjimai

Visi programiniai API metodai yra asinchroniniai ir grįžta į skambinantįjį, kai tik pradedamas perėjimas, bet jam nepasibaigus .

Norėdami atlikti veiksmą, kai perėjimas bus baigtas, galite klausytis atitinkamo įvykio.

$('#myCollapse').on('shown.bs.collapse', function (event) {
  // Action to execute once the collapsible area is expanded
})

Be to, pereinamojo komponento metodo iškvietimas bus ignoruojamas .

$('#myCarousel').on('slid.bs.carousel', function (event) {
  $('#myCarousel').carousel('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished
})

$('#myCarousel').carousel('1') // Will start sliding to the slide 1 and returns to the caller
$('#myCarousel').carousel('2') // !! Will be ignored, as the transition to the slide 1 is not finished !!

Numatytieji nustatymai

Galite pakeisti numatytuosius papildinio nustatymus pakeisdami papildinio Constructor.Defaultobjektą:

// changes default for the modal plugin's `keyboard` option to false
$.fn.modal.Constructor.Default.keyboard = false

Jokio konflikto

Kartais reikia naudoti Bootstrap papildinius su kitomis vartotojo sąsajos sistemomis. Tokiomis aplinkybėmis kartais gali įvykti vardų erdvės susidūrimai. Jei taip atsitiks, galite iškviesti .noConflictpapildinį, kurio vertę norite grąžinti.

var bootstrapButton = $.fn.button.noConflict() // return $.fn.button to previously assigned value
$.fn.bootstrapBtn = bootstrapButton // give $().bootstrapBtn the Bootstrap functionality

Versijų numeriai

Kiekvieno „Bootstrap“ „jQuery“ įskiepio versiją galima pasiekti naudojant VERSIONpapildinio konstruktoriaus ypatybę. Pavyzdžiui, patarimo įskiepiui:

$.fn.tooltip.Constructor.VERSION // => "4.6.2"

Jokių specialių atsarginių priemonių, kai „JavaScript“ išjungta

Kai „JavaScript“ išjungta, „Bootstrap“ įskiepiai neatsiranda ypač gražiai. Jei jums rūpi naudotojo patirtis šiuo atveju, naudokite <noscript>, kad paaiškintumėte situaciją (ir kaip iš naujo įgalinti „JavaScript“) savo vartotojams ir (arba) pridėkite savo pasirinktinių atsarginių variantų.

Util

Visi „Bootstrap“ „JavaScript“ failai priklauso nuo util.jsir jie turi būti įtraukti kartu su kitais „JavaScript“ failais. Jei naudojate kompiliuotą (arba sumažintą) bootstrap.js, nereikia to įtraukti – jis jau yra.

util.jsapima naudingumo funkcijas ir pagrindinį transitionEndįvykių pagalbininką, taip pat CSS perėjimo emuliatorių. Jį naudoja kiti įskiepiai, norėdami patikrinti, ar yra CSS perėjimo palaikymas, ir užfiksuoti kabančius perėjimus.

Dezinfekavimo priemonė

Patarimai ir popovers naudoja mūsų integruotą dezinfekavimo priemonę, kad išvalytų parinktis, kurios priima HTML.

Numatytoji whiteListreikšmė yra tokia:

var ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
var DefaultWhitelist = {
  // Global attributes allowed on any supplied element below.
  '*': ['class', 'dir', 'id', 'lang', 'role', ARIA_ATTRIBUTE_PATTERN],
  a: ['target', 'href', 'title', 'rel'],
  area: [],
  b: [],
  br: [],
  col: [],
  code: [],
  div: [],
  em: [],
  hr: [],
  h1: [],
  h2: [],
  h3: [],
  h4: [],
  h5: [],
  h6: [],
  i: [],
  img: ['src', 'srcset', 'alt', 'title', 'width', 'height'],
  li: [],
  ol: [],
  p: [],
  pre: [],
  s: [],
  small: [],
  span: [],
  sub: [],
  sup: [],
  strong: [],
  u: [],
  ul: []
}

Jei prie šios numatytosios vertės norite pridėti naujų reikšmių, whiteListgalite atlikti šiuos veiksmus:

var myDefaultWhiteList = $.fn.tooltip.Constructor.Default.whiteList

// To allow table elements
myDefaultWhiteList.table = []

// To allow td elements and data-option attributes on td elements
myDefaultWhiteList.td = ['data-option']

// You can push your custom regex to validate your attributes.
// Be careful about your regular expressions being too lax
var myCustomRegex = /^data-my-app-[\w-]+/
myDefaultWhiteList['*'].push(myCustomRegex)

Jei norite apeiti mūsų dezinfekavimo priemonę, nes norite naudoti tam skirtą biblioteką, pvz. , DOMpurify , turėtumėte atlikti šiuos veiksmus:

$('#yourTooltip').tooltip({
  sanitizeFn: function (content) {
    return DOMPurify.sanitize(content)
  }
})