JavaScript

Oživte Bootstrap pomocí našich volitelných pluginů JavaScript. Přečtěte si o každém pluginu, našich možnostech datového a programového rozhraní API a dalších.

Na této straně

Individuální nebo sestavené

Pluginy mohou být zahrnuty jednotlivě (pomocí Bootstrap's individual js/dist/*.js), nebo všechny najednou pomocí bootstrap.jsnebo minifikované bootstrap.min.js(nezahrnujte obojí).

Pokud používáte bundler (Webpack, Parcel, Vite…), můžete použít /js/dist/*.jssoubory, které jsou připraveny na UMD.

Použití s frameworky JavaScript

Zatímco Bootstrap CSS lze použít s jakýmkoliv frameworkem, Bootstrap JavaScript není plně kompatibilní s JavaScriptovými frameworky jako React, Vue a Angular, které předpokládají plnou znalost DOM. Bootstrap i framework se mohou pokoušet zmutovat stejný prvek DOM, což má za následek chyby, jako jsou rozevírací seznamy, které jsou zaseknuté v „otevřené“ poloze.

Lepší alternativou pro ty, kteří používají tento typ frameworků, je použití balíčku specifického pro framework namísto Bootstrap JavaScript. Zde jsou některé z nejoblíbenějších možností:

Reagovat: Reagovat Bootstrap
Vue: BootstrapVue (v současnosti podporuje pouze Vue 2 a Bootstrap 4)
Úhlový: ng-bootstrap

Použití Bootstrap jako modulu

Zkus to sám! Stáhněte si zdrojový kód a pracovní demo pro použití Bootstrapu jako modulu ES z úložiště twbs/examples . Příklad můžete také otevřít v StackBlitz .

Poskytujeme verzi Bootstrap vytvořenou jako ESM( bootstrap.esm.jsa bootstrap.esm.min.js), která vám umožňuje používat Bootstrap jako modul v prohlížeči, pokud to vaše cílené prohlížeče podporují .

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

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

Ve srovnání s JS bundlery použití ESM v prohlížeči vyžaduje, abyste místo názvu modulu použili úplnou cestu a název souboru. Přečtěte si více o modulech JS v prohlížeči. Proto používáme 'bootstrap.esm.min.js'místo 'bootstrap'výše uvedeného. To je však dále komplikováno naší závislostí Popper, která importuje Popper do našeho JavaScriptu takto:

import * as Popper from "@popperjs/core"

Pokud to zkusíte tak, jak je, uvidíte v konzole chybu, jako je tato:

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

Chcete-li tento problém vyřešit, můžete použít importmapk překladu libovolných názvů modulů k dokončení cest. Pokud vaše cílené prohlížeče nepodporují importmap, budete muset použít projekt es-module-shims . Zde je návod, jak to funguje pro 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

Některé pluginy a CSS komponenty závisí na jiných pluginech. Pokud zahrnete pluginy jednotlivě, nezapomeňte zkontrolovat tyto závislosti v dokumentech.

Naše rozbalovací nabídky, vyskakovací okna a popisky také závisí na Popperu .

Atributy dat

Téměř všechny zásuvné moduly Bootstrap lze aktivovat a konfigurovat pouze prostřednictvím HTML s datovými atributy (náš preferovaný způsob používání funkcí JavaScriptu). Ujistěte se, že pro jeden prvek používáte pouze jednu sadu atributů dat (např. nemůžete spustit popisek a modal ze stejného tlačítka.)

Protože volby lze předávat prostřednictvím datových atributů nebo JavaScriptu, můžete přidat název volby k data-bs-, jako v data-bs-animation="{value}". Při předávání možností prostřednictvím datových atributů se ujistěte, že jste změnili typ případu názvu možnosti z „ camelCase “ na „ kebab-case “. Použijte například data-bs-custom-class="beautifier"místo data-bs-customClass="beautifier".

Od Bootstrapu 5.2.0 všechny komponenty podporují experimentální atribut vyhrazených dat data-bs-config, který může obsahovat jednoduchou konfiguraci komponenty jako řetězec JSON. Když má prvek atributy data-bs-config='{"delay":0, "title":123}'a data-bs-title="456", konečná titlehodnota bude 456a samostatné datové atributy přepíší hodnoty uvedené na data-bs-config. Kromě toho mohou existující datové atributy obsahovat hodnoty JSON, jako je data-bs-delay='{"show":0,"hide":150}'.

Selektory

K dotazování na prvky DOM z důvodu výkonu používáme nativní metody querySelectora querySelectorAllmetody, takže musíte použít platné selektory . Pokud používáte speciální selektory jako collapse:Example, nezapomeňte jim uniknout.

Události

Bootstrap poskytuje vlastní události pro většinu jedinečných akcí pluginů. Obecně platí, že jsou ve formě infinitivu a minulého příčestí – kde infinitiv (např. show) je spuštěn na začátku události a jeho minulý tvar participia (např. shown) je spuštěn při dokončení akce.

Všechny infinitivní události poskytují preventDefault()funkčnost. To poskytuje možnost zastavit provádění akce před jejím zahájením. Vrácení false z obsluhy události také 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é rozhraní API

Všechny konstruktory přijímají volitelný objekt voleb nebo nic (což spouští plugin s jeho výchozím chování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

Pokud chcete získat konkrétní instanci pluginu, každý plugin odhaluje getInstancemetodu. Chcete-li například načíst instanci přímo z prvku:

bootstrap.Popover.getInstance(myPopoverEl)

Tato metoda se vrátí null, pokud není instance spuštěna nad požadovaným prvkem.

Alternativně getOrCreateInstancelze použít k získání instance přidružené k prvku DOM nebo k vytvoření nové v případě, že nebyla inicializována.

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

V případě, že instance nebyla inicializována, může přijmout a použít volitelný konfigurační objekt jako druhý argument.

CSS selektory v konstruktorech

Kromě metod getInstancea mohou všechny konstruktéry zásuvných modulů přijmout jako první argument getOrCreateInstanceprvek DOM nebo platný selektor CSS . Prvky zásuvných modulů lze nalézt pomocí querySelectormetody, protože naše zásuvné moduly podporují pouze jeden prvek.

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

Asynchronní funkce a přechody

Všechny metody programového rozhraní API jsou asynchronní a vracejí se k volajícímu, jakmile je přechod zahájen, ale před jeho ukončením . Chcete-li po dokončení přechodu provést akci, můžete si poslechnout odpovídající událost.

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

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

Kromě toho bude ignorováno volání metody na přechodové komponentě .

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`metoda

I když se může zdát správné použít disposemetodu ihned po hide(), povede to k nesprávným výsledkům. Zde je příklad použití problému:

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

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

Výchozí nastavení

Výchozí nastavení pluginu můžete změnit úpravou objektu pluginu Constructor.Default:

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

Metody a vlastnosti

Každý plugin Bootstrap zpřístupňuje následující metody a statické vlastnosti.

Metoda	Popis
`dispose`	Zničí modální prvek prvku. (Odstraní uložená data v prvku DOM)
`getInstance`	Statická metoda, která vám umožní získat modální instanci spojenou s prvkem DOM.
`getOrCreateInstance`	Statická metoda, která umožňuje získat modální instanci přidruženou k prvku DOM nebo vytvořit novou v případě, že nebyla inicializována.

Statická vlastnost	Popis
`NAME`	Vrátí název pluginu. (Příklad: `bootstrap.Tooltip.NAME`)
`VERSION`	K verzi každého z pluginů Bootstrapu lze přistupovat prostřednictvím `VERSION`vlastnosti konstruktoru pluginu (Příklad: `bootstrap.Tooltip.VERSION`)

Sanitizer

Popisky a vyskakovací okna používají náš vestavěný dezinfekční prostředek k dezinfekci možností, které přijímají HTML.

Výchozí allowListhodnota je následující:

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

Pokud chcete k tomuto výchozímu nastavení přidat nové hodnoty allowList, můžete provést následující:

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)

Pokud chcete obejít náš dezinfekční prostředek, protože dáváte přednost použití vyhrazené knihovny, například DOMPurify , měli byste udělat následující:

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

Volitelně pomocí jQuery

V Bootstrap 5 nepotřebujete jQuery , ale stále je možné používat naše komponenty s jQuery. Pokud Bootstrap detekuje jQueryv windowobjektu, přidá všechny naše komponenty do systému zásuvných modulů jQuery. To vám umožní provést následující:

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

Totéž platí pro naše další komponenty.

Žádný konflikt

Někdy je nutné použít Bootstrap pluginy s jinými UI frameworky. Za těchto okolností může občas dojít ke kolizím oboru názvů. Pokud k tomu dojde, můžete zavolat .noConflictna plugin, jehož hodnotu chcete vrátit.

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

Bootstrap oficiálně nepodporuje JavaScriptové knihovny třetích stran, jako je Prototype nebo jQuery UI. Navzdory .noConflictudálostem se jmenným prostorem se mohou vyskytnout problémy s kompatibilitou, které budete muset vyřešit sami.

události jQuery

Bootstrap detekuje jQuery, pokud jQueryje v windowobjektu přítomen a není nastaven žádný data-bs-no-jqueryatribut na <body>. Pokud je jQuery nalezen, Bootstrap bude vydávat události díky systému událostí jQuery. Pokud tedy chcete poslouchat události Bootstrapu, budete muset použít metody jQuery ( .on, .one) místo addEventListener.

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

Zakázaný JavaScript

Zásuvné moduly Bootstrapu nemají žádnou zvláštní rezervu, když je zakázán JavaScript. Pokud vám v tomto případě záleží na uživatelském dojmu, použijte <noscript>k vysvětlení situace (a jak znovu povolit JavaScript) svým uživatelům a/nebo přidejte své vlastní záložní.