JavaScript

Individueel of saamgestel

Inproppe kan individueel ingesluit word (met Bootstrap se individuele js/dist/*.js), of alles op een slag met behulp van bootstrap.jsof die verkleinde bootstrap.min.js(sluit nie albei in nie).

As jy 'n bondler (Webpack, Rollup ...) gebruik, kan jy /js/dist/*.jslêers gebruik wat gereed is vir UMD.

Gebruik Bootstrap as 'n module

Ons verskaf 'n weergawe van Bootstrap gebou as ESM( bootstrap.esm.jsen bootstrap.esm.min.js) wat jou toelaat om Bootstrap as 'n module in jou blaaier te gebruik, as jou geteikende blaaiers dit ondersteun .

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

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

Afhanklikhede

Sommige inproppe en CSS-komponente is afhanklik van ander inproppe. As jy plugins individueel insluit, maak seker dat jy vir hierdie afhanklikhede in die dokumente kyk.

Ons dropdowns, popovers en tooltips is ook afhanklik van Popper .

Wil jy steeds jQuery gebruik? Dit is moontlik!

Bootstrap 5 is ontwerp om sonder jQuery gebruik te word, maar dit is steeds moontlik om ons komponente met jQuery te gebruik. As Bootstrap jQueryin die windowvoorwerp opspoor , sal dit al ons komponente in jQuery se inpropstelsel byvoeg; dit beteken dat jy in staat sal wees om $('[data-bs-toggle="tooltip"]').tooltip()gereedskapwenke te aktiveer. Dieselfde geld vir ons ander komponente.

Data eienskappe

Byna alle Bootstrap-inproppe kan deur HTML alleen geaktiveer en gekonfigureer word met data-kenmerke (ons voorkeur manier om JavaScript-funksionaliteit te gebruik). Maak seker dat jy net een stel data-kenmerke op 'n enkele element gebruik (bv. jy kan nie 'n nutswenk en modaal vanaf dieselfde knoppie aktiveer nie.)

Gebeurtenisse

Bootstrap bied pasgemaakte gebeurtenisse vir die meeste inproppe se unieke aksies. Oor die algemeen kom dit in 'n infinitief en verlede deelwoordvorm - waar die infinitief (bv. show) geaktiveer word aan die begin van 'n gebeurtenis, en sy verlede deelwoordvorm (bv. shown) geaktiveer word by die voltooiing van 'n aksie.

Alle infinitiewe gebeurtenisse bied preventDefault()funksionaliteit. Dit bied die vermoë om die uitvoering van 'n aksie te stop voordat dit begin. Om vals terug te gee vanaf 'n gebeurtenishanteerder sal ook outomaties oproep 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...
})

Programmatiese API

Alle konstrukteurs aanvaar 'n opsionele opsie-objek of niks (wat 'n inprop met sy verstekgedrag inisieer):

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

As jy 'n spesifieke inprop-instansie wil kry, stel elke inprop 'n getInstancemetode bloot. Om dit direk van 'n element af te haal, doen die volgende: bootstrap.Popover.getInstance(myPopoverEl).

CSS-keurders in konstrukteurs

Jy kan ook 'n CSS-kieser as die eerste argument gebruik in plaas van 'n DOM-element om die inprop te inisialiseer. Tans word die element vir die inprop deur die querySelectormetode gevind, aangesien ons inproppe slegs 'n enkele element ondersteun.

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

Asinchroniese funksies en oorgange

Alle programmatiese API-metodes is asynchronies en keer terug na die oproeper sodra die oorgang begin is, maar voordat dit eindig .

Om 'n aksie uit te voer sodra die oorgang voltooi is, kan jy na die ooreenstemmende gebeurtenis luister.

var myCollapseEl = document.getElementById('myCollapse')

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

Daarbenewens sal 'n metode-oproep op 'n oorgangskomponent geïgnoreer word .

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

Oorspronklike stellings

Jy kan die verstekinstellings vir 'n inprop verander deur die inprop se Constructor.Defaultvoorwerp te wysig:

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

Geen konflik (slegs as jy jQuery gebruik)

Soms is dit nodig om Bootstrap-inproppe met ander UI-raamwerke te gebruik. In hierdie omstandighede kan naamruimtebotsings soms voorkom. As dit gebeur, kan jy .noConflictdie inprop gebruik waarvan jy die waarde wil terugdraai.

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

Weergawe nommers

Die weergawe van elk van Bootstrap se inproppe kan verkry word via die VERSIONeiendom van die inprop se konstruktor. Byvoorbeeld, vir die tooltip-inprop:

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

Geen spesiale terugvalle wanneer JavaScript gedeaktiveer is nie

Bootstrap se inproppe val nie besonder grasieus terug wanneer JavaScript gedeaktiveer is nie. As jy omgee vir die gebruikerservaring in hierdie geval, gebruik <noscript>om die situasie (en hoe om JavaScript te heraktiveer) aan jou gebruikers te verduidelik, en/of voeg jou eie gepasmaakte terugval by.

Sanitizer

Tooltips en Popovers gebruik ons ​​ingeboude ontsmettingsmiddel om opsies wat HTML aanvaar, te ontsmet.

Die verstekwaarde allowListis die volgende:

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

As jy nuwe waardes by hierdie verstek wil voeg allowList, kan jy die volgende doen:

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)

As jy ons ontsmettingsmiddel wil omseil omdat jy verkies om 'n toegewyde biblioteek te gebruik, byvoorbeeld DOMPurify , moet jy die volgende doen:

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