Skip to main content Skip to docs navigation
View on GitHub

JavaScript

オプションのJavaScriptプラグインでBootstrapに命を吹き込みます。各プラグイン、データおよびプログラマティックAPIオプションなどについて学びます。

On this page

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

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

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

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

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

この種のフレームワークを使用する場合のより良い代替手段は、Bootstrap JavaScriptの代わりにフレームワーク固有のパッケージを使用することです。最も人気のあるオプションは次のとおりです:

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

試してみよう! ESモジュールとしてBootstrapを使用するためのソースコードと動作デモを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は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.8/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-64UC4BEhTGwk3eGpak4nO2jqtl7liTS+juXkSJ2gPAQPmlClQO7s5UgCeR6US48g" 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.8/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セットのデータ属性のみを使用してください(たとえば、同じボタンからツールチップとモーダルをトリガーすることはできません)。

オプションはdata属性またはJavaScriptを介して渡すことができます。data-bs-にオプション名を追加できます。例: data-bs-animation="{value}"。data属性を介してオプションを渡す場合は、オプション名の大文字小文字を"camelCase"から"kebab-case"に変更してください。例えば、data-bs-customClass="beautifier"の代わりにdata-bs-custom-class="beautifier"を使用します。

Bootstrap 5.2.0以降、すべてのコンポーネントは、JSON文字列として単純なコンポーネント設定を格納できる実験的な予約済みdata属性data-bs-configをサポートしています。要素にdata-bs-config='{"delay":0, "title":123}'とdata-bs-title="456"属性がある場合、最終的なtitle値は456になり、個別のdata属性はdata-bs-configで指定された値を上書きします。さらに、既存のdata属性はdata-bs-delay='{"show":0,"hide":150}'のようなJSON値を格納できます。

最終的な設定オブジェクトは、data-bs-config、data-bs-、およびjs objectのマージされた結果であり、最後に指定されたキー値が他の値を上書きします。

セレクター

パフォーマンス上の理由から、ネイティブのquerySelectorおよびquerySelectorAllメソッドを使用してDOM要素をクエリするため、有効なセレクターを使用する必要があります。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

すべてのコンストラクタは、オプションのoptionsオブジェクトまたは何も受け入れません(デフォルトの動作でプラグインを初期化します):

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要素に保存されたデータを削除します)
getInstanceDOM要素に関連付けられたモーダルインスタンスを取得できる静的メソッド。
getOrCreateInstanceDOM要素に関連付けられたモーダルインスタンスを取得するか、初期化されていない場合は新しいインスタンスを作成できる静的メソッド。
静的プロパティ説明
NAMEプラグイン名を返します。(例: bootstrap.Tooltip.NAME)
VERSION各Bootstrapプラグインのバージョンは、プラグインのコンストラクタのVERSIONプロパティからアクセスできます(例: bootstrap.Tooltip.VERSION)

サニタイザー

ツールチップとポップオーバーコンポーネントは、設定すればページに任意のHTMLをレンダリングできます。 クロスサイトスクリプティング(XSS)攻撃を防ぐために、これらのコンポーネントは組み込みのコンテンツサニタイザーを使用して、ページにレンダリングされる前にHTMLを受け入れるオプションをサニタイズします。コンテンツのサニタイズはデフォルトで有効になっています。

デフォルトで許可されているタグと属性は次のとおりです。明示的に許可されていないタグまたは属性は、サニタイズ中に削除されます:

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

これらの高度なオプションを使用する際は注意してください。 詳細については、OWASPのクロスサイトスクリプティング防止チートシートを参照してください。コンテンツのサニタイズを無効化または変更することによってのみ引き起こされる脆弱性は、Bootstrapのセキュリティモデルの範囲内とは見なされません。

このデフォルトの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')

他のコンポーネントについても同様です。

競合なし

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

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

JavaScriptが無効の場合

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