JavaScript

Herätä Bootstrap henkiin valinnaisilla jQueryyn rakennetuilla JavaScript-laajennuksillamme. Lisätietoja kustakin laajennuksesta, data- ja ohjelmallisista sovellusliittymävaihtoehdoistamme ja paljon muuta.

Yksittäinen tai koottu

Laajennukset voidaan sisällyttää yksitellen (käyttäen Bootstrapin yksittäistä js/dist/*.js) tai kaikki kerralla käyttämällä bootstrap.jstai minimoitua bootstrap.min.js(älä sisällytä molempia).

Jos käytät niputtajaa (Webpack, Rollup…), voit käyttää /js/dist/*.jsUMD-valmiita tiedostoja.

Riippuvuudet

Jotkut laajennukset ja CSS-komponentit ovat riippuvaisia ​​muista laajennuksista. Jos lisäät laajennuksia yksitellen, varmista, että tarkistat nämä riippuvuudet asiakirjoista. Huomaa myös, että kaikki laajennukset riippuvat jQuerysta (tämä tarkoittaa, että jQuery on sisällytettävä ennen laajennustiedostoja). Ota yhteyttäpackage.json saadaksesi selville, mitä jQuery-versioita tuetaan.

Pudotusvalikot, ponnahdusikkunat ja työkaluvinkkimme riippuvat myös Popper.js :stä .

Tietojen attribuutit

Lähes kaikki Bootstrap-laajennukset voidaan ottaa käyttöön ja määrittää pelkän HTML:n kautta dataattribuuttien kanssa (suosittu tapamme käyttää JavaScript-toimintoa). Varmista, että käytät vain yhtä tietomääritejoukkoa yhdessä elementissä (esim. et voi käynnistää työkaluvihjettä ja modaalia samasta painikkeesta).

Joissakin tilanteissa voi kuitenkin olla toivottavaa poistaa tämä toiminto käytöstä. Poista dataattribuutin API käytöstä poistamalla kaikki asiakirjan tapahtumat, joiden nimiväli on seuraava data-api:

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

Vaihtoehtoisesti voit kohdistaa tiettyyn laajennukseen lisäämällä vain laajennuksen nimen nimiavaruudeksi data-api-nimiavaruuden ohella seuraavasti:

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

Tapahtumat

Bootstrap tarjoaa mukautettuja tapahtumia useimpien laajennusten ainutlaatuisia toimintoja varten. Yleensä nämä tulevat infinitiivi- ja menneisyyden partisiipin muodossa - missä infinitiivi (esim. show) laukeaa tapahtuman alussa ja sen mennyt partisiippimuoto (esim. shown) käynnistetään toiminnon päätyttyä.

Kaikki infinitiiviset tapahtumat tarjoavat preventDefault()toimivuutta. Tämä tarjoaa mahdollisuuden pysäyttää toiminnon suorittaminen ennen sen alkamista. False palauttaminen tapahtumakäsittelijältä kutsuu myös automaattisesti preventDefault().

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

Ohjelmallinen sovellusliittymä

Uskomme myös, että sinun pitäisi pystyä käyttämään kaikkia Bootstrap-laajennuksia puhtaasti JavaScript-sovellusliittymän kautta. Kaikki julkiset sovellusliittymät ovat yksittäisiä, ketjutettavia menetelmiä, ja ne palauttavat kokoelman toimineen.

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

Kaikkien menetelmien tulee hyväksyä valinnainen optioobjekti, tiettyyn menetelmään kohdistettu merkkijono tai ei mitään (joka käynnistää laajennuksen oletuskäyttäytymisellä):

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

Jokainen laajennus paljastaa myös raakakonstruktorinsa Constructorominaisuudessa: $.fn.popover.Constructor. Jos haluat saada tietyn laajennuksen ilmentymän, nouta se suoraan elementistä: $('[rel="popover"]').data('popover').

Asynkroniset toiminnot ja siirtymät

Kaikki ohjelmoidut API - menetelmät ovat asynkronisia ja palaavat soittajalle siirron alkaessa , mutta ennen sen päättymistä .

Jos haluat suorittaa toiminnon siirron jälkeen, voit kuunnella vastaavaa tapahtumaa.

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

Lisäksi siirtyvän komponentin menetelmäkutsu jätetään huomioimatta .

$('#myCarousel').on('slid.bs.carousel', function (e) {
  $('#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 !!

Oletusasetukset

Voit muuttaa laajennuksen oletusasetuksia muokkaamalla laajennuksen Constructor.Defaultobjektia:

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

Ei konfliktia

Joskus on tarpeen käyttää Bootstrap-laajennuksia muiden käyttöliittymäkehysten kanssa. Näissä olosuhteissa nimitilan törmäyksiä voi toisinaan tapahtua. Jos näin tapahtuu, voit kutsua .noConflictlaajennusta, jonka arvon haluat palauttaa.

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

Versionumerot

Jokaisen Bootstrapin jQuery-laajennuksen versiota voi käyttää VERSIONlaajennuksen rakentajan ominaisuuden kautta. Esimerkiksi työkaluvihje-laajennus:

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

Ei erityisiä varatoimia, kun JavaScript on poistettu käytöstä

Bootstrapin lisäosat eivät palaa erityisen kauniisti, kun JavaScript on poistettu käytöstä. Jos välität käyttökokemuksesta tässä tapauksessa, käytä <noscript>kuvaamaan tilanteen (ja JavaScriptin ottamiseksi uudelleen käyttöön) käyttäjillesi ja/tai lisäämään omia mukautettuja varavaihtoehtoja.

Util

Kaikki Bootstrapin JavaScript-tiedostot riippuvat util.jsja se on sisällytettävä muiden JavaScript-tiedostojen rinnalle. Jos käytät käännettyä (tai minimoitua) bootstrap.js, tätä ei tarvitse sisällyttää - se on jo olemassa.

util.jssisältää aputoiminnot ja perusapuohjelman transitionEndtapahtumille sekä CSS-siirtymäemulaattorin. Muut laajennukset käyttävät sitä CSS-siirtymän tuen tarkistamiseen ja riippuvien siirtymien kiinnittämiseen.

Desinfiointiaine

Työkaluvihjeet ja ponnahdusikkunat käyttävät sisäänrakennettua desinfiointiohjelmaamme HTML:n hyväksyvien vaihtoehtojen puhdistamiseen.

Oletusarvo whiteListon seuraava:

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', 'alt', 'title', 'width', 'height'],
  li: [],
  ol: [],
  p: [],
  pre: [],
  s: [],
  small: [],
  span: [],
  sub: [],
  sup: [],
  strong: [],
  u: [],
  ul: []
}

Jos haluat lisätä uusia arvoja tähän oletusarvoon whiteList, voit tehdä seuraavasti:

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)

Jos haluat ohittaa desinfiointituotteemme, koska käytät mieluummin erityistä kirjastoa, esimerkiksi DOMPurify , sinun tulee toimia seuraavasti:

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