JavaScript

Individu atau disusun

Pemalam boleh disertakan secara individu (menggunakan individu Bootstrap js/dist/*.js), atau sekali gus menggunakan bootstrap.jsatau diperkecilkan bootstrap.min.js(jangan sertakan kedua-duanya).

Jika anda menggunakan pengikat (Webpack, Rollup…), anda boleh menggunakan /js/dist/*.jsfail yang sedia UMD.

Menggunakan Bootstrap sebagai modul

Kami menyediakan versi Bootstrap yang dibina sebagai ESM( bootstrap.esm.jsdan bootstrap.esm.min.js) yang membolehkan anda menggunakan Bootstrap sebagai modul dalam penyemak imbas anda, jika pelayar sasaran anda menyokongnya .

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

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

Kebergantungan

Sesetengah pemalam dan komponen CSS bergantung pada pemalam lain. Jika anda memasukkan pemalam secara individu, pastikan anda menyemak kebergantungan ini dalam dokumen.

Dropdown, popover dan petua alat kami juga bergantung pada Popper .

Masih mahu menggunakan jQuery? Ada kemungkinan!

Bootstrap 5 direka bentuk untuk digunakan tanpa jQuery, tetapi masih boleh menggunakan komponen kami dengan jQuery. Jika Bootstrap mengesan jQuerydalam windowobjek , ia akan menambah semua komponen kami dalam sistem pemalam jQuery; ini bermakna anda boleh lakukan $('[data-bs-toggle="tooltip"]').tooltip()untuk mendayakan petua alat. Begitu juga dengan komponen kami yang lain.

Atribut data

Hampir semua pemalam Bootstrap boleh didayakan dan dikonfigurasikan melalui HTML sahaja dengan atribut data (cara pilihan kami untuk menggunakan fungsi JavaScript). Pastikan anda hanya menggunakan satu set atribut data pada satu elemen (cth, anda tidak boleh mencetuskan petua alat dan modal daripada butang yang sama.)

Peristiwa

Bootstrap menyediakan acara tersuai untuk kebanyakan tindakan unik pemalam. Secara amnya, ini datang dalam bentuk infinitif dan participle lepas - di mana infinitif (cth. show) dicetuskan pada permulaan acara, dan bentuk participle past (cth. shown) dicetuskan apabila selesai tindakan.

Semua peristiwa infinitif menyediakan preventDefault()fungsi. Ini memberikan keupayaan untuk menghentikan pelaksanaan tindakan sebelum ia bermula. Mengembalikan palsu daripada pengendali acara juga akan memanggil secara automatik 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 Programmatik

Semua pembina menerima objek pilihan pilihan atau tiada apa-apa (yang memulakan pemalam dengan tingkah laku lalainya):

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

Jika anda ingin mendapatkan contoh pemalam tertentu, setiap pemalam mendedahkan getInstancekaedah. Untuk mendapatkannya terus daripada elemen, lakukan ini: bootstrap.Popover.getInstance(myPopoverEl).

Pemilih CSS dalam pembina

Anda juga boleh menggunakan pemilih CSS sebagai hujah pertama dan bukannya elemen DOM untuk memulakan pemalam. Pada masa ini elemen untuk pemalam ditemui mengikut querySelectorkaedah kerana pemalam kami menyokong satu elemen sahaja.

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

Fungsi dan peralihan tak segerak

Semua kaedah API terprogram adalah tak segerak dan kembali kepada pemanggil sebaik sahaja peralihan dimulakan tetapi sebelum ia tamat .

Untuk melaksanakan tindakan setelah peralihan selesai, anda boleh mendengar acara yang sepadan.

var myCollapseEl = document.getElementById('myCollapse')

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

Di samping itu panggilan kaedah pada komponen peralihan akan diabaikan .

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

Tetapan lalai

Anda boleh menukar tetapan lalai untuk pemalam dengan mengubah suai Constructor.Defaultobjek pemalam:

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

Tiada konflik (hanya jika anda menggunakan jQuery)

Kadangkala perlu menggunakan pemalam Bootstrap dengan rangka kerja UI yang lain. Dalam keadaan ini, perlanggaran ruang nama kadangkala boleh berlaku. Jika ini berlaku, anda boleh menghubungi .noConflictpemalam yang ingin anda kembalikan nilainya.

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

Nombor versi

Versi setiap pemalam Bootstrap boleh diakses melalui hak VERSIONmilik pembina pemalam. Sebagai contoh, untuk pemalam petua alat:

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

Tiada sandaran khas apabila JavaScript dilumpuhkan

Pemalam Bootstrap tidak akan kembali dengan sangat anggun apabila JavaScript dilumpuhkan. Jika anda mengambil berat tentang pengalaman pengguna dalam kes ini, gunakan <noscript>untuk menerangkan situasi (dan cara mendayakan semula JavaScript) kepada pengguna anda dan/atau menambah sandaran tersuai anda sendiri.

Sanitizer

Petua alat dan Popovers menggunakan sanitizer terbina dalam kami untuk membersihkan pilihan yang menerima HTML.

Nilai lalai allowListadalah seperti berikut:

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

Jika anda ingin menambah nilai baharu pada lalai ini allowList, anda boleh melakukan perkara berikut:

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)

Jika anda ingin memintas sanitizer kami kerana anda lebih suka menggunakan perpustakaan khusus, contohnya DOMPuify , anda harus melakukan perkara berikut:

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