ポップオーバー Popovers

概要

popoverプラグインを使用する際に知っておくべきこと:

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

popoverがいくつかの例でどのように機能するかを見続けてください。

例

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

上記のように、popoverを使用する前に初期化する必要があります。ページ上のすべてのpopoverを初期化する1つの方法は、次のようにdata-bs-toggle属性で選択することです:

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

ライブデモ

上記のスニペットと同様のJavaScriptを使用して、次のライブpopoverをレンダリングします。タイトルは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つのオプションが利用可能です: top、right、bottom、left。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

親要素にpopoverを妨げるスタイルがある場合、popoverのHTMLがその要素内に表示されるように、カスタムcontainerを指定する必要があります。これは、レスポンシブテーブル、input groups、およびその他の場合に一般的です。

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

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

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

カスタムポップオーバー

CSS変数を使用して、popoverの外観をカスタマイズできます。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トリガーを使用して、ユーザーがトグル要素以外の要素を次にクリックしたときにpopoverを却下します。

<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属性を持つ要素はインタラクティブではないため、ユーザーはそれらにカーソルを合わせたりクリックしたりして、popover（またはtooltip）をトリガーすることはできません。回避策として、ラッパー<div>または<span>からpopoverをトリガーし、理想的にはtabindex="0"を使用してキーボードフォーカス可能にします。

無効なpopoverトリガーの場合、ユーザーが無効な要素を_クリック_することを期待しない可能性があるため、即座の視覚的フィードバックとしてpopoverが表示されるように、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は.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を介してpopoverを有効にします:

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

オプション

オプションは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のマージされた結果であり、最後に指定されたキー値が他の値を上書きします。

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...
})