JavaScript

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

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.

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. Innota wkoll li l-plugins kollha jiddependu fuq jQuery (dan ifisser li jQuery għandu jiġi inkluż qabel il-fajls tal-plugin). Ikkonsulta tagħnapackage.json biex tara liema verżjonijiet ta 'jQuery huma appoġġjati.

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

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

Madankollu, f'xi sitwazzjonijiet jista 'jkun mixtieq li din il-funzjonalità tiġi diżattivata. Biex tiddiżattiva l-API tal-attribut tad-dejta, neħħi l-irbit l-avvenimenti kollha fuq id-dokument spazjati bl-ismijiet tal-ismijiet data-apihekk:

$(document).off('.data-api')

Inkella, biex timmira plugin speċifiku, inkludi biss l-isem tal-plugin bħala spazju tal-isem flimkien mal-ispazju tal-isem tad-data-api bħal dan:

$(document).off('.alert.data-api')

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

$('#myModal').on('show.bs.modal', function (e) {
  if (!data) {
    return e.preventDefault() // stops modal from being shown
  }
})

API programmatiku

Aħna nemmnu wkoll li għandek tkun tista' tuża l-plugins Bootstrap kollha purament permezz tal-API JavaScript. L-APIs pubbliċi kollha huma metodi singoli, li jistgħu jiġu kkatinati, u jirritornaw il-ġbir li ttieħed azzjoni fuqhom.

$('.btn.danger').button('toggle').addClass('fat')

Il-metodi kollha għandhom jaċċettaw oġġett ta' għażliet fakultattivi, string li jimmira metodu partikolari, jew xejn (li jibda plugin b'imġieba default):

$('#myModal').modal() // initialized with defaults
$('#myModal').modal({ keyboard: false }) // initialized with no keyboard
$('#myModal').modal('show') // initializes and invokes show immediately

Kull plugin jesponi wkoll il-kostruttur mhux maħdum tiegħu fuq Constructorproprjetà: $.fn.popover.Constructor. Jekk tixtieq tikseb każ partikolari ta' plugin, irkupraha direttament minn element: $('[rel="popover"]').data('popover').

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.

$('#myCollapse').on('shown.bs.collapse', function (e) {
  // 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 .

$('#myCarousel').on('slid.bs.carousel', function (e) {
  $('#myCarousel').carousel('2') // Will slide to the slide 2 as soon as the transition to slide 1 is finished
})

$('#myCarousel').carousel('1') // Will start sliding to the slide 1 and returns to the caller
$('#myCarousel').carousel('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
$.fn.modal.Constructor.Default.keyboard = false

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.

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 jQuery ta' Bootstrap tista' tiġi aċċessata permezz tal- VERSIONproprjetà tal-kostruttur tal-plugin. Per eżempju, għall-plugin tooltip:

$.fn.tooltip.Constructor.VERSION // => "4.4.1"

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.

Util

Il-fajls JavaScript kollha ta' Bootstrap jiddependu fuq util.jsu għandu jiġi inkluż flimkien mal-fajls JavaScript l-oħra. Jekk qed tuża l-ikkumpilat (jew imminifikat) bootstrap.js, m'hemmx għalfejn tinkludi dan—diġà qiegħed hemm.

util.jsjinkludi funzjonijiet ta 'utilità u helper bażiku għall- transitionEndavvenimenti kif ukoll emulatur ta' transizzjoni CSS. Jintuża mill-plugins l-oħra biex jiċċekkja l-appoġġ tat-tranżizzjoni CSS u biex jaqbad transizzjonijiet imdendlin.

Sanitizer

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

Il-valur default whiteListhuwa dan li ġej:

var ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
var DefaultWhitelist = {
  // 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', '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 whiteListtista' tagħmel dan li ġej:

var myDefaultWhiteList = $.fn.tooltip.Constructor.Default.whiteList

// To allow table elements
myDefaultWhiteList.table = []

// To allow td elements and data-option attributes on td elements
myDefaultWhiteList.td = ['data-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-]+/
myDefaultWhiteList['*'].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:

$('#yourTooltip').tooltip({
  sanitizeFn: function (content) {
    return DOMPurify.sanitize(content)
  }
})