मुख्य सामग्रीवर जा डॉक्स नेव्हिगेशनवर जा
Check
in English

JavaScript

आमच्या पर्यायी JavaScript प्लगइनसह बूटस्ट्रॅपला जिवंत करा. प्रत्येक प्लगइन, आमचा डेटा आणि प्रोग्रामॅटिक API पर्याय आणि बरेच काही याबद्दल जाणून घ्या.

या पृष्ठावर

वैयक्तिक किंवा संकलित

प्लगइन वैयक्तिकरित्या समाविष्ट केले जाऊ शकतात (बूटस्ट्रॅपचे वैयक्तिक वापरून js/dist/*.js), किंवा सर्व एकाच वेळी वापरून bootstrap.jsकिंवा लहान bootstrap.min.js(दोन्ही समाविष्ट करू नका).

तुम्ही बंडलर (वेबपॅक, पार्सल, विट…) वापरत असल्यास, तुम्ही /js/dist/*.jsUMD तयार असलेल्या फाइल्स वापरू शकता.

JavaScript फ्रेमवर्कसह वापर

बूटस्ट्रॅप CSS कोणत्याही फ्रेमवर्कसह वापरले जाऊ शकते, परंतु बूटस्ट्रॅप JavaScript जावास्क्रिप्ट फ्रेमवर्क जसे की प्रतिक्रिया, व्ह्यू आणि अँगुलरशी पूर्णपणे सुसंगत नाही जे DOM चे संपूर्ण ज्ञान गृहीत धरते. बूटस्ट्रॅप आणि फ्रेमवर्क दोन्ही समान DOM घटक बदलण्याचा प्रयत्न करू शकतात, परिणामी ड्रॉपडाउनसारखे बग जे "ओपन" स्थितीत अडकले आहेत.

या प्रकारचे फ्रेमवर्क वापरणाऱ्यांसाठी एक चांगला पर्याय म्हणजे बूटस्ट्रॅप JavaScript ऐवजी फ्रेमवर्क-विशिष्ट पॅकेज वापरणे. येथे काही सर्वात लोकप्रिय पर्याय आहेत:

मॉड्यूल म्हणून बूटस्ट्रॅप वापरणे

ते स्वतः वापरून पहा! Twbs/examples repository मधून ES मॉड्यूल म्हणून बूटस्ट्रॅप वापरण्यासाठी स्त्रोत कोड आणि कार्यरत डेमो डाउनलोड करा . तुम्ही StackBlitz मध्ये उदाहरण देखील उघडू शकता .

ESMआम्ही बूटस्ट्रॅपची ( bootstrap.esm.jsआणि ) म्हणून तयार केलेली आवृत्ती प्रदान करतो bootstrap.esm.min.jsजी तुम्हाला ब्राउझरमध्ये बूटस्ट्रॅप मॉड्यूल म्हणून वापरण्याची परवानगी देते, जर तुमचे लक्ष्यित ब्राउझर त्यास समर्थन देत असतील .

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

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

JS बंडलर्सच्या तुलनेत, ब्राउझरमध्ये ESM वापरण्यासाठी तुम्हाला मॉड्यूल नावाऐवजी पूर्ण पथ आणि फाइलनाव वापरणे आवश्यक आहे. ब्राउझरमध्ये जेएस मॉड्यूल्सबद्दल अधिक वाचा. म्हणूनच आम्ही वरील 'bootstrap.esm.min.js'ऐवजी वापरतो. 'bootstrap'तथापि, आमच्या पॉपर अवलंबित्वामुळे हे आणखी गुंतागुंतीचे आहे, जे आमच्या 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 प्रकल्प वापरण्याची आवश्यकता असेल. बूटस्ट्रॅप आणि पॉपरसाठी ते कसे कार्य करते ते येथे आहे:

<!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 घटक इतर प्लगइनवर अवलंबून असतात. तुम्ही स्वतंत्रपणे प्लगइन समाविष्ट करत असल्यास, डॉक्समध्ये या अवलंबित्वांची खात्री करा.

आमचे ड्रॉपडाउन, पॉपओव्हर्स आणि टूलटिप्स देखील पॉपरवर अवलंबून असतात .

डेटा विशेषता

जवळपास सर्व बूटस्ट्रॅप प्लगइन्स केवळ HTML द्वारे डेटा विशेषतांसह सक्षम आणि कॉन्फिगर केले जाऊ शकतात (जावास्क्रिप्ट कार्यक्षमता वापरण्याचा आमचा प्राधान्याचा मार्ग). एका घटकावर फक्त डेटा विशेषतांचा एक संच वापरण्याची खात्री करा (उदा., तुम्ही एकाच बटणावरून टूलटिप आणि मॉडेल ट्रिगर करू शकत नाही.)

data-bs-पर्याय डेटा विशेषता किंवा JavaScript द्वारे पास केले जाऊ शकतात म्हणून, तुम्ही मध्ये पर्याय नाव जोडू शकता data-bs-animation="{value}". डेटा विशेषतांद्वारे पर्याय पास करताना पर्याय नावाचा केस प्रकार “ camelCase ” वरून “ kebab-case ” मध्ये बदलण्याची खात्री करा. उदाहरणार्थ, data-bs-custom-class="beautifier"ऐवजी वापरा data-bs-customClass="beautifier".

बूटस्ट्रॅप 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}'.

निवडकर्ते

आम्ही कार्यप्रदर्शन कारणांसाठी DOM घटकांची क्वेरी करण्यासाठी नेटिव्ह querySelectorआणि पद्धती वापरतो, म्हणून तुम्ही वैध निवडक वापरणे आवश्यक आहे . तुम्ही सारखे विशेष निवडक वापरत असल्यास , ते टाळण्याची खात्री करा.querySelectorAllcollapse:Example

कार्यक्रम

बूटस्ट्रॅप बहुतेक प्लगइन्सच्या अनन्य क्रियांसाठी सानुकूल इव्हेंट प्रदान करते. सामान्यतः, हे अनंत आणि भूतकाळातील कृदंत स्वरूपात येतात - जिथे अनंत (उदा. show) एखाद्या घटनेच्या प्रारंभी ट्रिगर केला जातो आणि त्याचे भूतकाळातील कृदंत स्वरूप (उदा. shown) क्रिया पूर्ण झाल्यावर ट्रिगर केले जाते.

सर्व अनंत घटना preventDefault()कार्यक्षमता प्रदान करतात. हे कार्य सुरू होण्यापूर्वी त्याची अंमलबजावणी थांबविण्याची क्षमता प्रदान करते. इव्हेंट हँडलरकडून खोटे परत येणे देखील स्वयंचलितपणे कॉल करेल preventDefault().

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

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

प्रोग्रामॅटिक API

सर्व कन्स्ट्रक्टर वैकल्पिक पर्याय ऑब्जेक्ट किंवा काहीही स्वीकारतात (जे त्याच्या डीफॉल्ट वर्तनासह प्लगइन सुरू करते):

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

तुम्ही विशिष्ट प्लगइन उदाहरण मिळवू इच्छित असल्यास, प्रत्येक प्लगइन एक getInstanceपद्धत उघड करते. उदाहरणार्थ, घटकामधून थेट उदाहरण पुनर्प्राप्त करण्यासाठी:

bootstrap.Popover.getInstance(myPopoverEl)

nullविनंती केलेल्या घटकावर उदाहरण सुरू न केल्यास ही पद्धत परत येईल .

वैकल्पिकरित्या, getOrCreateInstanceDOM घटकाशी संबंधित उदाहरण मिळविण्यासाठी वापरले जाऊ शकते किंवा ते प्रारंभ केले नसल्यास नवीन तयार करा.

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

जर एखादा प्रसंग आरंभ केला गेला नसेल, तर तो दुसरा युक्तिवाद म्हणून वैकल्पिक कॉन्फिगरेशन ऑब्जेक्ट स्वीकारू शकतो आणि वापरू शकतो.

कन्स्ट्रक्टरमध्ये CSS निवडक

getInstanceआणि पद्धती व्यतिरिक्त , सर्व प्लगइन कन्स्ट्रक्टर प्रथम युक्तिवाद म्हणून DOM घटक किंवा वैध CSS निवडकgetOrCreateInstance स्वीकारू शकतात . प्लगइन घटक पद्धतीसह आढळतात कारण आमचे प्लगइन केवळ एकाच घटकास समर्थन देतात.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()
})

डीफॉल्ट सेटिंग्ज

Constructor.Defaultतुम्ही प्लगइनच्या ऑब्जेक्टमध्ये बदल करून प्लगइनसाठी डीफॉल्ट सेटिंग्ज बदलू शकता :

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

पद्धती आणि गुणधर्म

प्रत्येक बूटस्ट्रॅप प्लगइन खालील पद्धती आणि स्थिर गुणधर्म उघड करते.

पद्धत वर्णन
dispose घटकाचे मॉडेल नष्ट करते. (DOM घटकावरील संचयित डेटा काढून टाकते)
getInstance स्टॅटिक पद्धत जी तुम्हाला डीओएम घटकाशी संबंधित मॉडेल इन्स्टन्स मिळवू देते.
getOrCreateInstance स्टॅटिक पद्धत जी तुम्हाला डीओएम घटकाशी संबंधित मॉडेल इन्स्टन्स मिळवू देते किंवा ते सुरू न झाल्यास नवीन तयार करू देते.
स्थिर मालमत्ता वर्णन
NAME प्लगइनचे नाव परत करते. (उदाहरण bootstrap.Tooltip.NAME:)
VERSION VERSIONप्रत्येक बूटस्ट्रॅपच्या प्लगइनची आवृत्ती प्लगइनच्या कन्स्ट्रक्टरच्या मालमत्तेद्वारे ऍक्सेस केली जाऊ शकते (उदाहरण: bootstrap.Tooltip.VERSION)

सॅनिटायझर

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 वापरणे

तुम्हाला Bootstrap 5 मध्ये jQuery ची गरज नाही , पण तरीही आमचे घटक jQuery सह वापरणे शक्य आहे. जर बूटस्ट्रॅपला ऑब्जेक्टमध्ये आढळले, तर jQueryते windowjQuery च्या प्लगइन सिस्टममध्ये आमचे सर्व घटक जोडेल. हे आपल्याला पुढील गोष्टी करण्याची परवानगी देते:

$('[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

आमच्या इतर घटकांसाठीही तेच आहे.

संघर्ष नाही

कधीकधी इतर UI फ्रेमवर्कसह बूटस्ट्रॅप प्लगइन वापरणे आवश्यक असते. या परिस्थितीत, नेमस्पेसची टक्कर अधूनमधून होऊ शकते. असे झाल्यास, तुम्ही .noConflictज्या प्लगइनचे मूल्य परत करू इच्छिता त्यावर कॉल करू शकता.

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

बूटस्ट्रॅप प्रोटोटाइप किंवा jQuery UI सारख्या तृतीय-पक्ष JavaScript लायब्ररींना अधिकृतपणे समर्थन देत नाही. इव्हेंट आणि नेमस्पेस असूनही .noConflict, सुसंगतता समस्या असू शकतात ज्यांचे निराकरण तुम्हाला स्वतः करावे लागेल.

jQuery कार्यक्रम

जर ऑब्जेक्टमध्ये असेल आणि कोणतीही विशेषता सेट केली jQueryनसेल तर बूटस्ट्रॅप jQuery शोधेल . jQuery आढळल्यास, jQuery च्या इव्हेंट सिस्टममुळे बूटस्ट्रॅप इव्हेंट उत्सर्जित करेल. त्यामुळे जर तुम्हाला बूटस्ट्रॅपचे कार्यक्रम ऐकायचे असतील, तर तुम्हाला jQuery पद्धती ( , ) ऐवजी वापराव्या लागतील .windowdata-bs-no-jquery<body>.on.oneaddEventListener

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

अक्षम JavaScript

जेव्हा JavaScript अक्षम असते तेव्हा बूटस्ट्रॅपच्या प्लगइन्सना विशेष फॉलबॅक नसते. जर तुम्हाला या प्रकरणात वापरकर्त्याच्या अनुभवाची काळजी असेल, तर तुमच्या वापरकर्त्यांना <noscript>परिस्थिती (आणि JavaScript पुन्हा सक्षम कसे करावे) समजावून सांगण्यासाठी आणि/किंवा तुमचे स्वतःचे सानुकूल फॉलबॅक जोडा.