JavaScript

Agħti l-ħajja lil Bootstrap bil-plugins JavaScript fakultattivi tagħna. Tgħallem dwar kull plugin, l-għażliet tad-dejta u l-API programmatiċi tagħna, u aktar.

Fuq din il-paġna

Individwali jew miġbura

Il-plugins jistgħu jiġu inklużi individwalment (bl-użu tal-individwu Bootstrap js/dist/*.js), jew kollha f'daqqa bl-użu bootstrap.jsjew il-minifikat bootstrap.min.js(ma jinkludux it-tnejn).

Jekk tuża bundler (Webpack, Parcel, Vite...), tista' tuża /js/dist/*.jsfajls li huma lesti għall-UMD.

Użu ma' oqfsa JavaScript

Filwaqt li l-Bootstrap CSS jista 'jintuża ma' kwalunkwe qafas, il-Bootstrap JavaScript mhuwiex kompletament kompatibbli ma 'oqfsa JavaScript bħal React, Vue, u Angular li jassumu għarfien sħiħ tad-DOM. Kemm il-Bootstrap kif ukoll il-qafas jistgħu jippruvaw jimmodifikaw l-istess element DOM, li jirriżultaw fi bugs bħal dropdowns li huma mwaħħla fil-pożizzjoni "miftuħa".

Alternattiva aħjar għal dawk li jużaw dan it-tip ta 'oqfsa hija li tuża pakkett speċifiku għall-qafas minflok il-Bootstrap JavaScript. Hawn huma xi wħud mill-aktar għażliet popolari:

Irreaġixxi: Irreaġixxi Bootstrap
Vue: BootstrapVue (bħalissa jappoġġja Vue 2 u Bootstrap 4 biss)
Angolari: ng-bootstrap

Bl-użu Bootstrap bħala modulu

Ipprova lilek innifsek! Niżżel il-kodiċi tas-sors u d-demo tax-xogħol biex tuża Bootstrap bħala modulu ES mir- repożitorju twbs/eżempji . Tista 'wkoll tiftaħ l-eżempju fi StackBlitz .

Aħna nipprovdu verżjoni ta' Bootstrap mibnija bħala ESM( bootstrap.esm.jsu bootstrap.esm.min.js) li tippermettilek tuża Bootstrap bħala modulu fil-browser, jekk il -browsers immirati tiegħek jappoġġawha .

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

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

Meta mqabbel ma 'JS bundlers, l-użu tal-ESM fil-browser jeħtieġ li tuża l-passaġġ sħiħ u l-isem tal-fajl minflok l-isem tal-modulu. Aqra aktar dwar il-moduli JS fil-browser. Huwa għalhekk li nużaw 'bootstrap.esm.min.js'minflok 'bootstrap'hawn fuq. Madankollu, dan huwa kkumplikat aktar mid-dipendenza tagħna fuq Popper, li timporta Popper fil-JavaScript tagħna hekk:

import * as Popper from "@popperjs/core"

Jekk tipprova dan kif inhu, tara żball fil-console bħal dan li ġej:

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

Biex tiffissa dan, tista 'tuża importmapbiex issolvi l-ismijiet tal-moduli arbitrarji biex tlesti l-mogħdijiet. Jekk il -browsers immirati tiegħek ma jappoġġjawx importmap, ikollok bżonn tuża l -proġett es-module-shims . Hawn kif taħdem għal Bootstrap u 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>

Dipendenzi

Xi plugins u komponenti CSS jiddependu fuq plugins oħra. Jekk tinkludi plugins individwalment, kun żgur li tiċċekkja għal dawn id-dipendenzi fid-doks.

Il-dropdowns, popovers, u tooltips tagħna jiddependu wkoll minn Popper .

Attributi tad-dejta

Kważi l-plugins Bootstrap kollha jistgħu jiġu attivati u kkonfigurati permezz tal-HTML biss bl-attributi tad-dejta (il-mod preferut tagħna kif nużaw il-funzjonalità JavaScript). Kun żgur li tuża sett wieħed biss ta' attributi tad-dejta fuq element wieħed (eż., ma tistax tiskatta tooltip u modal mill-istess buttuna.)

Peress li l-għażliet jistgħu jiġu mgħoddija permezz ta' attributi tad-dejta jew JavaScript, tista' tehmeż isem ta' għażla ma' data-bs-, bħal f' data-bs-animation="{value}". Kun żgur li tbiddel it-tip tal-każ tal-isem tal-għażla minn " camelCase " għal " kebab-case " meta tgħaddi l-għażliet permezz tal-attributi tad-dejta. Per eżempju, uża data-bs-custom-class="beautifier"minflok data-bs-customClass="beautifier".

Minn Bootstrap 5.2.0, il-komponenti kollha jappoġġaw attribut ta' data riżervat sperimentalidata-bs-config li jista' jospita konfigurazzjoni ta' komponent sempliċi bħala string JSON. Meta element ikollu data-bs-config='{"delay":0, "title":123}'u data-bs-title="456"attributi, il- titlevalur finali se jkun 456u l-attributi tad-dejta separati jegħlbu l-valuri mogħtija fuq data-bs-config. Barra minn hekk, l-attributi tad-dejta eżistenti jistgħu jospitaw valuri JSON bħal data-bs-delay='{"show":0,"hide":150}'.

Seleturi

Aħna nużaw il-metodi indiġeni querySelectoru querySelectorAllbiex nistaqsu elementi DOM għal raġunijiet ta 'prestazzjoni, għalhekk trid tuża seletturi validi . Jekk tuża seletturi speċjali bħal collapse:Example, kun żgur li taħrabhom.

Avvenimenti

Bootstrap jipprovdi avvenimenti personalizzati għall-biċċa l-kbira tal-azzjonijiet uniċi tal-plugins. Ġeneralment, dawn jiġu f'forma ta 'partiċipju infinitiv u passat - fejn l-infinittiv (eż. show) jiġi attivat fil-bidu ta' avveniment, u l-forma ta 'partiċipju passat tiegħu (eż. shown) tiġi attivata mat-tlestija ta' azzjoni.

L-avvenimenti infiniti kollha jipprovdu preventDefault()funzjonalità. Dan jipprovdi l-abbiltà li twaqqaf l-eżekuzzjoni ta 'azzjoni qabel ma tibda. Ir-ritorn ta' falza minn handler tal-avvenimenti sejjer ukoll awtomatikament preventDefault().

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

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

API programmatiku

Il-kostrutturi kollha jaċċettaw oġġett ta' għażliet fakultattivi jew xejn (li jibda plugin bl-imġieba default tiegħu):

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

Jekk tixtieq tikseb każ partikolari ta' plugin, kull plugin jesponi getInstancemetodu. Pereżempju, biex tirkupra istanza direttament minn element:

bootstrap.Popover.getInstance(myPopoverEl)

Dan il-metodu jirritorna nulljekk istanza ma tinbediex fuq l-element mitlub.

Inkella, getOrCreateInstancetista 'tintuża biex tikseb l-istanza assoċjata ma' element DOM, jew toħloq waħda ġdida f'każ li ma kinitx inizjalizzata.

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

F'każ li istanza ma kinitx inizjalizzata, tista' taċċetta u tuża oġġett ta' konfigurazzjoni fakultattiv bħala t-tieni argument.

Seletturi CSS fil-kostrutturi

Minbarra l- metodi getInstanceu getOrCreateInstance, il-kostrutturi tal-plugins kollha jistgħu jaċċettaw element DOM jew selettur CSS validu bħala l-ewwel argument. Elementi tal-plugin jinstabu mal- querySelectormetodu peress li l-plugins tagħna jappoġġjaw biss element wieħed.

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

Funzjonijiet u tranżizzjonijiet asinkroniċi

Il-metodi programmatiċi kollha tal-API huma asinkroniċi u jirritornaw lil min iċempel ladarba tinbeda t-tranżizzjoni, iżda qabel ma tispiċċa . Sabiex tesegwixxi azzjoni ladarba t-tranżizzjoni titlesta, tista 'tisma' l-avveniment korrispondenti.

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

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

Barra minn hekk, sejħa ta' metodu fuq komponent ta' tranżizzjoni se tiġi injorata .

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

Filwaqt li jista 'jidher korrett li tuża l- disposemetodu immedjatament wara hide(), dan iwassal għal riżultati żbaljati. Hawn eżempju tal-użu problematiku:

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

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

Settings default

Tista' tibdel is-settings default għal plugin billi timmodifika l- Constructor.Defaultoġġett tal-plugin:

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

Metodi u proprjetajiet

Kull plugin Bootstrap jesponi l-metodi u l-proprjetajiet statiċi li ġejjin.

Metodu	Deskrizzjoni
`dispose`	Jeqred il-modal ta' element. (Tneħħi d-dejta maħżuna fuq l-element DOM)
`getInstance`	Metodu statiku li jippermettilek tikseb l-istanza modali assoċjata ma 'element DOM.
`getOrCreateInstance`	Metodu statiku li jippermettilek li tikseb l-istanza modali assoċjata ma 'element DOM, jew toħloq waħda ġdida f'każ li ma kinitx inizjalizzata.

Proprjetà statika	Deskrizzjoni
`NAME`	Jirritorna l-isem tal-plugin. (Eżempju: `bootstrap.Tooltip.NAME`)
`VERSION`	Il-verżjoni ta' kull plugin ta' Bootstrap tista' tiġi aċċessata permezz tal- `VERSION`proprjetà tal-kostruttur tal-plugin (Eżempju: `bootstrap.Tooltip.VERSION`)

Sanitizer

Tooltips u Popovers jużaw is-sanitizer inkorporat tagħna biex sanitizzaw għażliet li jaċċettaw HTML.

Il-valur default allowListhuwa dan li ġej:

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

Jekk trid iżżid valuri ġodda ma' dan default allowListtista' tagħmel dan li ġej:

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)

Jekk trid taqbeż is-sanitizer tagħna għaliex tippreferi tuża librerija ddedikata, pereżempju DOMPurify , għandek tagħmel dan li ġej:

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

B'għażla billi tuża jQuery

M'għandekx bżonn jQuery f'Bootstrap 5 , iżda xorta huwa possibbli li tuża l-komponenti tagħna ma 'jQuery. Jekk Bootstrap jiskopri jQueryfl- windowoġġett, se jżid il-komponenti kollha tagħna fis-sistema tal-plugin ta 'jQuery. Dan jippermettilek tagħmel dan li ġej:

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

L-istess jgħodd għall-komponenti l-oħra tagħna.

L-ebda kunflitt

Xi drabi huwa meħtieġ li tuża plugins Bootstrap ma 'oqfsa UI oħra. F'dawn iċ-ċirkostanzi, ħabtiet tal-ispazji tal-isem jistgħu jseħħu okkażjonalment. Jekk jiġri dan, tista' ċċempel .noConflictfuq il-plugin li tixtieq ireġġa' lura l-valur tiegħu.

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

Bootstrap ma jappoġġjax uffiċjalment libreriji JavaScript ta' partijiet terzi bħal Prototype jew jQuery UI. Minkejja .noConflictl-avvenimenti u namespaced, jista 'jkun hemm problemi ta' kompatibilità li għandek bżonn tirranġa waħdek.

Avvenimenti jQuery

Bootstrap se jiskopri jQuery jekk jQueryikun preżenti fl- windowoġġett u m'hemm l-ebda data-bs-no-jqueryattribut stabbilit fuq <body>. Jekk jinstab jQuery, Bootstrap se jarmi avvenimenti grazzi għas-sistema ta 'avvenimenti ta' jQuery. Mela jekk trid tisma' l-avvenimenti ta' Bootstrap, ikollok tuża l-metodi jQuery ( .on, .one) minflok addEventListener.

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

JavaScript diżattivat

Il-plugins ta' Bootstrap m'għandhom l-ebda riżerva speċjali meta JavaScript huwa diżattivat. Jekk inti jimpurtak mill-esperjenza tal-utent f'dan il-każ, uża <noscript>biex tispjega s-sitwazzjoni (u kif terġa 'tippermetti l-JavaScript) lill-utenti tiegħek, u/jew iżżid id-drawwiet tiegħek stess.