JavaScript

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.

Bootstrapin käyttö moduulina

Tarjoamme Bootstrap-version, joka on rakennettu muodossa ESM( bootstrap.esm.jsja bootstrap.esm.min.js), jonka avulla voit käyttää Bootstrapia selaimesi moduulina, jos kohdeselaimesi tukevat sitä .

<script type="module">
  import { Toast } from 'bootstrap.esm.min.js'

  Array.from(document.querySelectorAll('.toast'))
    .forEach(toastNode => new Toast(toastNode))
</script>

Riippuvuudet

Jotkut laajennukset ja CSS-komponentit ovat riippuvaisia ​​muista laajennuksista. Jos lisäät laajennuksia yksitellen, varmista, että tarkistat nämä riippuvuudet asiakirjoista.

Pudotusvalikot, ponnahdusikkunat ja työkaluvinkkimme riippuvat myös Popperista .

Haluatko silti käyttää jQueryä? Se on mahdollista!

Bootstrap 5 on suunniteltu käytettäväksi ilman jQuerya, mutta komponenttejamme voi silti käyttää jQueryn kanssa. Jos Bootstrap havaitsee jQueryobjektissa window, se lisää kaikki osamme jQueryn laajennusjärjestelmään; Tämä tarkoittaa, että voit $('[data-bs-toggle="tooltip"]').tooltip()ottaa työkaluvihjeet käyttöön. Sama koskee muitakin komponenttejamme.

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).

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().

var myModal = document.getElementById('myModal')

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

$('#myTab a').on('shown.bs.tab', function () {
  // do something...
})

Ohjelmallinen sovellusliittymä

Kaikki rakentajat hyväksyvät valinnaisen optioobjektin tai ei mitään (joka käynnistää laajennuksen oletuskäyttäytymisellään):

var myModalEl = document.getElementById('myModal')

var modal = new bootstrap.Modal(myModalEl) // initialized with defaults
var modal = new bootstrap.Modal(myModalEl, { keyboard: false }) // initialized with no keyboard

Jos haluat saada tietyn laajennuksen esiintymän, jokainen laajennus paljastaa getInstancemenetelmän. Voit hakea sen suoraan elementistä seuraavasti: bootstrap.Popover.getInstance(myPopoverEl).

CSS-valitsimet konstruktoreissa

Voit myös käyttää CSS-valitsinta ensimmäisenä argumenttina DOM-elementin sijasta laajennuksen alustamiseksi. Tällä hetkellä laajennuksen elementti löydetään querySelectormenetelmällä, koska laajennukset tukevat vain yhtä elementtiä.

var modal = new bootstrap.Modal('#myModal')
var dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')

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.

var myCollapseEl = document.getElementById('myCollapse')

myCollapseEl.addEventListener('shown.bs.collapse', function (event) {
  // Action to execute once the collapsible area is expanded
})

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

var myCarouselEl = document.getElementById('myCarousel')
var carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance

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

carousel.to('1') // Will start sliding to the slide 1 and returns to the caller
carousel.to('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
bootstrap.Modal.Default.keyboard = false

Ei ristiriitaa (vain jos käytät jQueryä)

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 lisäosan versiota voi käyttää VERSIONlaajennuksen rakentajan ominaisuuden kautta. Esimerkiksi työkaluvihje-laajennus:

bootstrap.Tooltip.VERSION // => "5.1.3"

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.

Desinfiointiaine

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

Oletusarvo allowListon seuraava:

var ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
var DefaultAllowlist = {
  // 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: []
}

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

var myDefaultAllowList = bootstrap.Tooltip.Default.allowList

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

// To allow td elements and data-bs-option attributes on td elements
myDefaultAllowList.td = ['data-bs-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-]+/
myDefaultAllowList['*'].push(myCustomRegex)

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

var yourTooltipEl = document.getElementById('yourTooltip')
var tooltip = new bootstrap.Tooltip(yourTooltipEl, {
  sanitizeFn: function (content) {
    return DOMPurify.sanitize(content)
  }
})