JavaScript

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, Rollup...), tista' tuża /js/dist/*.jsfajls li huma lesti għall-UMD.

Bl-użu Bootstrap bħala modulu

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 tiegħek, 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>

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 fuq Popper .

Xorta trid tuża jQuery? Huwa possibbli!

Bootstrap 5 huwa ddisinjat biex jintuża mingħajr jQuery, 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 jQuery; dan ifisser li inti tkun kapaċi tagħmel $('[data-bs-toggle="tooltip"]').tooltip()biex tippermetti tooltips. L-istess jgħodd għall-komponenti l-oħra tagħna.

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

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

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

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

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

Jekk tixtieq tikseb każ partikolari ta' plugin, kull plugin jesponi getInstancemetodu. Sabiex tirkupraha direttament minn element, agħmel dan: bootstrap.Popover.getInstance(myPopoverEl).

Seletturi CSS fil-kostrutturi

Tista 'wkoll tuża selettur CSS bħala l-ewwel argument minflok element DOM biex inizjalizza l-plugin. Bħalissa l-element għall-plugin jinstab bil- querySelectormetodu peress li l-plugins tagħna jappoġġjaw element wieħed biss.

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

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.

var myCollapseEl = document.getElementById('myCollapse')

myCollapseEl.addEventListener('shown.bs.collapse', function (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 .

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

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

L-ebda kunflitt (biss jekk tuża jQuery)

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.

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

Numri tal-verżjoni

Il-verżjoni ta' kull plugin ta' Bootstrap tista' tiġi aċċessata permezz tal- VERSIONproprjetà tal-kostruttur tal-plugin. Per eżempju, għall-plugin tooltip:

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

Ebda fallbacks speċjali meta JavaScript huwa diżattivat

Il-plugins tal-Bootstrap ma jaqgħux lura partikolarment b'mod grazzjuż 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.

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:

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

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

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)

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

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