Skip to main content Skip to docs navigation
GitHubで見る

JavaScript

オプションのJavaScriptプラグインを使ってBootstrapを実現しましょう。各プラグイン、データとAPIオプションなどについて学びます。

項目

個別またはコンパイル

プラグインは、（Bootstrapの個別のjs/dist/*.jsを使って）個別にインクルードすることもできますし、bootstrap.jsやminifiedのbootstrap.min.jsを使って一度にインクルードすることもできます（両方をインクルードしてはいけません）。

バンドルラー(Webpack, Parcel, Vite…)を使っている場合は、UMDに対応したjs/dist/*.jsファイルを使うことができます。

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

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

このタイプのフレームワークを使用している人のためのより良い代替案は、Bootstrap JavaScriptの代わりにフレームワーク固有のパッケージを使用することです。ここでは、最も人気のあるオプションをいくつか紹介します：

Bootstrapをモジュールとして使う

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

対象ブラウザが対応している場合Bootstrapをブラウザのモジュールとして使用できるように、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を使用する場合は、モジュール名の代わりにフルパスとファイル名を使用する必要があります。ブラウザでのJSモジュールについて詳しくはこちら そのため、上記では'bootstrap'の代わりに'bootstrap.esm.min.js'を使用しています。しかし、これは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/bootstrap@5.3.0/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-9ndCyUaIbzAi2FUVXJi0CjmCapSmO7SnpJef0486qhLnuZ2cdeRhO02iuK6FUUVM" crossorigin="anonymous">
    <title>Hello, modularity!</title>
  </head>
  <body>
    <h1>Hello, modularity!</h1>
    <button id="popoverButton" type="button" class="btn btn-primary btn-lg" 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/core@2.11.8/dist/esm/popper.min.js",
        "bootstrap": "https://cdn.jsdelivr.net/npm/bootstrap@5.3.0/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だけ有効になり機能します。単一の要素に対して1セットのデータ属性のみを使用するようにしてください(例えば、同じボタンからツールチップとモーダルを同時にトリガーすることはできません)。

オプションはデータ属性やJavaScriptで渡すことができるので、data-bs-animation="{value}"のように、data-bs-にオプション名を付加することができる。データ属性でオプションを渡す場合は、オプション名の大文字と小文字を"camelCase“から”kebab-case“に変更することを忘れないようにしましょう。例えば、data-bs-customClass="beautifier"の代わりに data-bs-custom-class="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で与えられた値を上書きする。また、既存のデータ属性にはdata-bs-delay='{"show":0, "hide":150}'のようなJSON値を格納することができるようになっています。

最終的なコンフィギュレーションオブジェクトは data-bs-config、data-bs-、js objectのマージ結果であり、最新のキー値が他の値を上書きする。

セレクタ

Bootstrapではパフォーマンスの都合により、DOM要素のクエリにネイティブのメソッドであるquerySelectorとquerySelectorAllを用いています。そのため、必ず有効なセレクタを使うようにしてください。 特別なセレクタを使用する場合は、例えば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を返します。

また、getOrCreateInstanceを使用すると、DOM要素に関連するインスタンスを取得したり、初期化されていない場合は新しいインスタンスを作成したりすることができます。

bootstrap.Popover.getOrCreateInstance(myPopoverEl, configObject)

インスタンスが初期化されていない場合、第2引数としてオプションの設定オブジェクトを受け取り、使用することができます。

コンストラクタのCSSセレクタ

getInstanceとgetOrCreateInstanceメソッドに加えて、すべてのプラグインコンストラクタは第一引数にDOM要素または有効なCSSセレクタを受け取ることができます。プラグインは単一の要素しかサポートしないため、プラグイン要素は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メソッド

hide()の直後にdisposeメソッドを使用するのは正しいように見えますが、誤った結果につながります。以下は、問題のある使用例です：

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プラグインは、以下のメソッドと静的プロパティを公開します。

Method Description
dispose 要素のモーダルを破壊する。（DOM要素の保存データを削除する）。
getInstance DOM要素に関連付けられたモーダルインスタンスを取得することができるStaticメソッドです。
getOrCreateInstance DOM要素に関連付けられたモーダルインスタンスを取得したり、初期化されていない場合に新しいインスタンスを作成することができるStaticメソッドです。
Static property Description
NAME プラグイン名を返します。(例: bootstrap.Tooltip.NAME)
VERSION Bootstrapの各プラグインのバージョンは、プラグインのコンストラクタのVERSIONプロパティでアクセスすることができます。(例: bootstrap.Tooltip.VERSION)

Sanitizer

ツールチップとポップオーバーは、HTMLを受け入れるオプションをサニタイズするために、組み込みのサニタイザーを使用します。

デフォルトのallowListの値は次のようになっています:

js/src/util/sanitizer.js 
const ARIA_ATTRIBUTE_PATTERN = /^aria-[\w-]*$/i

export 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がwindowオブジェクトでjQueryを検出すると、jQueryのプラグインシステムに私たちのコンポーネントをすべて追加します。これにより、以下のことが可能になります：

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

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

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

他のコンポーネントも同様です。

No conflict

たまにBootstrapのプラグインを他のUIフレームワークと併用する必要がある場合があります。このような状況では、時折、名前空間の衝突が発生することがあります。この場合、値を戻したいプラグインに対して .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のイベント

Bootstrapは、jQueryがwindowオブジェクトに存在し、<body>にdata-bs-no-jquery属性が設定されていない場合、jQueryを検出します。jQueryが見つかった場合、BootstrapはjQueryのイベントシステムによってイベントを発する。そのため、Bootstrapのイベントを聞きたい場合は、addEventListenerの代わりにjQueryのメソッド（.on、.one）を使用する必要があります。

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

JavaScriptを無効にする

Bootstrapのプラグインは、JavaScriptが無効になったときの特別なフォールバックはありません。この場合のユーザーエクスペリエンスを気にするのであれば、<noscript>を使ってユーザーに状況（とJavaScriptを再び有効にする方法）を説明し、そして/またはあなた自身のカスタムフォールバックを追加してください。