JavaScript

Oživte Bootstrap pomocou našich voliteľných doplnkov JavaScript. Získajte informácie o každom doplnku, našich údajoch a možnostiach programového rozhrania API a ďalšie informácie.

Na tejto stránke

Individuálne alebo zostavené

Pluginy môžu byť zahrnuté jednotlivo (pomocou Bootstrap's individual js/dist/*.js), alebo všetky naraz pomocou bootstrap.jsalebo minifikované bootstrap.min.js(nezahŕňajú oboje).

Ak používate balík (Webpack, Parcel, Vite…), môžete použiť /js/dist/*.jssúbory, ktoré sú pripravené na UMD.

Použitie s frameworkami JavaScript

Zatiaľ čo Bootstrap CSS možno použiť s akýmkoľvek rámcom, Bootstrap JavaScript nie je plne kompatibilný s rámcami JavaScriptu, ako sú React, Vue a Angular, ktoré predpokladajú úplnú znalosť DOM. Bootstrap aj rámec sa môžu pokúsiť zmutovať rovnaký prvok DOM, čo vedie k chybám, ako sú rozbaľovacie zoznamy, ktoré sú zaseknuté v polohe „otvorené“.

Lepšou alternatívou pre tých, ktorí používajú tento typ rámcov, je použiť balík špecifický pre rámec namiesto JavaScriptu Bootstrap. Tu sú niektoré z najpopulárnejších možností:

Reagovať: Reagovať Bootstrap
Vue: BootstrapVue (v súčasnosti podporuje iba Vue 2 a Bootstrap 4)
Uhlový: ng-bootstrap

Použitie Bootstrapu ako modulu

Skúste to sami! Stiahnite si zdrojový kód a pracovné demo na používanie Bootstrapu ako modulu ES z úložiska twbs/examples . Príklad môžete otvoriť aj v StackBlitz .

Poskytujeme verziu Bootstrap postavenú ako ESM( bootstrap.esm.jsa bootstrap.esm.min.js), ktorá vám umožňuje používať Bootstrap ako modul v prehliadači, ak to vaše cieľové prehliadače podporujú .

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

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

V porovnaní s balíkmi JS si používanie ESM v prehliadači vyžaduje, aby ste namiesto názvu modulu použili úplnú cestu a názov súboru. Prečítajte si viac o moduloch JS v prehliadači. Preto používame 'bootstrap.esm.min.js'namiesto 'bootstrap'vyššie uvedeného. Toto je však ďalej komplikované našou závislosťou Popper, ktorá importuje Popper do nášho JavaScriptu takto:

import * as Popper from "@popperjs/core"

Ak to skúsite tak, ako je, v konzole sa zobrazí chyba, ako je táto:

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

Ak to chcete vyriešiť, môžete použiť a importmapna vyriešenie ľubovoľných názvov modulov na dokončenie ciest. Ak vaše cieľové prehliadače nepodporujú importmap, budete musieť použiť projekt es-module-shims . Tu je návod, ako to funguje pre Bootstrap a 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>

Závislosti

Niektoré doplnky a komponenty CSS závisia od iných doplnkov. Ak zahrniete doplnky jednotlivo, nezabudnite skontrolovať tieto závislosti v dokumentoch.

Od Poppera závisia aj naše rozbaľovacie ponuky, kontextové okná a popisy .

Atribúty údajov

Takmer všetky zásuvné moduly Bootstrap je možné aktivovať a konfigurovať iba prostredníctvom HTML s dátovými atribútmi (náš preferovaný spôsob používania funkcií JavaScriptu). Uistite sa, že na jednom prvku používate iba jednu množinu atribútov údajov (napr. nemôžete spustiť popis a modal z toho istého tlačidla.)

Keďže možnosti možno odovzdať prostredníctvom atribútov údajov alebo jazyka JavaScript, môžete pridať názov možnosti k data-bs-, ako v data-bs-animation="{value}". Pri odovzdávaní možností cez atribúty údajov nezabudnite zmeniť typ prípadu názvu možnosti z „ camelCase “ na „ kebab-case “. Napríklad použite data-bs-custom-class="beautifier"namiesto data-bs-customClass="beautifier".

Od Bootstrapu 5.2.0 všetky komponenty podporujú experimentálny atribút rezervovaných údajov data-bs-config, ktorý môže obsahovať jednoduchú konfiguráciu komponentu ako reťazec JSON. Ak má prvok atribúty data-bs-config='{"delay":0, "title":123}'a data-bs-title="456", konečná titlehodnota bude 456a samostatné atribúty údajov prepíšu hodnoty uvedené na data-bs-config. Existujúce dátové atribúty môžu navyše obsahovať hodnoty JSON ako data-bs-delay='{"show":0,"hide":150}'.

Selektory

Na dopytovanie prvkov DOM z dôvodov výkonu používame natívne metódy querySelectora querySelectorAllmetódy, takže musíte použiť platné selektory . Ak používate špeciálne selektory, ako napríklad collapse:Example, nezabudnite im uniknúť.

Diania

Bootstrap poskytuje vlastné udalosti pre väčšinu jedinečných akcií doplnkov. Vo všeobecnosti sú vo forme infinitívu a minulého príčastia – kde infinitív (napr. show) sa spúšťa na začiatku udalosti a jeho minulá forma príčastia (napr. shown) sa spúšťa pri dokončení akcie.

Všetky nekonečné udalosti poskytujú preventDefault()funkčnosť. To poskytuje možnosť zastaviť vykonávanie akcie pred jej spustením. Vrátenie false z obsluhy udalosti tiež automaticky zavolá preventDefault().

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

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

Programové rozhranie API

Všetky konštruktory akceptujú voliteľný objekt volieb alebo nič (čo iniciuje doplnok s jeho predvoleným správaním):

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

Ak chcete získať konkrétnu inštanciu doplnku, každý doplnok odhaľuje getInstancemetódu. Ak chcete napríklad získať inštanciu priamo z prvku:

bootstrap.Popover.getInstance(myPopoverEl)

Táto metóda sa vráti, nullak inštancia nie je iniciovaná nad požadovaným prvkom.

Alternatívne getOrCreateInstancesa dá použiť na získanie inštancie priradenej k prvku DOM alebo na vytvorenie novej v prípade, že nebola inicializovaná.

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

V prípade, že inštancia nebola inicializovaná, môže prijať a použiť voliteľný konfiguračný objekt ako druhý argument.

CSS selektory v konštruktoroch

Okrem metód getInstancea môžu všetky konštruktory doplnkov akceptovať ako prvý argument getOrCreateInstanceprvok DOM alebo platný selektor CSS . Prvky zásuvných modulov sa nachádzajú s touto querySelectormetódou, pretože naše doplnky podporujú iba jeden prvok.

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

Asynchrónne funkcie a prechody

Všetky metódy programového rozhrania API sú asynchrónne a vrátia sa volajúcemu po spustení prechodu, ale pred jeho ukončením . Ak chcete po dokončení prechodu vykonať akciu, môžete si vypočuť príslušnú udalosť.

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

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

Okrem toho bude volanie metódy na prechodovom komponente ignorované .

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

`dispose`metóda

Aj keď sa môže zdať správne použiť disposemetódu ihneď po hide(), povedie to k nesprávnym výsledkom. Tu je príklad použitia problému:

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

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

Predvolené nastavenia

Predvolené nastavenia doplnku môžete zmeniť úpravou Constructor.Defaultobjektu doplnku:

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

Metódy a vlastnosti

Každý doplnok Bootstrap odhaľuje nasledujúce metódy a statické vlastnosti.

Metóda	Popis
`dispose`	Zničí modálny prvok prvku. (Odstráni uložené údaje v prvku DOM)
`getInstance`	Statická metóda, ktorá vám umožňuje získať modálnu inštanciu spojenú s prvkom DOM.
`getOrCreateInstance`	Statická metóda, ktorá vám umožňuje získať modálnu inštanciu spojenú s prvkom DOM alebo vytvoriť novú v prípade, že nebola inicializovaná.

Statická vlastnosť	Popis
`NAME`	Vráti názov doplnku. (Príklad: `bootstrap.Tooltip.NAME`)
`VERSION`	K verzii každého z doplnkov Bootstrap je možné pristupovať prostredníctvom `VERSION`vlastnosti konštruktora doplnku (Príklad: `bootstrap.Tooltip.VERSION`)

Dezinfekčný prostriedok

Popisy a kontextové okná používajú náš vstavaný dezinfekčný prostriedok na dezinfekciu možností, ktoré akceptujú HTML.

Predvolená allowListhodnota je nasledovná:

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

Ak chcete k tejto predvolenej hodnote pridať nové hodnoty allowList, môžete urobiť nasledovné:

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)

Ak chcete obísť náš dezinfekčný prostriedok, pretože uprednostňujete používanie špeciálnej knižnice, napríklad DOMPurify , mali by ste urobiť nasledovné:

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

Voliteľne pomocou jQuery

V Bootstrap 5 nepotrebujete jQuery , ale stále je možné používať naše komponenty s jQuery. Ak Bootstrap zistí jQueryv windowobjekte, pridá všetky naše komponenty do systému doplnkov jQuery. Umožňuje vám to:

$('[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

To isté platí pre naše ostatné komponenty.

Žiadny konflikt

Niekedy je potrebné použiť Bootstrap pluginy s inými UI frameworkami. Za týchto okolností môže občas dôjsť ku kolíziám menného priestoru. Ak sa tak stane, môžete zavolať .noConflictna doplnok, ktorého hodnotu chcete vrátiť.

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

Bootstrap oficiálne nepodporuje JavaScriptové knižnice tretích strán, ako je Prototype alebo jQuery UI. Napriek .noConflictudalostiam s menným priestorom sa môžu vyskytnúť problémy s kompatibilitou, ktoré budete musieť vyriešiť sami.

udalosti jQuery

Bootstrap zistí, že jQuery jQueryje prítomný v windowobjekte a nie je data-bs-no-jquerynastavený žiadny atribút <body>. Ak sa nájde jQuery, Bootstrap vygeneruje udalosti vďaka systému udalostí jQuery. Takže ak chcete počúvať udalosti Bootstrapu, budete musieť použiť metódy jQuery ( .on, .one) namiesto addEventListener.

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

Zakázaný JavaScript

Zásuvné moduly Bootstrap nemajú žiadnu špeciálnu rezervu, keď je JavaScript zakázaný. Ak vám v tomto prípade záleží na používateľskej skúsenosti, použite <noscript>na vysvetlenie situácie (a ako znovu povoliť JavaScript) svojim používateľom a/alebo pridajte svoje vlastné záložné.