JavaScript

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.

Bootstrap naudojimas kaip modulis

Pateikiame „Bootstrap“ versiją, sukurtą kaip ESM( bootstrap.esm.jsir bootstrap.esm.min.js), kuri leidžia naudoti „Bootstrap“ kaip naršyklės modulį, jei jūsų tikslinės naršyklės tai palaiko .

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

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

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

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

Vis dar norite naudoti „jQuery“? Tai įmanoma!

„Bootstrap 5“ sukurta naudoti be „jQuery“, tačiau vis tiek galima naudoti mūsų komponentus su „jQuery“. Jei „Bootstrap “ aptinka objektejQuerywindow , jis įtrauks visus mūsų komponentus į „jQuery“ papildinių sistemą; tai reiškia, kad galėsite $('[data-bs-toggle="tooltip"]').tooltip()įgalinti patarimus. Tas pats pasakytina ir apie kitus mūsų komponentus.

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

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

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

Programinė API

Visi konstruktoriai priima pasirenkamų parinkčių objektą arba nieko (kuris inicijuoja papildinį pagal numatytąją elgseną):

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

Jei norite gauti konkretų papildinio egzempliorių, kiekvienas papildinys atskleidžia getInstancemetodą. Norėdami jį gauti tiesiai iš elemento, atlikite šiuos veiksmus: bootstrap.Popover.getInstance(myPopoverEl).

CSS selektoriai konstruktoriuose

Taip pat galite naudoti CSS parinkiklį kaip pirmąjį argumentą, o ne DOM elementą, kad inicijuotų papildinį. Šiuo metu papildinio elementas randamas querySelectormetodu, nes mūsų papildiniai palaiko tik vieną elementą.

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

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.

var myCollapseEl = document.getElementById('myCollapse')

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

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

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 !!

Numatytieji nustatymai

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

// changes default for the modal plugin's `keyboard` option to false
bootstrap.Modal.Default.keyboard = false

Nėra konflikto (tik jei naudojate jQuery)

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“ įskiepio versiją galima pasiekti per VERSIONpapildinio konstruktoriaus nuosavybę. Pavyzdžiui, patarimo įskiepiui:

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

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

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

Dezinfekavimo priemonė

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

Numatytoji allowListreikšmė yra tokia:

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: []
}

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

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)

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

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