JavaScript

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.

Defnyddio Bootstrap fel modiwl

Rydym yn darparu fersiwn o Bootstrap a adeiladwyd fel ESM( bootstrap.esm.jsand bootstrap.esm.min.js) sy'n eich galluogi i ddefnyddio Bootstrap fel modiwl yn eich porwr, os yw eich porwyr targed yn ei gefnogi .

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

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

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.

Mae ein cwymplenni, ein popovers a'n cynghorion offer hefyd yn dibynnu ar Popper .

Dal eisiau defnyddio jQuery? Mae'n bosib!

Mae Bootstrap 5 wedi'i gynllunio i'w ddefnyddio heb jQuery, ond mae'n dal yn bosibl defnyddio ein cydrannau gyda jQuery. Os bydd Bootstrap jQueryyn canfod y windowgwrthrych , bydd yn ychwanegu ein holl gydrannau yn system ategion jQuery; mae hyn yn golygu y byddwch chi'n gallu ei wneud $('[data-bs-toggle="tooltip"]').tooltip()i alluogi cynghorion offer. Mae'r un peth yn wir am ein cydrannau eraill.

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

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

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 rhaglennol

Mae pob adeiladwr yn derbyn gwrthrych opsiynau dewisol neu ddim (sy'n cychwyn ategyn gyda'i ymddygiad diofyn):

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

Os hoffech chi gael enghraifft ategyn penodol, mae pob ategyn yn datgelu getInstancedull. Er mwyn ei adfer yn uniongyrchol o elfen, gwnewch hyn: bootstrap.Popover.getInstance(myPopoverEl).

Dewiswyr CSS mewn adeiladwyr

Gallwch hefyd ddefnyddio dewisydd CSS fel y ddadl gyntaf yn lle elfen DOM i gychwyn yr ategyn. Ar hyn o bryd mae'r elfen ar gyfer yr ategyn yn cael ei ddarganfod gan y querySelectordull gan fod ein ategion yn cefnogi un elfen yn unig.

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

Swyddogaethau a thrawsnewidiadau asyncronaidd

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.

var myCollapseEl = document.getElementById('myCollapse')

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

Yn ogystal, anwybyddir galwad dull ar gydran trawsnewid .

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

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
bootstrap.Modal.Default.keyboard = false

Dim gwrthdaro (dim ond os ydych chi'n defnyddio jQuery)

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 Bootstrap trwy VERSIONeiddo adeiladwr yr ategyn. Er enghraifft, ar gyfer yr ategyn cyngor offer:

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

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.

Glanweithydd

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

Y gwerth diofyn allowListyw'r canlynol:

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

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

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)

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

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