JavaScript

Կյանքի կոչեք Bootstrap-ը մեր կամընտիր JavaScript հավելվածների միջոցով: Իմացեք յուրաքանչյուր հավելվածի, մեր տվյալների և ծրագրային API-ի ընտրանքների և ավելին:

Այս էջում

Անհատական կամ կազմված

Փլագինները կարող են ներառվել առանձին (օգտագործելով Bootstrap-ի անհատականությունը js/dist/*.js), կամ միանգամից՝ օգտագործելով bootstrap.jsկամ փոքրացված bootstrap.min.js(մի՛ ներառեք երկուսն էլ):

Եթե դուք օգտագործում եք փաթեթ (Webpack, Parcel, Vite…), կարող եք օգտագործել /js/dist/*.jsֆայլեր, որոնք պատրաստ են UMD-ին:

Օգտագործում JavaScript շրջանակներով

Թեև Bootstrap CSS-ը կարող է օգտագործվել ցանկացած շրջանակի հետ, Bootstrap JavaScript-ը լիովին համատեղելի չէ JavaScript շրջանակների հետ, ինչպիսիք են React, Vue և Angular , որոնք ենթադրում են DOM-ի ամբողջական իմացություն: Ե՛վ Bootstrap-ը, և՛ շրջանակը կարող են փորձել մուտացիայի ենթարկել նույն DOM տարրը, ինչի հետևանքով առաջանում են սխալներ, ինչպիսիք են բացվող պատուհանները, որոնք խրված են «բաց» դիրքում:

Այս տեսակի շրջանակներ օգտագործողների համար ավելի լավ այլընտրանք է Bootstrap JavaScript-ի փոխարեն շրջանակի հատուկ փաթեթ օգտագործելը: Ահա ամենահայտնի տարբերակներից մի քանիսը.

React. React Bootstrap
Vue: BootstrapVue (ներկայումս աջակցում է միայն Vue 2 և Bootstrap 4)
Անկյունային՝ ng-bootstrap

Օգտագործելով Bootstrap որպես մոդուլ

Փորձեք ինքներդ: Ներբեռնեք սկզբնական կոդը և աշխատանքային ցուցադրությունը՝ Bootstrap-ը որպես ES մոդուլ օգտագործելու համար twbs/examples պահոցից : Դուք կարող եք նաև բացել օրինակը StackBlitz-ում :

Մենք տրամադրում ենք 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>

Համեմատած JS փաթեթների հետ, բրաուզերում ESM-ի օգտագործումը պահանջում է, որ մոդուլի անվան փոխարեն օգտագործեք ամբողջական ուղին և ֆայլի անունը: Կարդացեք ավելին JS մոդուլների մասին բրաուզերում: Դրա համար մենք օգտագործում ենք վերևի 'bootstrap.esm.min.js'փոխարեն : 'bootstrap'Այնուամենայնիվ, սա ավելի է բարդանում մեր Popper կախվածությունից, որը ներմուծում է Popper-ը մեր JavaScript-ում այսպես.

import * as Popper from "@popperjs/core"

Եթե փորձեք սա այնպես, ինչպես կա, ապա վահանակում կտեսնեք հետևյալ սխալը.

Uncaught TypeError: Failed to resolve module specifier "@popperjs/core". Relative references must start with either "/", "./", or "../".

Դա շտկելու համար դուք կարող եք օգտագործել importmapկամայական մոդուլների անունները լուծելու ուղիները ավարտելու համար: Եթե ձեր թիրախավորված բրաուզերները չեն աջակցում importmap, դուք պետք է օգտագործեք es-module-shims նախագիծը: Ահա թե ինչպես է այն աշխատում Bootstrap-ի և Popper-ի համար.

<!doctype html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-iYQeCzEYFbKjA/T2uDLTpkwGzCiq6soy8tYaI1GyVh/UjpbCx/TYkiZhlZB6+fzT" crossorigin="anonymous">
    <title>Hello, modularity!</title>
  </head>
  <body>
    <h1>Hello, modularity!</h1>
    <button id="popoverButton" type="button" class="btn btn-primary btn-lg" class="btn btn-lg btn-danger" data-bs-toggle="popover" title="ESM in Browser" data-bs-content="Bang!">Custom popover</button>

    <script async src="https://cdn.jsdelivr.net/npm/es-module-shims@1/dist/es-module-shims.min.js" crossorigin="anonymous"></script>
    <script type="importmap">
    {
      "imports": {
        "@popperjs/core": "https://cdn.jsdelivr.net/npm/@popperjs/[email protected]/dist/umd/popper.min.js",
        "bootstrap": "https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.esm.min.js"
      }
    }
    </script>
    <script type="module">
      import * as bootstrap from 'bootstrap'

      new bootstrap.Popover(document.getElementById('popoverButton'))
    </script>
  </body>
</html>

Կախվածություններ

Որոշ պլագիններ և CSS բաղադրիչներ կախված են այլ պլագիններից: Եթե դուք ներառում եք պլագիններ առանձին-առանձին, համոզվեք, որ ստուգեք այս կախվածությունները փաստաթղթերում:

Մեր բացվող էջերը, popover-ները և գործիքների հուշումները նույնպես կախված են Popper- ից :

Տվյալների հատկանիշներ

Գրեթե բոլոր Bootstrap պլագինները կարող են միացվել և կազմաձևվել միայն HTML-ի միջոցով՝ տվյալների ատրիբուտներով (JavaScript-ի ֆունկցիոնալությունը օգտագործելու մեր նախընտրելի եղանակը): Համոզվեք, որ միայն մեկ տարրի վրա օգտագործեք տվյալների ատրիբուտների միայն մեկ հավաքածու (օրինակ, դուք չեք կարող գործարկել գործիքի հուշում և մոդալ նույն կոճակից):

Քանի որ ընտրանքները կարող են փոխանցվել տվյալների ատրիբուտների կամ JavaScript-ի միջոցով, կարող եք տարբերակի անուն ավելացնել data-bs-, ինչպես օրինակում data-bs-animation="{value}": Համոզվեք, որ փոխեք տարբերակի անվան պատյանների տեսակը « camelCase »-ից « kebab-case »՝ ընտրանքները տվյալների ատրիբուտների միջոցով փոխանցելիս: Օրինակ՝ օգտագործել data-bs-custom-class="beautifier"փոխարենը data-bs-customClass="beautifier":

Bootstrap 5.2.0-ի դրությամբ բոլոր բաղադրիչներն աջակցում են փորձարարական վերապահված տվյալների հատկանիշ data-bs-config, որը կարող է տեղավորել պարզ բաղադրիչի կազմաձևումը որպես JSON տող: Երբ տարրն ունի data-bs-config='{"delay":0, "title":123}'և data-bs-title="456"ատրիբուտներ, վերջնական titleարժեքը կլինի, 456և առանձին տվյալների ատրիբուտները կգերակայեն .-ին տրված արժեքներին data-bs-config: Բացի այդ, առկա տվյալների ատրիբուտները կարող են տեղավորել JSON արժեքներ, ինչպիսիք են data-bs-delay='{"show":0,"hide":150}'.

Ընտրիչներ

Մենք օգտագործում ենք բնօրինակը querySelectorև querySelectorAllմեթոդները DOM-ի տարրերը կատարողականի նկատառումներով հարցումներ կատարելու համար, այնպես որ դուք պետք է օգտագործեք վավեր ընտրիչներ : Եթե դուք օգտագործում եք հատուկ ընտրիչներ, ինչպիսիք collapse:Exampleեն , համոզվեք, որ փախեք դրանցից:

Իրադարձություններ

Bootstrap-ն ապահովում է հարմարեցված իրադարձություններ փլագինների մեծ մասի եզակի գործողությունների համար: Ընդհանրապես, դրանք գալիս են ինֆինիտիվ և անցյալ մասնակցային ձևով, որտեղ ինֆինիտիվը (նախ. show) գործարկվում է իրադարձության սկզբում, իսկ նրա անցյալ մասնակցային ձևը ( նախ. shown) գործարկվում է գործողության ավարտից հետո:

Բոլոր անվերջ իրադարձությունները ապահովում են preventDefault()ֆունկցիոնալություն: Սա հնարավորություն է տալիս դադարեցնել գործողությունների կատարումը նախքան այն սկսելը: Իրադարձությունների մշակիչից false վերադարձնելու դեպքում նաև ավտոմատ կերպով կկանչվի preventDefault():

const myModal = document.querySelector('#myModal')

myModal.addEventListener('show.bs.modal', event => {
  if (!data) {
    return event.preventDefault() // stops modal from being shown
  }
})

Ծրագրային API

Բոլոր կոնստրուկտորներն ընդունում են կամընտիր ընտրանքների օբյեկտ կամ ոչինչ (որը սկսում է plugin իր լռելյայն վարքով).

const myModalEl = document.querySelector('#myModal')

const modal = new bootstrap.Modal(myModalEl) // initialized with defaults

const configObject = { keyboard: false }
const modal1 = new bootstrap.Modal(myModalEl, configObject) // initialized with no keyboard

Եթե ցանկանում եք ստանալ հատուկ plugin-ի օրինակ, յուրաքանչյուր փլագին բացահայտում է մի getInstanceմեթոդ: Օրինակ, օրինակը անմիջապես տարրից առբերելու համար.

bootstrap.Popover.getInstance(myPopoverEl)

Այս մեթոդը կվերադառնա null, եթե օրինակ չգործարկվի պահանջվող տարրի վրա:

Որպես այլընտրանք, getOrCreateInstanceկարող է օգտագործվել DOM տարրի հետ կապված օրինակ ստանալու համար կամ ստեղծել նորը, եթե այն սկզբնավորվել չէ:

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

Այն դեպքում, երբ օրինակը չի սկզբնավորվել, այն կարող է ընդունել և օգտագործել կամընտիր կազմաձևման օբյեկտ որպես երկրորդ արգումենտ:

CSS ընտրիչներ կոնստրուկտորներում

Բացի getInstanceև getOrCreateInstanceմեթոդներից, plugin-ի բոլոր կոնստրուկտորները կարող են ընդունել DOM տարրը կամ վավեր CSS ընտրիչը որպես առաջին փաստարկ: Plugin-ի տարրերը հայտնաբերվել են querySelectorմեթոդով, քանի որ մեր պլագիններն աջակցում են միայն մեկ տարր:

const modal = new bootstrap.Modal('#myModal')
const dropdown = new bootstrap.Dropdown('[data-bs-toggle="dropdown"]')
const offcanvas = bootstrap.Offcanvas.getInstance('#myOffcanvas')
const alert = bootstrap.Alert.getOrCreateInstance('#myAlert')

Ասինխրոն գործառույթներ և անցումներ

Ծրագրային API-ի բոլոր մեթոդներն ասինխրոն են և վերադառնում են զանգահարողին՝ անցումը սկսելուց հետո, բայց մինչև դրա ավարտը : Անցումը ավարտվելուց հետո գործողություն կատարելու համար կարող եք լսել համապատասխան իրադարձությունը:

const myCollapseEl = document.querySelector('#myCollapse')

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

Բացի այդ, անցումային բաղադրիչի վրա մեթոդի կանչը անտեսվելու է :

const myCarouselEl = document.querySelector('#myCarousel')
const carousel = bootstrap.Carousel.getInstance(myCarouselEl) // Retrieve a Carousel instance

myCarouselEl.addEventListener('slid.bs.carousel', 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 !!

`dispose`մեթոդ

Թեև կարող է ճիշտ թվալ disposeմեթոդի օգտագործումը անմիջապես հետո hide(), այն կհանգեցնի սխալ արդյունքների: Ահա խնդրի օգտագործման օրինակ.

const myModal = document.querySelector('#myModal')
myModal.hide() // it is asynchronous

myModal.addEventListener('shown.bs.hidden', event => {
  myModal.dispose()
})

Կանխադրված կարգավորումներ

Դուք կարող եք փոխել plugin-ի լռելյայն կարգավորումները՝ փոփոխելով plugin-ի Constructor.Defaultօբյեկտը.

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

Մեթոդներ և հատկություններ

Bootstrap-ի յուրաքանչյուր պլագին բացահայտում է հետևյալ մեթոդներն ու ստատիկ հատկությունները.

Մեթոդ	Նկ��րագրություն
`dispose`	Ոչնչացնում է տարրի մոդալը: (Հեռացնում է DOM տարրի վրա պահված տվյալները)
`getInstance`	Ստատիկ մեթոդ, որը թույլ է տալիս ստանալ DOM տարրի հետ կապված մոդալ օրինակ:
`getOrCreateInstance`	Ստատիկ մեթոդ, որը թույլ է տալիս ստանալ DOM տարրի հետ կապված մոդալ օրինակ կամ ստեղծել նորը, եթե այն նախաստորագրված չէ:

Ստատիկ հատկություն	Նկարագրություն
`NAME`	Վերադարձնում է plugin-ի անունը։ (Օրինակ `bootstrap.Tooltip.NAME`:)
`VERSION`	Bootstrap-ի փլագիններից յուրաքանչյուրի տարբերակը հասանելի `VERSION`է plugin-ի կոնստրուկտորի հատկության միջոցով (Օրինակ՝ `bootstrap.Tooltip.VERSION`)

Սանիտարական միջոց

Tooltips-ը և Popovers-ը օգտագործում են մեր ներկառուցված ախտահանիչը՝ HTML-ն ընդունող տարբերակները մաքրելու համար:

Լռելյայն allowListարժեքը հետևյալն է.

const ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i
const 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կարող եք անել հետևյալը.

const 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
const myCustomRegex = /^data-my-app-[\w-]+/
myDefaultAllowList['*'].push(myCustomRegex)

Եթե ցանկանում եք շրջանցել մեր ախտահանիչը, քանի որ նախընտրում եք օգտագործել հատուկ գրադարան, օրինակ ՝ DOMPurify , դուք պետք է անեք հետևյալը.

const yourTooltipEl = document.querySelector('#yourTooltip')
const tooltip = new bootstrap.Tooltip(yourTooltipEl, {
  sanitizeFn(content) {
    return DOMPurify.sanitize(content)
  }
})

Ընտրովի օգտագործելով jQuery

Ձեզ հարկավոր չէ jQuery Bootstrap 5 -ում, բայց դեռ հնարավոր է օգտագործել մեր բաղադրիչները jQuery-ի հետ: Եթե Bootstrap- jQueryը հայտնաբերի windowօբյեկտում, այն կավելացնի մեր բոլոր բաղադրիչները jQuery-ի plugin համակարգում: Սա թույլ է տալիս անել հետևյալը.

$('[data-bs-toggle="tooltip"]').tooltip() // to enable tooltips, with default configuration

$('[data-bs-toggle="tooltip"]').tooltip({ boundary: 'clippingParents', customClass: 'myClass' }) // to initialize tooltips with given configuration

$('#myTooltip').tooltip('show') // to trigger `show` method

Նույնը վերաբերում է մեր մյուս բաղադրիչներին:

Ոչ մի կոնֆլիկտ

Երբեմն անհրաժեշտ է լինում օգտագործել Bootstrap պլագիններ այլ UI շրջանակների հետ: Այս հանգամանքներում երբեմն կարող են տեղի ունենալ անունների տարածության բախումներ: Եթե դա տեղի ունենա, դուք կարող եք զանգահարել .noConflictայն պլագինին, որի արժեքը ցանկանում եք վերադարձնել:

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

Bootstrap-ը պաշտոնապես չի աջակցում երրորդ կողմի JavaScript գրադարաններին, ինչպիսիք են Prototype-ը կամ jQuery UI-ը: Չնայած .noConflictանվանատարածք ունեցող իրադարձություններին, կարող են լինել համատեղելիության խնդիրներ, որոնք դուք պետք է ինքնուրույն շտկեք:

jQuery իրադարձություններ

Bootstrap-ը կհայտնաբերի jQuery-ն, եթե jQueryառկա է windowօբյեկտում և դրա data-bs-no-jqueryվրա դրված հատկանիշ չկա <body>: Եթե jQuery գտնվի, Bootstrap-ը իրադարձություններ կթողարկի jQuery-ի իրադարձությունների համակարգի շնորհիվ: Այսպիսով, եթե ցանկանում եք լսել Bootstrap-ի իրադարձությունները, ապա պետք է օգտագործեք jQuery մեթոդները ( .on, .one)-ի փոխարեն addEventListener:

$('#myTab a').on('shown.bs.tab', () => {
  // do something...
})

Անջատված JavaScript-ը

Bootstrap-ի պլագինները հատուկ հետադարձ կապ չունեն, երբ JavaScript-ն անջատված է: Եթե այս դեպքում ձեզ հետաքրքրում է օգտատերերի փորձը, օգտագործեք <noscript>ձեր օգտատերերին իրավիճակը (և ինչպես կրկին ակտիվացնել JavaScript-ը) բացատրելու համար և/կամ ավելացրեք ձեր սեփական հետադարձ կապերը: