JavaScript

Dewch â Bootstrap yn fyw gyda'n ategion JavaScript dewisol wedi'u hadeiladu ar jQuery. Dysgwch am bob ategyn, ein data a'n hopsiynau API rhaglennol, a mwy.

Unigol neu wedi'i lunio

Gellir cynnwys ategion yn unigol (gan ddefnyddio unigolyn Bootstrap js/dist/*.js), neu i gyd ar unwaith gan ddefnyddio bootstrap.jsneu'r miniified bootstrap.min.js(peidiwch â chynnwys y ddau).

Os ydych chi'n defnyddio bwndelwr (Webpack, Rollup…), gallwch ddefnyddio /js/dist/*.jsffeiliau sy'n barod ar gyfer UMD.

Dibyniaethau

Mae rhai ategion a chydrannau CSS yn dibynnu ar ategion eraill. Os ydych chi'n cynnwys ategion yn unigol, gwnewch yn siŵr eich bod chi'n gwirio am y dibyniaethau hyn yn y dogfennau. Sylwch hefyd fod pob ategyn yn dibynnu ar jQuery (mae hyn yn golygu bod yn rhaid cynnwys jQuery cyn y ffeiliau ategyn). Ymgynghorwch â'npackage.json i weld pa fersiynau o jQuery sy'n cael eu cefnogi.

Mae ein cwymplenni, popovers a chyngor hefyd yn dibynnu ar Popper.js .

Priodoleddau data

Gellir galluogi a ffurfweddu bron pob ategyn Bootstrap trwy HTML yn unig gyda phriodoleddau data (ein hoff ffordd o ddefnyddio ymarferoldeb JavaScript). Gwnewch yn siŵr eich bod chi'n defnyddio un set o briodoleddau data ar un elfen yn unig (ee, ni allwch sbarduno cyngor a moddol o'r un botwm.)

Fodd bynnag, mewn rhai sefyllfaoedd gall fod yn ddymunol analluogi'r swyddogaeth hon. I analluogi'r API priodoledd data, dadrwymo'r holl ddigwyddiadau ar y ddogfen sydd wedi'i bylchu gyda data-apitebyg:

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

Fel arall, i dargedu ategyn penodol, dylech gynnwys enw'r ategyn fel gofod enw ynghyd â gofod enw data-api fel hyn:

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

Digwyddiadau

Mae Bootstrap yn darparu digwyddiadau wedi'u teilwra ar gyfer gweithredoedd unigryw'r mwyafrif o ategion. Yn gyffredinol, daw’r rhain ar ffurf berfenw a chyfranogiad y gorffennol – lle mae’r berfenw (ex. show) yn cael ei sbarduno ar ddechrau digwyddiad, a’i ffurf cyfranogwr yn y gorffennol (ex. shown) yn cael ei sbarduno wrth gwblhau gweithred.

Mae pob digwyddiad berfenw yn darparu preventDefault()ymarferoldeb. Mae hyn yn rhoi'r gallu i atal cyflawni gweithred cyn iddo ddechrau. Bydd dychwelyd ffug gan drafodwr digwyddiad hefyd yn galw'n awtomatig preventDefault().

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

API rhaglennol

Rydyn ni hefyd yn credu y dylech chi allu defnyddio'r holl ategion Bootstrap trwy'r API JavaScript yn unig. Mae pob API cyhoeddus yn ddulliau sengl, cadwynadwy, ac yn dychwelyd y casgliad y gweithredwyd arno.

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

Dylai pob dull dderbyn gwrthrych opsiynau dewisol, llinyn sy'n targedu dull penodol, neu ddim byd (sy'n cychwyn ategyn ag ymddygiad diofyn):

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

Mae pob ategyn hefyd yn datgelu ei adeiladwr amrwd ar Constructorbriodwedd: $.fn.popover.Constructor. Os hoffech gael enghraifft ategyn penodol, adalw ef yn uniongyrchol o elfen: $('[rel="popover"]').data('popover').

Swyddogaethau a thrawsnewidiadau anghydamserol

Mae pob dull API rhaglennol yn anghydamserol ac yn dychwelyd at y galwr unwaith y bydd y trawsnewid wedi dechrau ond cyn iddo ddod i ben .

Er mwyn cyflawni gweithred unwaith y bydd y trawsnewid wedi'i gwblhau, gallwch wrando ar y digwyddiad cyfatebol.

$('#myCollapse').on('shown.bs.collapse', function (event) {
  // Action to execute once the collapsible area is expanded
})

Yn ogystal, anwybyddir galwad dull ar gydran trawsnewid .

$('#myCarousel').on('slid.bs.carousel', function (event) {
  $('#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 !!

Gosodiadau diofyn

Gallwch newid y gosodiadau diofyn ar gyfer ategyn trwy addasu Constructor.Defaultgwrthrych yr ategyn:

// changes default for the modal plugin's `keyboard` option to false
$.fn.modal.Constructor.Default.keyboard = false

Dim gwrthdaro

Weithiau mae angen defnyddio ategion Bootstrap gyda fframweithiau UI eraill. O dan yr amgylchiadau hyn, gall gwrthdrawiadau gofod enwau ddigwydd o bryd i'w gilydd. Os bydd hyn yn digwydd, gallwch chi alw .noConflictar yr ategyn yr ydych am ddychwelyd ei werth.

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

Rhifau fersiynau

Gellir cyrchu fersiwn pob un o ategion jQuery Bootstrap trwy VERSIONeiddo adeiladwr yr ategyn. Er enghraifft, ar gyfer yr ategyn cyngor offer:

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

Dim wrth gefn arbennig pan fydd JavaScript yn anabl

Nid yw ategion Bootstrap yn disgyn yn ôl yn arbennig o osgeiddig pan fydd JavaScript wedi'i analluogi. Os ydych chi'n poeni am brofiad y defnyddiwr yn yr achos hwn, defnyddiwch <noscript>i egluro'r sefyllfa (a sut i ail-alluogi JavaScript) i'ch defnyddwyr, a / neu ychwanegu eich wrth gefn personol eich hun.

Util

Mae holl ffeiliau JavaScript Bootstrap yn dibynnu ar util.jsac mae'n rhaid ei gynnwys ochr yn ochr â'r ffeiliau JavaScript eraill. Os ydych chi'n defnyddio'r ysgrifbinedig (neu finified) bootstrap.js, nid oes angen cynnwys hyn - mae yno eisoes.

util.jsyn cynnwys swyddogaethau cyfleustodau a chynorthwyydd sylfaenol ar gyfer transitionEnddigwyddiadau yn ogystal ag efelychydd trawsnewid CSS. Fe'i defnyddir gan yr ategion eraill i wirio am gefnogaeth trawsnewid CSS ac i ddal trawsnewidiadau crog.

Glanweithydd

Mae Tooltips a Popovers yn defnyddio ein glanweithydd adeiledig i lanweithio opsiynau sy'n derbyn HTML.

Y gwerth diofyn whiteListyw'r canlynol:

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', 'srcset', 'alt', 'title', 'width', 'height'],
  li: [],
  ol: [],
  p: [],
  pre: [],
  s: [],
  small: [],
  span: [],
  sub: [],
  sup: [],
  strong: [],
  u: [],
  ul: []
}

Os ydych am ychwanegu gwerthoedd newydd at y rhagosodiad hwn whiteListgallwch wneud y canlynol:

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)

Os ydych chi am osgoi ein glanweithydd oherwydd bod yn well gennych chi ddefnyddio llyfrgell bwrpasol, er enghraifft DOMPurify , dylech chi wneud y canlynol:

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