JavaScript

Egyéni vagy összeállított

A beépülő modulok egyenként is beépíthetők (a Bootstrap egyéni használatával js/dist/*.js), vagy mind egyszerre, bootstrap.jsvagy a kicsinyített változat használatával bootstrap.min.js(ne tartalmazza mindkettőt).

Ha kötegelőt (Webpack, Rollup…) használ, akkor /js/dist/*.jsUMD-kompatibilis fájlokat is használhat.

A Bootstrap használata modulként

ESMA Bootstrap ( bootstrap.esm.jsés ) néven készült verzióját biztosítjuk, bootstrap.esm.min.jsamely lehetővé teszi a Bootstrap modulként való használatát a böngészőjében, ha a megcélzott böngészők támogatják .

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

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

Függőségek

Egyes bővítmények és CSS-összetevők más beépülő moduloktól függenek. Ha a beépülő modulokat külön-külön is felveszi, feltétlenül ellenőrizze ezeket a függőségeket a dokumentumokban.

Legördülő menüink, előugró ablakaink és eszköztippjeink a Poppertől is függenek .

Továbbra is szeretné használni a jQuery-t? Lehetséges!

A Bootstrap 5-öt úgy tervezték, hogy jQuery nélkül is használható legyen, de továbbra is lehetséges az összetevőink használata a jQuery-vel. Ha a Bootstrap észleli jQueryaz windowobjektumban , akkor az összes komponensünket hozzáadja a jQuery bővítményrendszeréhez; ez azt jelenti, $('[data-bs-toggle="tooltip"]').tooltip()hogy engedélyezheti az eszköztippeket. Ugyanez vonatkozik a többi komponensünkre is.

Adatattribútumok

Szinte minden Bootstrap beépülő modul engedélyezhető és konfigurálható kizárólag HTML-en keresztül adatattribútumokkal (a JavaScript funkció használatának előnyben részesített módja). Ügyeljen arra, hogy egyetlen elemnél csak egy adatattribútum-készletet használjon (pl. nem indíthat el eszközleírást és modált ugyanarról a gombról).

Események

A Bootstrap egyéni eseményeket biztosít a legtöbb plugin egyedi műveletéhez. Ezek általában főnévi igenév és múlttag alakban fordulnak elő – ahol az infinitivus (pl. show) egy esemény kezdetén, a múltbeli igenév alakja (pl. shown) pedig egy cselekvés befejezésekor aktiválódik.

Minden infinitiv esemény preventDefault()funkcionalitást biztosít. Ez lehetővé teszi egy művelet végrehajtásának leállítását, mielőtt az elindulna. Ha az eseménykezelő false értéket ad vissza, az automatikusan meghívja a 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...
})

Programozott API

Minden konstruktor elfogad egy opcionális opciós objektumot vagy semmit (ami elindít egy beépülő modult az alapértelmezett viselkedésével):

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

Ha egy adott bővítménypéldányt szeretne beszerezni, minden beépülő modul felfed egy getInstancemetódust. Ha közvetlenül egy elemből szeretné lekérni, tegye a következőket: bootstrap.Popover.getInstance(myPopoverEl).

CSS-szelektorok a konstruktorokban

Használhat CSS-választót is első argumentumként a DOM-elem helyett a bővítmény inicializálásához. Jelenleg a beépülő modul elemét a querySelectormetódus találja meg, mivel a beépülő moduljaink csak egyetlen elemet támogatnak.

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

Aszinkron funkciók és átmenetek

Minden programozott API metódus aszinkron , és visszatér a hívóhoz az áttérés megkezdése után, de még azelőtt, hogy az átmenet véget érne .

Egy művelet végrehajtásához, miután az átmenet befejeződött, meghallgathatja a megfelelő eseményt.

var myCollapseEl = document.getElementById('myCollapse')

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

Ezenkívül a rendszer figyelmen kívül hagyja az átmeneti komponens metódushívását .

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

Alapbeállítások

A beépülő modul alapértelmezett beállításait módosíthatja a bővítmény Constructor.Defaultobjektumának módosításával:

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

Nincs ütközés (csak jQuery használata esetén)

Néha szükséges a Bootstrap beépülő modulok használata más UI keretrendszerekkel. Ilyen körülmények között időnként előfordulhatnak névtér-ütközések. Ha ez megtörténik, hívhatja azt .noConflicta beépülő modult, amelynek az értékét vissza szeretné állítani.

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

Verziószámok

VERSIONA Bootstrap egyes bővítményeinek verziója a beépülő modul konstruktorának tulajdonságán keresztül érhető el . Például az eszköztipp beépülő modulhoz:

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

Nincsenek különleges tartalékok, ha a JavaScript le van tiltva

A Bootstrap beépülő moduljai nem esnek vissza különösen kecsesen, ha a JavaScript le van tiltva. Ha ebben az esetben érdekli a felhasználói élmény, használja <noscript>a helyzet elmagyarázásához (és a JavaScript újraengedélyezéséhez) a felhasználóknak, és/vagy adja hozzá saját egyéni tartalékait.

Fertőtlenítő

Az eszköztippek és az előugró ablakok a beépített fertőtlenítőnket használják a HTML-t elfogadó opciók tisztítására.

Az alapértelmezett allowListérték a következő:

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

Ha új értékeket szeretne hozzáadni ehhez az alapértelmezett értékhez, allowListtegye a következőket:

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)

Ha szeretné megkerülni a fertőtlenítőnket, mert inkább egy dedikált könyvtárat szeretne használni, például a DOMPurify , akkor tegye a következőket:

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