JavaScript

Individuaj aŭ kompilitaj

Kromaĵoj povas esti inkluzivitaj individue (uzante la individuan de Bootstrap js/dist/*.js), aŭ ĉiuj samtempe uzante bootstrap.jsaŭ la minigitajn bootstrap.min.js(ne inkluzivas ambaŭ).

Se vi uzas pakaĵon (Webpack, Rollup...), vi povas uzi /js/dist/*.jsdosierojn kiuj estas UMD pretaj.

Uzante Bootstrap kiel modulon

Ni provizas version de Bootstrap konstruita kiel ESM( bootstrap.esm.jskaj bootstrap.esm.min.js) kiu permesas vin uzi Bootstrap kiel modulon en via retumilo, se viaj celitaj retumiloj subtenas ĝin .

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

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

Dependecoj

Iuj aldonaĵoj kaj CSS-komponentoj dependas de aliaj aldonaĵoj. Se vi inkluzivas kromaĵojn individue, nepre kontroli ĉi tiujn dependecojn en la dokumentoj.

Niaj falmenuoj, popovers kaj konsiletoj ankaŭ dependas de Popper .

Ĉu ankoraŭ volas uzi jQuery? Ĝi estas ebla!

Bootstrap 5 estas desegnita por esti uzata sen jQuery, sed ankoraŭ eblas uzi niajn komponantojn kun jQuery. Se Bootstrap detektas jQueryen la windowobjekto ĝi aldonos ĉiujn niajn komponantojn en la kromprogramon de jQuery; ĉi tio signifas, ke vi povos fari $('[data-bs-toggle="tooltip"]').tooltip()por ebligi konsiletojn. La sama validas por niaj aliaj komponantoj.

Datumaj atributoj

Preskaŭ ĉiuj Bootstrap-kromaĵoj povas esti ebligitaj kaj agorditaj per HTML sole kun datumaj atributoj (nia preferata maniero uzi JavaScript-funkciecon). Nepre uzu nur unu aron da datumaj atributoj sur ununura elemento (ekz., vi ne povas ekigi konsileton kaj modalon de la sama butono.)

Eventoj

Bootstrap provizas kutimajn eventojn por la unikaj agoj de la plej multaj kromprogramoj. Ĝenerale, tiuj venas en infinitiva kaj preterito participo - kie la infinitivo (ekz. show) estas ekigita ĉe la komenco de okazaĵo, kaj ĝia preterito participformo (ekz. shown) estas ekigita sur la kompletigo de ago.

Ĉiuj infinitivaj eventoj disponigas preventDefault()funkciecon. Ĉi tio disponigas la kapablon ĉesigi la ekzekuton de ago antaŭ ol ĝi komenciĝas. Reveno de malvera de evento-traktilo ankaŭ aŭtomate vokos 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...
})

Programa API

Ĉiuj konstrukciistoj akceptas laŭvolan opcian objekton aŭ nenion (kiu iniciatas kromprogramon kun sia defaŭlta konduto):

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

Se vi ŝatus akiri apartan kromprogramon, ĉiu kromaĵo elmontras getInstancemetodon. Por preni ĝin rekte de elemento, faru ĉi tion: bootstrap.Popover.getInstance(myPopoverEl).

CSS-elektiloj en konstrukciistoj

Vi ankaŭ povas uzi CSS-elektilon kiel la unuan argumenton anstataŭ DOM-elemento por pravalorigi la kromprogramon. Nuntempe la elemento por la kromaĵo troviĝas per la querySelectormetodo ĉar niaj kromprogramoj subtenas nur unu elementon.

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

Nesinkronaj funkcioj kaj transiroj

Ĉiuj programaj API-metodoj estas nesinkronaj kaj revenas al la alvokanto post kiam la transiro estas komencita sed antaŭ ol ĝi finiĝas .

Por efektivigi agon post kiam la transiro estas finita, vi povas aŭskulti la respondan eventon.

var myCollapseEl = document.getElementById('myCollapse')

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

Krome metodovoko sur transira komponanto estos ignorita .

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

Defaŭltaj agordoj

Vi povas ŝanĝi la defaŭltajn agordojn por kromaĵo modifante la Constructor.Defaultobjekton de la kromaĵo:

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

Neniu konflikto (nur se vi uzas jQuery)

Kelkfoje necesas uzi Bootstrap-kromaĵojn kun aliaj UI-kadroj. En tiuj cirkonstancoj, nomspackolizioj povas foje okazi. Se tio okazas, vi povas alvoki .noConflictla kromprogramon, pri kiu vi volas reverti la valoron.

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

Versinumeroj

La versio de ĉiu el la kromprogramoj de Bootstrap estas alirebla per la VERSIONposedaĵo de la konstrukciisto de la kromaĵo. Ekzemple, por la konsileto-kromaĵo:

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

Neniuj specialaj kompensoj kiam JavaScript estas malŝaltita

La kromprogramoj de Bootstrap ne falas precipe gracie kiam JavaScript estas malŝaltita. Se vi zorgas pri la uzantsperto en ĉi tiu kazo, uzu <noscript>por klarigi la situacion (kaj kiel reebligi JavaScript) al viaj uzantoj, kaj/aŭ aldoni viajn proprajn laŭmendajn kompensojn.

Sanitizer

Konsiletoj kaj Popovers uzas nian enkonstruitan sanigilon por malpurigi opciojn kiuj akceptas HTML.

La defaŭlta allowListvaloro estas la sekva:

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

Se vi volas aldoni novajn valorojn al ĉi tiu defaŭlto allowList, vi povas fari la jenon:

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)

Se vi volas preteriri nian sanigilon ĉar vi preferas uzi dediĉitan bibliotekon, ekzemple DOMPurify , vi devus fari la jenon:

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