JavaScript

オプションの JavaScript プラグインを使用して、Bootstrap に命を吹き込みます。各プラグイン、データおよびプログラム API オプションなどについて学びます。

このページでは

個別またはコンパイル済み

プラグインは (Bootstrap の individual を使用して) 個別に含めることも、または縮小版js/dist/*.jsを使用して一度に含めることもできます (両方を含めないでください)。bootstrap.jsbootstrap.min.js

バンドラー (Webpack、Parcel、Vite など) を使用/js/dist/*.jsすると、UMD 対応のファイルを使用できます。

JavaScript フレームワークでの使用

Bootstrap CSS はどのフレームワークでも使用できますが、Bootstrap JavaScript は、DOM の完全な知識を前提とするReact、Vue、Angular などの JavaScript フレームワークと完全には互換性がありません。Bootstrap とフレームワークの両方が同じ DOM 要素を変更しようとする可能性があり、その結果、ドロップダウンが「開いた」位置でスタックするなどのバグが発生します。

このタイプのフレームワークを使用する場合のより良い代替手段は、Bootstrap JavaScript の代わりにフレームワーク固有のパッケージを使用することです。最も一般的なオプションのいくつかを次に示します。

React: React ブートストラップ
Vue: BootstrapVue (現在、Vue 2 と Bootstrap 4 のみをサポート)
角度: ng-bootstrap

Bootstrap をモジュールとして使用する

自分で試してみてください！Bootstrap を ES モジュールとして使用するためのソースコードと動作デモを twbs/examples リポジトリからダウンロードします。StackBlitz で例を開くこともできます。

ESM(bootstrap.esm.jsおよび)としてビルドされた Bootstrap のバージョンを提供します。これにより、対象となるブラウザーがサポートしている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 を JavaScript にインポートする Popper の依存関係によってさらに複雑になります。

import * as Popper from "@popperjs/core"

このまま試してみると、コンソールに次のようなエラーが表示されます。

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

これを修正するには、を使用しimportmapて任意のモジュール名を完全なパスに解決します。対象のブラウザーがをサポートしていない場合は、 es-module-shimsプロジェクトimportmapを使用する必要があります。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 コンポーネントは、他のプラグインに依存しています。プラグインを個別に含める場合は、ドキュメントでこれらの依存関係を確認してください。

ドロップダウン、ポップオーバー、ツールチップもPopperに依存しています。

データ属性

ほぼすべての Bootstrap プラグインは、HTML だけでデータ属性を使用して有効化および構成できます (JavaScript 機能を使用する推奨方法)。1 つの要素で 1 セットのデータ属性のみを使用するようにしてください(たとえば、同じボタンからツールヒントとモーダルをトリガーすることはできません)。

オプションはデータ属性または JavaScript を介して渡すことができるためdata-bs-、のようにオプション名をに追加できますdata-bs-animation="{value}"。データ属性を介してオプションを渡すときは、オプション名のケースタイプを「camelCase」から「kebab-case 」に変更してください。たとえば、data-bs-custom-class="beautifier"の代わりにを使用しdata-bs-customClass="beautifier"ます。

Bootstrap 5.2.0 の時点で、すべてのコンポーネントは、単純なコンポーネント構成を JSON 文字列として格納できる実験的な予約済みデータ属性をサポートしています。data-bs-config要素に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

すべてのコンストラクターは、オプションのオプションオブジェクトを受け入れるか、何も受け入れません (デフォルトの動作でプラグインを開始します)。

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)

インスタンスが初期化されていない場合は、オプションの構成オブジェクトを受け入れて、2 番目の引数として使用できます。

コンストラクターの 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

メソッドとプロパティ

すべての Bootstrap プラグインは、次のメソッドと静的プロパティを公開します。

方法	説明
`dispose`	要素のモーダルを破棄します。(DOM要素に格納されたデータを削除します)
`getInstance`	DOM 要素に関連付けられたモーダルインスタンスを取得できる静的メソッド。
`getOrCreateInstance`	DOM 要素に関連付けられたモーダルインスタンスを取得したり、初期化されていない場合に新しいインスタンスを作成したりできる静的メソッド。

静的プロパティ	説明
`NAME`	プラグイン名を返します。(例: `bootstrap.Tooltip.NAME`)
`VERSION`	`VERSION`Bootstrap の各プラグインのバージョンは、プラグインのコンストラクターのプロパティを介してアクセスできます(例: `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 でコンポーネントを使用することは可能です。Bootstrap がオブジェクトを検出するjQueryと、windowすべてのコンポーネントが jQuery のプラグインシステムに追加されます。これにより、次のことが可能になります。

$('[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 フレームワークで Bootstrap プラグインを使用する必要がある場合があります。このような状況では、名前空間の競合が発生することがあります。これが発生し.noConflictた場合は、値を元に戻したいプラグインを呼び出すことができます。

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

Bootstrap は、Prototype や jQuery UI などのサードパーティの JavaScript ライブラリを公式にはサポートしていません。名前空間付きのイベントにもかかわらず.noConflict、独自に修正する必要がある互換性の問題がある場合があります。

jQuery イベント

オブジェクトにがjQuery存在し、に属性が設定されていない場合、Bootstrap は jQuery を検出します。jQuery が見つかった場合、Bootstrap は jQuery のイベントシステムのおかげでイベントを発行します。したがって、Bootstrap のイベントをリッスンする場合は、の代わりにjQuery メソッド ( 、 ) を使用する必要があります。windowdata-bs-no-jquery<body>.on.oneaddEventListener

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

JavaScript を無効にしました

JavaScript が無効になっている場合、Bootstrap のプラグインには特別なフォールバックはありません。この場合のユーザーエクスペリエンスが気になる場合は<noscript>、状況 (および JavaScript を再度有効にする方法) をユーザーに説明するために使用するか、独自のカスタムフォールバックを追加してください。