JavaScript

Bring Bootstrap tot lewe met ons opsionele JavaScript-inproppe wat op jQuery gebou is. Kom meer te wete oor elke inprop, ons data- en programmatiese API-opsies, en meer.

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.

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. Let ook daarop dat alle inproppe afhanklik is van jQuery (dit beteken jQuery moet voor die inproplêers ingesluit word). Raadpleeg onspackage.json om te sien watter weergawes van jQuery ondersteun word.

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

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

In sommige situasies kan dit egter wenslik wees om hierdie funksionaliteit te deaktiveer. Om die data-kenmerk API te deaktiveer, ontbind alle gebeurtenisse op die dokument wat met die naamspasiëring data-apisoos volg:

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

Alternatiewelik, om 'n spesifieke inprop te teiken, sluit net die inprop se naam as 'n naamspasie saam met die data-api naamspasie soos volg in:

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

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) aan die begin van 'n gebeurtenis geaktiveer word, en sy verlede deelwoordvorm (bv. shown) word geaktiveer 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().

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

Programmatiese API

Ons glo ook dat u alle Bootstrap-inproppe bloot deur die JavaScript API moet kan gebruik. Alle publieke API's is enkelvoudige, kettingbare metodes, en gee die versameling waarop gereageer is, terug.

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

Alle metodes moet 'n opsionele opsie-objek aanvaar, 'n string wat 'n spesifieke metode teiken, of niks (wat 'n inprop met verstekgedrag inisieer):

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

Elke inprop stel ook sy rou konstruktor bloot op 'n Constructoreiendom: $.fn.popover.Constructor. As jy 'n spesifieke inprop-instansie wil kry, haal dit direk van 'n element af: $('[rel="popover"]').data('popover').

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.

$('#myCollapse').on('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 .

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

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
$.fn.modal.Constructor.Default.keyboard = false

Geen konflik nie

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 jQuery-inproppe kan verkry word via die VERSIONeiendom van die inprop se konstruktor. Byvoorbeeld, vir die tooltip-inprop:

$.fn.tooltip.Constructor.VERSION // => "4.6.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.

Gebruik

Alle Bootstrap se JavaScript-lêers hang af van util.jsen dit moet saam met die ander JavaScript-lêers ingesluit word. As jy die saamgestelde (of verkleineerde) bootstrap.jsgebruik, is dit nie nodig om dit in te sluit nie - dit is reeds daar.

util.jssluit nutsfunksies en 'n basiese helper vir transitionEndgebeure sowel as 'n CSS-oorgangemulator in. Dit word deur die ander inproppe gebruik om te kyk vir CSS-oorgangondersteuning en om hangende oorgange op te vang.

Sanitizer

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

Die verstekwaarde whiteListis die volgende:

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', '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 whiteList, kan jy die volgende doen:

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)

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

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