JavaScript

บุคคลหรือรวบรวม

ปลั๊กอินสามารถรวมเป็นรายบุคคลได้ (โดยใช้บุคคลของ Bootstrap js/dist/*.js) หรือรวมเข้าด้วยกันโดยใช้bootstrap.jsหรือย่อขนาดbootstrap.min.js(ไม่รวมทั้งสองอย่าง)

หากคุณใช้บันเดิล (Webpack, Rollup…) คุณสามารถใช้/js/dist/*.jsไฟล์ที่พร้อม UMD ได้

การใช้ Bootstrap เป็นโมดูล

เรามีเวอร์ชันของ Bootstrap ที่สร้างเป็นESM( bootstrap.esm.jsและbootstrap.esm.min.js) ซึ่งช่วยให้คุณใช้ Bootstrap เป็นโมดูลในเบราว์เซอร์ของคุณได้ หากเบราว์เซอร์เป้าหมายของ คุณรองรับ

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

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

การพึ่งพา

ปลั๊กอินและส่วนประกอบ CSS บางตัวขึ้นอยู่กับปลั๊กอินอื่นๆ หากคุณรวมปลั๊กอินแต่ละรายการ ตรวจสอบให้แน่ใจว่าได้ตรวจสอบการขึ้นต่อกันเหล่านี้ในเอกสาร

ดรอปดาวน์ ป๊อปโอเวอร์ และคำแนะนำเครื่องมือของเราก็ขึ้นอยู่กับPopperด้วย

ยังต้องการใช้ jQuery? มันเป็นไปได้!

Bootstrap 5 ได้รับการออกแบบมาให้ใช้งานโดยไม่มี jQuery แต่ก็ยังสามารถใช้ส่วนประกอบของเรากับ jQuery ได้ หาก Bootstrap ตรวจพบjQueryในwindowวัตถุมันจะเพิ่มส่วนประกอบทั้งหมดของเราในระบบปลั๊กอินของ jQuery ซึ่งหมายความว่าคุณจะสามารถ$('[data-bs-toggle="tooltip"]').tooltip()เปิดใช้งานคำแนะนำเครื่องมือได้ เช่นเดียวกับองค์ประกอบอื่นๆ ของเรา

แอตทริบิวต์ข้อมูล

ปลั๊กอิน Bootstrap เกือบทั้งหมดสามารถเปิดใช้งานแล���กำหนดค่าผ่าน HTML เพียงอย่างเดียวด้วยแอตทริบิวต์ข้อมูล (วิธีที่เราต้องการในการใช้ฟังก์ชัน JavaScript) ตรวจสอบให้แน่ใจว่าใช้แอตทริบิวต์ข้อมูลเพียงชุดเดียวในองค์ประกอบเดียว (เช่น คุณไม่สามารถเรียกใช้คำแนะนำเครื่องมือและโมดอลจากปุ่มเดียวกันได้)

เหตุการณ์

Bootstrap จัดเตรียมเหตุการณ์ที่กำหนดเองสำหรับการกระทำเฉพาะของปลั๊กอินส่วนใหญ่ โดยทั่วไป สิ่งเหล่านี้มาในรูปแบบกริยาแบบ infinitive และ past participle โดยที่ infinitive (เช่นshow) จะถูกทริกเกอร์เมื่อเริ่มต้นเหตุการณ์ และรูปแบบกริยาที่ผ่านมา (ex. shown) จะถูกทริกเกอร์เมื่อการดำเนินการเสร็จสิ้น

เหตุการณ์ infinitive ทั้งหมดมีpreventDefault()ฟังก์ชันการทำงาน สิ่งนี้ทำให้สามารถหยุดการดำเนินการก่อนที่จะเริ่ม การคืน ค่าเท็จจากตัวจัดการเหตุการณ์จะเรียกโดยอัตโนมัติ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 แบบเป็นโปรแกรม

ตัวสร้างทั้งหมดยอมรับอ็อบเจ็กต์ตัวเลือกที่เป็นตัวเลือกหรือไม่มีเลย (ซึ่งเริ่มต้นปลั๊กอินด้วยการทำงานเริ่มต้น):

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

หากคุณต้องการได้รับอินสแตนซ์ของปลั๊กอินบางตัว ปลั๊กอินแต่ละตัวจะแสดงgetInstanceวิธีการ ในการดึงข้อมูลโดยตรงจากองค์ประกอบ ให้ทำbootstrap.Popover.getInstance(myPopoverEl)ดังนี้

ตัวเลือก CSS ในตัวสร้าง

คุณยังสามารถใช้ตัวเลือก CSS เป็นอาร์กิวเมนต์แรกแทนองค์ประกอบ DOM เพื่อเริ่มต้นปลั๊กอินได้ ขณะนี้องค์ประกอบสำหรับปลั๊กอินถูกค้นพบโดยquerySelectorวิธีการเนื่องจากปลั๊กอินของเราสนับสนุนองค์ประกอบเดียวเท่านั้น

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

ฟังก์ชันและการเปลี่ยนแบบอะซิงโครนัส

เมธอด API แบบเป็นโปรแกรมทั้งหมดเป็นแบบอะซิงโครนัสและกลับไปยังผู้เรียกเมื่อการเปลี่ยนแปลงเริ่มต้น แต่ ก่อน ที่จะสิ้นสุด

ในการดำเนินการเมื่อการเปลี่ยนแปลงเสร็จสิ้น คุณสามารถฟังเหตุการณ์ที่เกี่ยวข้องได้

var myCollapseEl = document.getElementById('myCollapse')

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

นอกจากนี้ การเรียกเมธอดในองค์ประกอบการเปลี่ยนจะถูกละเว้น

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

การตั้งค่าเริ่มต้น

คุณสามารถเปลี่ยนการตั้งค่าเริ่มต้นสำหรับปลั๊กอินโดยแก้ไขConstructor.Defaultวัตถุของปลั๊กอิน:

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

ไม่มีข้อขัดแย้ง (เฉพาะเมื่อคุณใช้ jQuery)

บางครั้ง จำเป็นต้องใช้ปลั๊กอิน Bootstrap กับเฟรมเวิร์ก UI อื่นๆ ในสถานการณ์เหล่านี้ การชนกันของเนมสเปซอาจเกิดขึ้นในบางครั้ง หากเกิดเหตุการณ์นี้ขึ้น คุณสามารถเรียก.noConflictใช้ปลั๊กอินที่คุณต้องการคืนค่า

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

หมายเลขเวอร์ชัน

เวอร์ชันของปลั๊กอินแต่ละปลั๊กอินของ Bootstrap สามารถเข้าถึงได้ผ่านVERSIONคุณสมบัติของตัวสร้างของปลั๊กอิน ตัวอย่างเช่น สำหรับปลั๊กอินคำแนะนำเครื่องมือ:

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

ไม่มีทางเลือกพิเศษเมื่อปิดใช้งาน JavaScript

ปลั๊กอินของ Bootstrap จะไม่ถอยกลับโดยเฉพาะอย่างยิ่งเมื่อปิดการใช้งาน JavaScript หากคุณสนใจเกี่ยวกับประสบการณ์ของผู้ใช้ในกรณีนี้ ใช้<noscript>เพื่ออธิบายสถานการณ์ (และวิธีเปิดใช้งาน JavaScript อีกครั้ง) ให้กับผู้ใช้ของคุณ และ/หรือเพิ่มทางเลือกที่คุณกำหนดเอง

น้ำยาฆ่าเชื้อ

คำแนะนำเครื่องมือและ Popovers ใช้น้ำยาฆ่าเชื้อในตัวของเราเพื่อล้างตัวเลือกที่ยอมรับ HTML

ค่าเริ่มต้นallowListมีดังต่อไปนี้:

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

หากคุณต้องการเพิ่มค่าใหม่ให้กับค่าเริ่มต้นนี้allowListคุณสามารถดำเนินการดังต่อไปนี้:

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)

หากคุณต้องการเลี่ยงการฆ่าเชื้อของเรา เนื่องจากคุณต้องการใช้ห้องสมุดเฉพาะ เช่นDOMPurifyคุณควรดำเนินการดังต่อไปนี้:

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