ポップオーバー

概要 🔗

ポップオーバープラグインを使用する際の注意事項

• ポップオーバーは、配置のためにサードパーティライブラリPopperに依存しています。bootstrap.jsの前にpopper.min.jsを含めるか、Popperを含むbootstrap.bundle.min.jsを使用する必要があります。
• ポップオーバーには、依存関係としてポップオーバープラグインが必要です。
• パフォーマンス上の理由から、ポップオーバーはオプトインです。そのため、**自分で初期化する必要があります**。
• 長さ0のtitleとcontentの値では、ポップオーバーが表示されません。
• より複雑なコンポーネント（入力グループ、ボタングループなど）でのレンダリングの問題を回避するには、container: 'body'を指定します。
• 非表示の要素でポップオーバーをトリガーしても機能しません。
• .disabledまたはdisabled属性を持つ要素のポップオーバーは、ラッパー要素でトリガーする必要があります。
• 複数行にわたってラップされたアンカーからトリガーされた場合、ポップオーバーはアンカーの全体の幅の中央に配置されます。この動作を回避するには、<a>に.text-nowrapを使用します。
• 対応する要素がDOMから削除される前に、ポップオーバーを非表示にする必要があります。
• ポップオーバーは、シャドウDOM内の要素からトリガーできます。

ポップオーバーの動作方法をいくつかの例で見ていきましょう。

例 🔗

ポップオーバーを有効にする 🔗

前述のように、ポップオーバーを使用する前に初期化する必要があります。ページ上のすべてのポップオーバーを初期化するには、次のようにdata-bs-toggle属性で選択する方法があります。

const popoverTriggerList = document.querySelectorAll('[data-bs-toggle="popover"]')
const popoverList = [...popoverTriggerList].map(popoverTriggerEl => new bootstrap.Popover(popoverTriggerEl))

ライブデモ 🔗

次のライブポップオーバーを表示するために、上記のスニペットと同様のJavaScriptを使用しています。タイトルはdata-bs-titleで、本文コンテンツはdata-bs-contentで設定されています。

<button type="button" class="btn btn-lg btn-danger" data-bs-toggle="popover" data-bs-title="Popover title" data-bs-content="And here's some amazing content. It's very engaging. Right?">Click to toggle popover</button>

4方向 🔗

上、右、下、左の4つのオプションがあります。RTLでBootstrapを使用する場合、方向は反転します。方向を変更するには、data-bs-placementを設定します。

<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="top" data-bs-content="Top popover">
  Popover on top
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="right" data-bs-content="Right popover">
  Popover on right
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="bottom" data-bs-content="Bottom popover">
  Popover on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-container="body" data-bs-toggle="popover" data-bs-placement="left" data-bs-content="Left popover">
  Popover on left
</button>

カスタムcontainer 🔗

親要素にポップオーバーと干渉するスタイルがある場合、ポップオーバーのHTMLがその要素内に表示されるように、カスタムcontainerを指定する必要があります。これは、レスポンシブテーブル、入力グループなどで一般的です。

const popover = new bootstrap.Popover('.example-popover', {
  container: 'body'
})

明示的なカスタムcontainerを設定する必要があるもう1つの状況は、モーダルダイアログ内のポップオーバーです。これにより、ポップオーバー自体がモーダルに追加されます。これは、インタラクティブな要素を含むポップオーバーに特に重要です。モーダルダイアログはフォーカスをトラップするため、ポップオーバーがモーダルの子要素でない限り、ユーザーはこれらのインタラクティブな要素にフォーカスしたりアクティブにしたりできません。

const popover = new bootstrap.Popover('.example-popover', {
  container: '.modal-body'
})

カスタムポップオーバー 🔗

CSS変数を使用して、ポップオーバーの外観をカスタマイズできます。data-bs-custom-class="custom-popover"を使用してカスタムクラスを設定し、カスタムの外観をスコープし、一部のローカルCSS変数をオーバーライドするために使用します。

.custom-popover {
  --bs-popover-max-width: 200px;
  --bs-popover-border-color: var(--bd-violet-bg);
  --bs-popover-header-bg: var(--bd-violet-bg);
  --bs-popover-header-color: var(--bs-white);
  --bs-popover-body-padding-x: 1rem;
  --bs-popover-body-padding-y: .5rem;
}

<button type="button" class="btn btn-secondary"
        data-bs-toggle="popover" data-bs-placement="right"
        data-bs-custom-class="custom-popover"
        data-bs-title="Custom popover"
        data-bs-content="This popover is themed via CSS variables.">
  Custom popover
</button>

次のクリックで閉じる 🔗

focusトリガーを使用して、ユーザーがトグル要素以外の要素を次にクリックしたときにポップオーバーを閉じます。

<a tabindex="0" class="btn btn-lg btn-danger" role="button" data-bs-toggle="popover" data-bs-trigger="focus" data-bs-title="Dismissible popover" data-bs-content="And here's some amazing content. It's very engaging. Right?">Dismissible popover</a>

