JavaScript

Оживіть Bootstrap за допомогою наших додаткових плагінів JavaScript, створених на основі jQuery. Дізнайтеся про кожен плагін, наші дані та параметри програмного API тощо.

Індивідуальний або складений

Плагіни можна включати окремо (за допомогою Bootstrap individual js/dist/*.js) або всі одночасно за допомогою bootstrap.jsабо мінімізованого bootstrap.min.js(не включайте обидва).

Якщо ви використовуєте збірник (Webpack, Rollup…), ви можете використовувати /js/dist/*.jsфайли, готові до UMD.

Залежності

Деякі плагіни та компоненти CSS залежать від інших плагінів. Якщо ви включаєте плагіни окремо, обов’язково перевірте наявність цих залежностей у документах. Також зауважте, що всі плагіни залежать від jQuery (це означає, що jQuery має бути включено перед файлами плагінів). Зверніться до насpackage.json , щоб дізнатися, які версії jQuery підтримуються.

Наші спадні списки, спливаючі вікна та підказки також залежать від Popper.js .

Атрибути даних

Майже всі плагіни Bootstrap можна ввімкнути та налаштувати лише за допомогою HTML за допомогою атрибутів даних (наш бажаний спосіб використання функцій JavaScript). Обов’язково використовуйте лише один набір атрибутів даних для одного елемента (наприклад, ви не можете викликати спливаючу підказку та модаль з однієї кнопки).

Однак у деяких ситуаціях може бути бажаним вимкнути цю функцію. Щоб вимкнути API атрибутів даних, розв’яжіть усі події в просторі імен документа data-apiтак:

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

Крім того, щоб націлити певний плагін, просто додайте назву плагіна як простір імен разом із простором імен data-api, як це:

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

Події

Bootstrap надає спеціальні події для більшості унікальних дій плагінів. Як правило, вони мають форму інфінітива та дієприкметника минулого часу, де інфінітив (наприклад. show) активується на початку події, а його форма дієприкметника минулого часу (наприклад. shown) — після завершення дії.

Усі інфінітивні події забезпечують preventDefault()функціональність. Це надає можливість зупинити виконання дії до її початку. Повернення false з обробника подій також призведе до автоматичного виклику preventDefault().

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

Програмний API

Ми також вважаємо, що ви повинні мати можливість використовувати всі плагіни Bootstrap виключно через JavaScript API. Усі загальнодоступні API є єдиними методами, які можна зв’язати, і повертають колекцію, на яку діють.

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

Усі методи повинні приймати необов’язковий об’єкт параметрів, рядок, який націлений на певний метод, або нічого (що ініціює плагін із типовою поведінкою):

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

Кожен плагін також надає свій необроблений конструктор у Constructorвластивості: $.fn.popover.Constructor. Якщо ви хочете отримати певний екземпляр плагіна, отримайте його безпосередньо з елемента: $('[rel="popover"]').data('popover').

Асинхронні функції та переходи

Усі програмні методи API є асинхронними та повертаються до викликаючого, щойно перехід розпочато, але до його завершення .

Щоб виконати дію після завершення переходу, ви можете прослухати відповідну подію.

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

Крім того, виклик методу компонента, що переходить, буде проігноровано .

$('#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 !!

Налаштування за замовчуванням

Ви можете змінити параметри за замовчуванням для плагіна, змінивши Constructor.Defaultоб’єкт плагіна:

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

Жодного конфлікту

Іноді необхідно використовувати плагіни Bootstrap з іншими фреймворками інтерфейсу користувача. За таких обставин час від часу можуть виникати конфлікти простору імен. Якщо це станеться, ви можете викликати .noConflictплагін, значення якого хочете повернути.

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

Номери версій

Доступ до версії кожного плагіна jQuery Bootstrap можна отримати через VERSIONвластивість конструктора плагіна. Наприклад, для плагіна підказки:

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

Немає спеціальних резервних варіантів, коли JavaScript вимкнено

Плагіни Bootstrap не повертаються особливо витончено, коли JavaScript вимкнено. Якщо ви дбаєте про взаємодію з користувачем у цьому випадку, використовуйте, <noscript>щоб пояснити ситуацію (і як повторно ввімкнути JavaScript) своїм користувачам, і/або додайте власні запасні варіанти.

Util

Усі файли JavaScript Bootstrap залежать від util.jsі мають бути включені разом з іншими файлами JavaScript. Якщо ви використовуєте скомпільований (або мінімізований) bootstrap.js, немає потреби включати це — воно вже є.

util.jsмістить службові функції та базовий помічник для transitionEndподій, а також емулятор переходу CSS. Він використовується іншими плагінами для перевірки підтримки переходів CSS і для виявлення завислих переходів.

Санітайзер

У підказках і спливаючих вікнах використовується наш вбудований засіб очищення для очищення параметрів, які підтримують HTML.

Значення за замовчуванням whiteListтаке:

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

Якщо ви хочете додати нові значення до цього стандартного значення, whiteListви можете зробити наступне:

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)

Якщо ви хочете обійти наш дезінфікуючий засіб, тому що ви віддаєте перевагу використанню спеціальної бібліотеки, наприклад DOMPurify , ви повинні зробити наступне:

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