JavaScript

オプションのJavaScriptプラグインを使用して、Bootstrapを活性化しましょう。各プラグイン、データとプログラムによるAPIオプションなどについて学びます。

このページの内容

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

プラグインは個別に含める（Bootstrapの個別の js/dist/*.js を使用）か、bootstrap.js または縮小版の bootstrap.min.js を使用してすべて一度に含めることができます（両方を同時に含めないでください）。

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

JavaScriptフレームワークとの併用

Bootstrap CSSはあらゆるフレームワークで使用できますが、**Bootstrap JavaScriptは、DOMを完全に把握していると想定しているReact、Vue、AngularなどのJavaScriptフレームワークと完全には互換性がありません**。 Bootstrapとフレームワークの両方が同じDOM要素を変更しようとすると、「開く」位置でスタックするドロップダウンなどのバグが発生する可能性があります。

このタイプのフレームワークを使用している場合は、Bootstrap JavaScriptの**代わりに**フレームワーク固有のパッケージを使用することをお勧めします。以下は、最も一般的なオプションの一部です

React: React Bootstrap
**試してみよう！** React、Next.js、React BootstrapでBootstrapを使用するためのソースコードと動作デモは、twbs/examplesリポジトリからダウンロードできます。また、StackBlitzで例を開くこともできます。
Vue: BootstrapVue (Bootstrap 4)
Vue 3: BootstrapVueNext (Bootstrap 5、現在アルファ版)
Angular: ng-bootstrap

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

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

ESM (bootstrap.esm.js と bootstrap.esm.min.js) としてビルドされたBootstrapのバージョンを提供しています。これにより、対象のブラウザでサポートされている場合、ブラウザで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' ではなく 'bootstrap.esm.min.js' を使用しています。ただし、これはPopperの依存関係によってさらに複雑になります。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.3/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH" 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.3/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プラグインは、データ属性（JavaScript機能を使用する際の推奨される方法）を使用してHTMLのみで有効化および設定できます。 **1つの要素に1つのデータ属性セットのみを使用してください**（たとえば、同じボタンからツールチップとモーダルをトリガーすることはできません）。

オプションはデータ属性またはJavaScriptを介して渡すことができるため、data-bs-animation="{value}" のように、オプション名を data-bs- に追加できます。オプションをデータ属性経由で渡す場合は、オプション名のケースタイプを「*キャメルケース*」から「*ケバブケース*」に変更してください。たとえば、`data-bs-customClass = "beautifier"`の代わりに`data-bs-custom-class = "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`で指定された値をオーバーライドします。さらに、既存のデータ属性は、`data-bs-delay = '{"show": 0、 "hide": 150}'`のようなJSON値を格納できます。

最終的な構成オブジェクトは、`data-bs-config`、`data-bs-`、および`js object`のマージされた結果であり、最後に指定されたキーと値が他の値をオーバーライドします。

セレクタ

パフォーマンス上の理由から、DOM要素をクエリするためにネイティブの querySelector および querySelectorAll メソッドを使用しているため、有効なセレクタを使用する必要があります。 collapse:Example のような特殊なセレクタを使用する場合は、必ずエスケープしてください。

イベント

Bootstrapは、ほとんどのプラグインの固有のアクションに対してカスタムイベントを提供します。一般的に、これらは不定詞と過去分詞の形で提供されます。不定詞（例：show）はイベントの開始時にトリガーされ、過去分詞形（例：shown）はアクションの完了時にトリガーされます。

すべての不定詞イベントは、preventDefault() 機能を提供します。これにより、アクションが開始される前に実行を停止できます。イベントハンドラからfalseを返すと、preventDefault() も自動的に呼び出されます。

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

myModal.addEventListener('show.bs.modal', event => {
  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プラグインは、以下のメソッドと静的プロパティを公開しています。

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

静的プロパティ	説明
`NAME`	プラグイン名を返します。(例: `bootstrap.Tooltip.NAME`)
`VERSION`	各Bootstrapプラグインのバージョンは、プラグインのコンストラクタの `VERSION` プロパティを介してアクセスできます (例: `bootstrap.Tooltip.VERSION`)

サニタイザー

ツールチップとポップオーバーは、組み込みのサニタイザーを使用して、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: [],
  dd: [],
  div: [],
  dl: [],
  dt: [],
  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')

他のコンポーネントにも同じことが言えます。

競合の回避

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は、window オブジェクトに jQuery が存在し、<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を再び有効にする方法) をユーザーに説明するか、独自のフォールバックを追加してください。