ツールチップ

概要

ツールチッププラグインを使用する際の注意点

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

すべて理解できましたか？素晴らしい！それでは、いくつかの例を見てみましょう。

例

ツールチップを有効にする

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

const tooltipTriggerList = document.querySelectorAll('[data-bs-toggle="tooltip"]')
const tooltipList = [...tooltipTriggerList].map(tooltipTriggerEl => new bootstrap.Tooltip(tooltipTriggerEl))

リンクへのツールチップ

以下のリンクにカーソルを合わせると、ツールチップが表示されます。

<p class="muted">Placeholder text to demonstrate some <a href="#" data-bs-toggle="tooltip" data-bs-title="Default tooltip">inline links</a> with tooltips. This is now just filler, no killer. Content placed here just to mimic the presence of <a href="#" data-bs-toggle="tooltip" data-bs-title="Another tooltip">real text</a>. And all that just to give you an idea of how tooltips would look when used in real-world situations. So hopefully you've now seen how <a href="#" data-bs-toggle="tooltip" data-bs-title="Another one here too">these tooltips on links</a> can work in practice, once you use them on <a href="#" data-bs-toggle="tooltip" data-bs-title="The last tip!">your own</a> site or project.</p>

カスタムツールチップ

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

.custom-tooltip {
  --bs-tooltip-bg: var(--bd-violet-bg);
  --bs-tooltip-color: var(--bs-white);
}

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

方向

以下のボタンにカーソルを合わせると、4つのツールチップの方向（上、右、下、左）が表示されます。RTLでBootstrapを使用する場合、方向は反転されます。

<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="top" data-bs-title="Tooltip on top">
  Tooltip on top
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="right" data-bs-title="Tooltip on right">
  Tooltip on right
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="bottom" data-bs-title="Tooltip on bottom">
  Tooltip on bottom
</button>
<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-placement="left" data-bs-title="Tooltip on left">
  Tooltip on left
</button>

カスタムHTMLを追加

<button type="button" class="btn btn-secondary" data-bs-toggle="tooltip" data-bs-html="true" data-bs-title="<em>Tooltip</em> <u>with</u> <b>HTML</b>">
  Tooltip with HTML
</button>

SVG付き

CSS

変数

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

--#{$prefix}tooltip-zindex: #{$zindex-tooltip};
--#{$prefix}tooltip-max-width: #{$tooltip-max-width};
--#{$prefix}tooltip-padding-x: #{$tooltip-padding-x};
--#{$prefix}tooltip-padding-y: #{$tooltip-padding-y};
--#{$prefix}tooltip-margin: #{$tooltip-margin};
@include rfs($tooltip-font-size, --#{$prefix}tooltip-font-size);
--#{$prefix}tooltip-color: #{$tooltip-color};
--#{$prefix}tooltip-bg: #{$tooltip-bg};
--#{$prefix}tooltip-border-radius: #{$tooltip-border-radius};
--#{$prefix}tooltip-opacity: #{$tooltip-opacity};
--#{$prefix}tooltip-arrow-width: #{$tooltip-arrow-width};
--#{$prefix}tooltip-arrow-height: #{$tooltip-arrow-height};

Sass変数

$tooltip-font-size:                 $font-size-sm;
$tooltip-max-width:                 200px;
$tooltip-color:                     var(--#{$prefix}body-bg);
$tooltip-bg:                        var(--#{$prefix}emphasis-color);
$tooltip-border-radius:             var(--#{$prefix}border-radius);
$tooltip-opacity:                   .9;
$tooltip-padding-y:                 $spacer * .25;
$tooltip-padding-x:                 $spacer * .5;
$tooltip-margin:                    null; // TODO: remove this in v6

$tooltip-arrow-width:               .8rem;
$tooltip-arrow-height:              .4rem;
// fusv-disable
$tooltip-arrow-color:               null; // Deprecated in Bootstrap 5.2.0 for CSS variables
// fusv-enable

使用方法

ツールチッププラグインは、オンデマンドでコンテンツとマークアップを生成し、デフォルトではトリガー要素の後にツールチップを配置します。JavaScriptを介してツールチップをトリガーします。

const exampleEl = document.getElementById('example')
const tooltip = new bootstrap.Tooltip(exampleEl, options)

const tooltip = new bootstrap.Tooltip('#example', {
  boundary: document.body // or document.querySelector('#boundary')
})

マークアップ

ツールチップに必要なマークアップは、ツールチップを表示するHTML要素のdata属性とtitleだけです。ツールチップの生成されたマークアップは非常にシンプルですが、位置（デフォルトではプラグインによってtopに設定されます）が必要です。

<!-- HTML to write -->
<a href="#" data-bs-toggle="tooltip" data-bs-title="Some tooltip text!">Hover over me</a>

<!-- Generated markup by the plugin -->
<div class="tooltip bs-tooltip-auto" role="tooltip">
  <div class="tooltip-arrow"></div>
  <div class="tooltip-inner">
    Some tooltip text!
  </div>
</div>

無効な要素

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

<span class="d-inline-block" tabindex="0" data-bs-toggle="tooltip" data-bs-title="Disabled tooltip">
  <button class="btn btn-primary" type="button" disabled>Disabled button</button>
</span>

オプション

オプションはデータ属性または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 tooltip = new bootstrap.Tooltip(element, {
  popperConfig(defaultBsPopperConfig) {
    // const newPopperConfig = {...}
    // use defaultBsPopperConfig if needed...
    // return newPopperConfig
  }
})

メソッド

const tooltip = bootstrap.Tooltip.getInstance('#example') // Returns a Bootstrap tooltip instance

// setContent example
tooltip.setContent({ '.tooltip-inner': 'another title' })

イベント

const myTooltipEl = document.getElementById('myTooltip')
const tooltip = bootstrap.Tooltip.getOrCreateInstance(myTooltipEl)

myTooltipEl.addEventListener('hidden.bs.tooltip', () => {
  // do something...
})

tooltip.hide()