Slaan oor na hoofinhoud Slaan oor na dokumentnavigasie
Check
in English

JavaScript

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

Op hierdie bladsy

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 gebruik (Webpack, Pakkie, Vite ...), kan jy /js/dist/*.jslêers gebruik wat gereed is vir UMD.

Gebruik met JavaScript-raamwerke

Terwyl die Bootstrap CSS met enige raamwerk gebruik kan word, is die Bootstrap JavaScript nie ten volle versoenbaar met JavaScript-raamwerke soos React, Vue en Angular wat volle kennis van die DOM aanvaar nie. Beide Bootstrap en die raamwerk kan probeer om dieselfde DOM-element te muteer, wat lei tot foute soos dropdowns wat in die "oop" posisie vassit.

'n Beter alternatief vir diegene wat hierdie tipe raamwerke gebruik, is om 'n raamwerkspesifieke pakket te gebruik in plaas van die Bootstrap JavaScript. Hier is 'n paar van die gewildste opsies:

Gebruik Bootstrap as 'n module

Probeer dit self! Laai die bronkode en werkende demonstrasie af vir die gebruik van Bootstrap as 'n ES-module vanaf die twbs/voorbeeld-bewaarplek . U kan ook die voorbeeld in StackBlitz oopmaak .

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

In vergelyking met JS-bundels, vereis die gebruik van ESM in die blaaier dat jy die volle pad en lêernaam in plaas van die modulenaam gebruik. Lees meer oor JS-modules in die blaaier. Daarom gebruik ons ​​in 'bootstrap.esm.min.js'plaas van 'bootstrap'hierbo. Dit word egter verder gekompliseer deur ons Popper-afhanklikheid, wat Popper so in ons JavaScript invoer:

import * as Popper from "@popperjs/core"

As jy dit probeer soos dit is, sal jy 'n fout in die konsole sien soos die volgende:

Uncaught TypeError: Failed to resolve module specifier "@popperjs/core". Relative references must start with either "/", "./", or "../".

Om dit reg te stel, kan jy 'n importmapgebruik om die arbitrêre modulename op te los om paaie te voltooi. As jou geteikende blaaiers nie ondersteun nie importmap, sal jy die es-module-shims- projek moet gebruik. Hier is hoe dit werk vir Bootstrap en Popper:

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-iYQeCzEYFbKjA/T2uDLTpkwGzCiq6soy8tYaI1GyVh/UjpbCx/TYkiZhlZB6+fzT" crossorigin="anonymous">
    <title>Hello, modularity!</title>
  </head>
  <body>
    <h1>Hello, modularity!</h1>
    <button id="popoverButton" type="button" class="btn btn-primary btn-lg" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="ESM in Browser" data-bs-content="Bang!">Custom popover</button>

    <script async src="https://cdn.jsdelivr.net/npm/es-module-shims@1/dist/es-module-shims.min.js" crossorigin="anonymous"></script>
    <script type="importmap">
    {
      "imports": {
        "@popperjs/core": "https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js",
        "bootstrap": "https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.esm.min.js"
      }
    }
    </script>
    <script type="module">
      import * as bootstrap from 'bootstrap'

      new bootstrap.Popover(document.getElementById('popoverButton'))
    </script>
  </body>
</html>

Afhanklikhede

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

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

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

Aangesien opsies deur data-kenmerke of JavaScript deurgegee kan word, kan jy 'n opsienaam byvoeg data-bs-, soos in data-bs-animation="{value}". Maak seker dat jy die kastipe van die opsienaam verander van " camelCase " na " kebab-case " wanneer die opsies deur data-kenmerke deurgegee word. Gebruik byvoorbeeld in data-bs-custom-class="beautifier"plaas van data-bs-customClass="beautifier".

Vanaf Bootstrap 5.2.0 ondersteun alle komponente 'n eksperimentele gereserveerde data-kenmerk data-bs-configwat eenvoudige komponentkonfigurasie as 'n JSON-string kan huisves. Wanneer 'n element data-bs-config='{"delay":0, "title":123}'en data-bs-title="456"kenmerke het, sal die finale titlewaarde wees 456en die afsonderlike data-kenmerke sal waardes wat op gegee word, ignoreer data-bs-config. Daarbenewens kan bestaande data-kenmerke JSON-waardes soos data-bs-delay='{"show":0,"hide":150}'.

Keurers

Ons gebruik die oorspronklike querySelectoren querySelectorAllmetodes om navraag te doen oor DOM-elemente vir prestasieredes, so jy moet geldige kiesers gebruik . As jy spesiale kiesers soos collapse:Example, gebruik, maak seker dat jy hulle ontsnap.

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

const myModal = document.querySelector('#myModal')

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

Programmatiese API

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

const myModalEl = document.querySelector('#myModal')

const modal = new bootstrap.Modal(myModalEl) // initialized with defaults

const configObject = { keyboard: false }
const modal1 = new bootstrap.Modal(myModalEl, configObject) // initialized with no keyboard

As jy 'n spesifieke inprop-instansie wil kry, stel elke inprop 'n getInstancemetode bloot. Byvoorbeeld, om 'n instansie direk vanaf 'n element te haal:

bootstrap.Popover.getInstance(myPopoverEl)

Hierdie metode sal terugkeer nullas 'n instansie nie oor die gevraagde element geïnisieer word nie.

Alternatiewelik getOrCreateInstancekan dit gebruik word om die instansie wat met 'n DOM-element geassosieer word, te kry, of om 'n nuwe een te skep ingeval dit nie geïnisialiseer is nie.

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

In die geval dat 'n instansie nie geïnisialiseer is nie, kan dit 'n opsionele konfigurasie-objek as tweede argument aanvaar en gebruik.

CSS-keurders in konstrukteurs

Benewens die getInstanceen getOrCreateInstancemetodes, kan alle plugin-konstrukteurs 'n DOM-element of 'n geldige CSS-kieser as die eerste argument aanvaar. Inprop-elemente word met die querySelectormetode gevind, aangesien ons inproppe slegs 'n enkele element ondersteun.

const modal = new bootstrap.Modal('#myModal')
const dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')
const offcanvas = bootstrap.Offcanvas.getInstance('#myOffcanvas')
const alert = bootstrap.Alert.getOrCreateInstance('#myAlert')

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.

const myCollapseEl = document.querySelector('#myCollapse')

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

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

const myCarouselEl = document.querySelector('#myCarousel')
const carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance

myCarouselEl.addEventListener('slid.bs.carousel', 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 !!

disposemetode

Alhoewel dit korrek kan lyk om die disposemetode onmiddellik na te gebruik hide(), sal dit lei tot verkeerde resultate. Hier is 'n voorbeeld van die probleemgebruik:

const myModal = document.querySelector('#myModal')
myModal.hide() // it is asynchronous

myModal.addEventListener('shown.bs.hidden', event => {
  myModal.dispose()
})

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

Metodes en eienskappe

Elke Bootstrap-inprop stel die volgende metodes en statiese eienskappe bloot.

Metode Beskrywing
dispose Vernietig 'n element se modaal. (Verwyder gestoorde data op die DOM-element)
getInstance Statiese metode waarmee u die modale instansie kan kry wat met 'n DOM-element geassosieer word.
getOrCreateInstance Statiese metode wat jou toelaat om die modale instansie wat met 'n DOM-element geassosieer word te kry, of 'n nuwe een te skep ingeval dit nie geïnisialiseer is nie.
Statiese eiendom Beskrywing
NAME Wys die inpropnaam. (Voorbeeld: bootstrap.Tooltip.NAME)
VERSION Die weergawe van elk van Bootstrap se inproppe kan verkry word via die VERSIONeiendom van die inprop se konstruktor (Voorbeeld: bootstrap.Tooltip.VERSION)

Sanitizer

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

Die verstekwaarde allowListis die volgende:

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

const 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
const 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:

const yourTooltipEl = document.querySelector('#yourTooltip')
const tooltip = new bootstrap.Tooltip(yourTooltipEl, {
  sanitizeFn(content) {
    return DOMPurify.sanitize(content)
  }
})

Opsioneel met behulp van jQuery

Jy het nie jQuery in Bootstrap 5 nodig nie , 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 laat jou toe om die volgende te doen:

$('[data-bs-toggle="tooltip"]').tooltip() // to enable tooltips, with default configuration

$('[data-bs-toggle="tooltip"]').tooltip({ boundary: 'clippingParents', customClass: 'myClass' }) // to initialize tooltips with given configuration

$('#myTooltip').tooltip('show') // to trigger `show` method

Dieselfde geld vir ons ander komponente.

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.

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

Bootstrap ondersteun nie amptelik JavaScript-biblioteke van derdepartye soos Prototype of jQuery UI nie. Ten spyte .noConflictvan gebeurtenisse wat deur die naam gespasieer is, kan daar versoenbaarheidsprobleme wees wat u op u eie moet regstel.

jQuery gebeure

Bootstrap sal jQuery opspoor as jQuerydit in die windowobjek teenwoordig is en daar geen data-bs-no-jquerykenmerk op gestel is nie <body>. As jQuery gevind word, sal Bootstrap gebeure uitstuur danksy jQuery se gebeurtenisstelsel. As jy dus na Bootstrap se gebeure wil luister, sal jy die jQuery-metodes ( .on, .one) moet gebruik in plaas van addEventListener.

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

JavaScript gedeaktiveer

Bootstrap se inproppe het geen spesiale terugval 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.