const popover = new bootstrap.Popover('.popover-dismiss', {
  trigger: 'focus'
})

無効な要素 🔗

disabled属性を持つ要素はインタラクティブではないため、ユーザーはポップオーバー（またはツールチップ）をトリガーするためにホバーまたはクリックできません。回避策として、tabindex="0"を使用してキーボードでフォーカス可能なラッパー<div>または<span>からポップオーバーをトリガーする必要があります。

無効なポップオーバートリガーの場合、ユーザーは無効な要素をクリックすることを期待していないため、data-bs-trigger="hover focus"の方が、ポップオーバーをすぐに視覚的なフィードバックとして表示する方が好ましい場合があります。

<span class="d-inline-block" tabindex="0" data-bs-toggle="popover" data-bs-trigger="hover focus" data-bs-content="Disabled popover">
  <button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

CSS 🔗

変数 🔗

Bootstrapの進化するCSS変数アプローチの一部として、ポップオーバーは、リアルタイムのカスタマイズを強化するために、.popoverでローカルCSS変数を使用するようになりました。CSS変数の値はSassで設定されるため、Sassのカスタマイズも引き続きサポートされています。

--#{$prefix}popover-zindex: #{$zindex-popover};
--#{$prefix}popover-max-width: #{$popover-max-width};
@include rfs($popover-font-size, --#{$prefix}popover-font-size);
--#{$prefix}popover-bg: #{$popover-bg};
--#{$prefix}popover-border-width: #{$popover-border-width};
--#{$prefix}popover-border-color: #{$popover-border-color};
--#{$prefix}popover-border-radius: #{$popover-border-radius};
--#{$prefix}popover-inner-border-radius: #{$popover-inner-border-radius};
--#{$prefix}popover-box-shadow: #{$popover-box-shadow};
--#{$prefix}popover-header-padding-x: #{$popover-header-padding-x};
--#{$prefix}popover-header-padding-y: #{$popover-header-padding-y};
@include rfs($popover-header-font-size, --#{$prefix}popover-header-font-size);
--#{$prefix}popover-header-color: #{$popover-header-color};
--#{$prefix}popover-header-bg: #{$popover-header-bg};
--#{$prefix}popover-body-padding-x: #{$popover-body-padding-x};
--#{$prefix}popover-body-padding-y: #{$popover-body-padding-y};
--#{$prefix}popover-body-color: #{$popover-body-color};
--#{$prefix}popover-arrow-width: #{$popover-arrow-width};
--#{$prefix}popover-arrow-height: #{$popover-arrow-height};
--#{$prefix}popover-arrow-border: var(--#{$prefix}popover-border-color);

Sass変数 🔗

$popover-font-size:                 $font-size-sm;
$popover-bg:                        var(--#{$prefix}body-bg);
$popover-max-width:                 276px;
$popover-border-width:              var(--#{$prefix}border-width);
$popover-border-color:              var(--#{$prefix}border-color-translucent);
$popover-border-radius:             var(--#{$prefix}border-radius-lg);
$popover-inner-border-radius:       calc(#{$popover-border-radius} - #{$popover-border-width}); // stylelint-disable-line function-disallowed-list
$popover-box-shadow:                var(--#{$prefix}box-shadow);

$popover-header-font-size:          $font-size-base;
$popover-header-bg:                 var(--#{$prefix}secondary-bg);
$popover-header-color:              $headings-color;
$popover-header-padding-y:          .5rem;
$popover-header-padding-x:          $spacer;

$popover-body-color:                var(--#{$prefix}body-color);
$popover-body-padding-y:            $spacer;
$popover-body-padding-x:            $spacer;

$popover-arrow-width:               1rem;
$popover-arrow-height:              .5rem;

使用方法 🔗

JavaScriptを使用してポップオーバーを有効にする

const exampleEl = document.getElementById('example')
const popover = new bootstrap.Popover(exampleEl, options)

オプション 🔗

オプションはデータ属性またはJavaScriptを介して渡すことができるため、data-bs-にオプション名を付加できます（data-bs-animation="{value}"など）。データ属性を介してオプションを渡す場合は、オプション名のケースタイプを「camelCase」から「kebab-case」に変更してください。たとえば、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オブジェクトの統合結果であり、最後に指定されたキー値が他の値をオーバーライドします。

popperConfigを使用した関数

const popover = new bootstrap.Popover(element, {
  popperConfig(defaultBsPopperConfig) {
    // const newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})

メソッド

// getOrCreateInstance example
const popover = bootstrap.Popover.getOrCreateInstance('#example') // Returns a Bootstrap popover instance

// setContent example
popover.setContent({
  '.popover-header': 'another title',
  '.popover-body': 'another content'
})

イベント

const myPopoverTrigger = document.getElementById('myPopover')
myPopoverTrigger.addEventListener('hidden.bs.popover', () => {
  // do something...
})