ポップオーバー

概要

ポップオーバープラグインを使うときに知っておきたいこと

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

ポップオーバーがどのように機能するかを確認するために読んでください。

例

ポップオーバーの有効化

上記のように、ポップオーバーを使用する前に初期化する必要があります。ページ上のすべてのポップオーバーを初期化する1つの方法は、次のように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つのオプションが利用可能です。BootstrapをRTLで使用する場合、方向はミラーリングされます。方向を変更するには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のカスタム

親要素にポップオーバーの邪魔になるスタイルがある場合、カスタムしたcontainerを指定して、ポップオーバーのHTMLをその要素内に表示させることができます。これはレスポンシブテーブルや入力グループなどでよくあることです。

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

モーダル内のポップオーバーでは、明示的にカスタムcontainerを設定する必要があります。モーダルダイアログはフォーカスをトラップするので、ポップオーバーがモーダルの子要素でない限り、ユーザーはこれらのインタラクティブな要素にフォーカスを当てたり、アクティブにしたりすることができません。

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(--bs-primary);
  --bs-popover-header-bg: var(--bs-primary);
  --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属性を持つ要素はインタラクティブではありません。つまり、ユーザーがカーソルを合わせたりクリックしたりしても、ポップオーバー（またはツールチップ）が表示されません。回避策としては、ラッパーの<div>または<span>からポップオーバーをトリガーし、 理想的には、tabindex="0"を使ってキーボード・フォーカスを可能します。

無効化された ポップオーバーのトリガーについては、`data-trigger=“hover"を使用できます。これにより、ユーザーは無効化された要素を click することを期待していないため、ポップオーバーがすぐに視覚的なフィードバックとしてユーザーに表示されます。

<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:                $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-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のマージ結果であり、最新のキー値が他の値を上書きする。

popperConfigで関数を使用する

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

Methods

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

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

イベント

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