JavaScript

Individuale o compilato

I plugin possono essere inclusi individualmente (usando l'individuale di Bootstrap js/dist/*.js) o tutti in una volta usando bootstrap.jso minimizzati bootstrap.min.js(non includerli entrambi).

Se utilizzi un bundler (Webpack, Rollup...), puoi utilizzare /js/dist/*.jsfile che sono pronti per UMD.

Utilizzo di Bootstrap come modulo

Forniamo una versione di Bootstrap costruita come ESM( bootstrap.esm.jse bootstrap.esm.min.js) che ti consente di utilizzare Bootstrap come modulo nel tuo browser, se i browser di destinazione lo supportano .

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

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

Dipendenze

Alcuni plugin e componenti CSS dipendono da altri plugin. Se includi i plug-in singolarmente, assicurati di controllare queste dipendenze nei documenti.

Anche i nostri menu a discesa, popover e suggerimenti dipendono da Popper .

Vuoi ancora usare jQuery? È possibile!

Bootstrap 5 è ​​progettato per essere utilizzato senza jQuery, ma è comunque possibile utilizzare i nostri componenti con jQuery. Se Bootstrap rileva nell'oggetto jQueryaggiungeràwindow tutti i nostri componenti nel sistema di plugin di jQuery; questo significa che potrai fare $('[data-bs-toggle="tooltip"]').tooltip()per abilitare i suggerimenti. Lo stesso vale per gli altri nostri componenti.

Attributi dei dati

Quasi tutti i plug-in Bootstrap possono essere abilitati e configurati solo tramite HTML con attributi di dati (il nostro modo preferito di utilizzare la funzionalità JavaScript). Assicurati di utilizzare solo un set di attributi di dati su un singolo elemento (ad esempio, non puoi attivare una descrizione comando e modale dallo stesso pulsante).

Eventi

Bootstrap fornisce eventi personalizzati per le azioni uniche della maggior parte dei plugin. Generalmente, questi si presentano in una forma di participio passato e infinito, in cui l'infinito (es. show) viene attivato all'inizio di un evento e la sua forma participio passato (es. shown) viene attivata al completamento di un'azione.

Tutti gli eventi infiniti forniscono preventDefault()funzionalità. Ciò fornisce la possibilità di interrompere l'esecuzione di un'azione prima che inizi. Anche la restituzione di false da un gestore di eventi chiamerà automaticamente 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 programmatica

Tutti i costruttori accettano un oggetto opzioni opzionale o niente (che avvia un plug-in con il suo comportamento predefinito):

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

Se desideri ottenere una particolare istanza di plug-in, ogni plug-in espone un getInstancemetodo. Per recuperarlo direttamente da un elemento, procedere come segue: bootstrap.Popover.getInstance(myPopoverEl).

Selettori CSS nei costruttori

Puoi anche utilizzare un selettore CSS come primo argomento invece di un elemento DOM per inizializzare il plugin. Attualmente l'elemento per il plugin si trova dal querySelectormetodo poiché i nostri plugin supportano solo un singolo elemento.

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

Funzioni e transizioni asincrone

Tutti i metodi API programmatici sono asincroni e ritornano al chiamante una volta avviata la transizione ma prima che termini .

Per eseguire un'azione una volta completata la transizione, è possibile ascoltare l'evento corrispondente.

var myCollapseEl = document.getElementById('myCollapse')

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

Inoltre, una chiamata al metodo su un componente in transizione verrà ignorata .

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

Impostazioni predefinite

È possibile modificare le impostazioni predefinite per un plug-in modificando l' Constructor.Defaultoggetto del plug-in:

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

Nessun conflitto (solo se usi jQuery)

A volte è necessario utilizzare i plug-in Bootstrap con altri framework dell'interfaccia utente. In queste circostanze, possono verificarsi occasionalmente collisioni nello spazio dei nomi. Se ciò accade, puoi richiamare .noConflictil plugin di cui desideri ripristinare il valore.

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

Numeri di versione

È possibile accedere alla versione di ciascuno dei plugin di Bootstrap tramite la VERSIONproprietà del costruttore del plugin. Ad esempio, per il plug-in del suggerimento:

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

Nessun fallback speciale quando JavaScript è disabilitato

I plugin di Bootstrap non ricadono in modo particolarmente elegante quando JavaScript è disabilitato. Se ti interessa l'esperienza dell'utente in questo caso, usa <noscript>per spiegare la situazione (e come riattivare JavaScript) ai tuoi utenti e/o aggiungi i tuoi fallback personalizzati.

Disinfettante

Tooltip e Popover utilizzano il nostro disinfettante integrato per disinfettare le opzioni che accettano HTML.

Il allowListvalore predefinito è il seguente:

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

Se vuoi aggiungere nuovi valori a questo valore predefinito allowListpuoi fare quanto segue:

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)

Se vuoi bypassare il nostro igienizzante perché preferisci utilizzare una libreria dedicata, ad esempio DOMPurify , dovresti fare quanto segue:

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