Bootstrap 提示工具


Bootstrap 提示工具(Tooltip)外掛程式

當您想要描述一個連結的時候,提示工具(Tooltip)就顯得非常有用。提示工具(Tooltip)外掛程式是受 Jason Frame 寫的 jQuery.tipsy 的啟發。提示工具(Tooltip)插件做了許多改進,例如不需要依賴圖像,而是改用 CSS 實現動畫效果,用 data 屬性儲存標題資訊。

如果您想要單獨引用該外掛程式的功能,那麼您需要引用 tooltip.js。或者,如 Bootstrap 外掛程式概覽 一章所提到,您可以引用 bootstrap.js 或壓縮版的 bootstrap.min.js

用法

提示工具(Tooltip)外掛程式根據需求產生內容和標記,預設是把提示工具(tooltip)放在它們的觸發元素後面。您可以有以下兩種方式新增提示工具(tooltip):

  • 透過data 屬性:如需新增一個提示工具(tooltip),只需將一個錨標籤添加data-toggle="tooltip" 即可。錨的 title 即為提示工具(tooltip)的文字。預設情況下,外掛程式把提示工具(tooltip)設定在頂部。

<a href="#" data-toggle="tooltip" title="Example tooltip">請懸停在我的上面</a>
  • 透過JavaScript:透過JavaScript 觸發提示工具(tooltip):

$( '#identifier').tooltip(options)
        提示工具(Tooltip)插件不像先前討論的下拉式選單及其他插件那樣,它不是純CSS 插件。如需使用該插件,您必須使用 jquery 啟動它(讀取 javascript)。使用下面的腳本來啟用頁面中的所有的提示工具(tooltip):
$(function () { $("[data-toggle='tooltip']").tooltip(); });

實例

下面的實例演示了透過 data 屬性使用提示工具(Tooltip)插件的用法。

實例

<!DOCTYPE html>
<html>
<head>
   <title>Bootstrap 实例 - 提示工具(Tooltip)插件</title>
   <link href="http://libs.baidu.com/bootstrap/3.3.0/css/bootstrap.min.css" rel="stylesheet">
  <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
  <script src="http://libs.baidu.com/bootstrap/3.3.0/js/bootstrap.min.js"></script>
</head>
<body>

<h4>提示工具(Tooltip)插件 - 锚</h4>
这是一个 <a href="#" class="tooltip-test" data-toggle="tooltip" 
   title="默认的 Tooltip">
   默认的 Tooltip
</a>.
这是一个 <a href="#" class="tooltip-test" data-toggle="tooltip" 
   data-placement="left" title="左侧的 Tooltip">
   左侧的 Tooltip
</a>.
这是一个 <a href="#" data-toggle="tooltip" data-placement="top" 
   title="顶部的 Tooltip">
   顶部的 Tooltip
</a>.
这是一个 <a href="#" data-toggle="tooltip" data-placement="bottom" 
   title="底部的 Tooltip">
   底部的 Tooltip
</a>.
这是一个 <a href="#" data-toggle="tooltip" data-placement="right" 
   title="右侧的 Tooltip">
   右侧的 Tooltip
</a>

<br>

<h4>提示工具(Tooltip)插件 - 按钮</h4>
<button type="button" class="btn btn-default" data-toggle="tooltip" 
   title="默认的 Tooltip">
   默认的 Tooltip
</button>
<button type="button" class="btn btn-default" data-toggle="tooltip" 
   data-placement="left" title="左侧的 Tooltip">
   左侧的 Tooltip
</button>
<button type="button" class="btn btn-default" data-toggle="tooltip" 
   data-placement="top" title="顶部的 Tooltip">
   顶部的 Tooltip
</button>
<button type="button" class="btn btn-default" data-toggle="tooltip" 
   data-placement="bottom" title="底部的 Tooltip">
   底部的 Tooltip
</button>
<button type="button" class="btn btn-default" data-toggle="tooltip" 
   data-placement="right" title="右侧的 Tooltip">
   右侧的 Tooltip
</button>
<script>
   $(function () { $("[data-toggle='tooltip']").tooltip(); });
</script>

</body>
</html>

執行實例 »

點擊 "執行實例" 按鈕查看線上實例

選項

有一些選項是透過 Bootstrap 資料 API(Bootstrap Data API)新增或透過 JavaScript 呼叫的。下表列出了這些選項:

##如果提供了一個選擇器,提示工具物件將被委派到指定的目標。 titlestring | functiondata-title如果未指定triggerstringdata-trigger #定義如何觸發提示工具:contentstring | functiondata-content如果未指定delaynumber | objectdata-delay#延遲顯示和隱藏提示工具的毫秒數- 對manual 手動觸發類型不適用。如果提供的是一個數字,那麼延遲將會套用於顯示和隱藏。如果提供的是對象,結構如下所示:
delay:
{ show: 500, hide: 100 }
containerstring | false#data-container向指定元素追加提示工具。 #

方法

以下是一些提示工具(Tooltip)外掛程式中有用的方法:

選項名稱#類型/預設值#Data 屬性名稱#描述
animationboolean
預設值:true
data-animation提示工具使用CSS 漸層濾鏡效果。
htmlboolean
預設值:false
data-html向提示工具插入HTML。如果為 false,jQuery 的 text 方法將用於向 dom 插入內容。如果您擔心 XSS 攻擊,請使用 text。
placementstring|function
預設值:top
data-placement規定如何定位提示工具(即top|bottom|left|right|auto)。
當指定為 auto 時,會動態調整提示工具。例如,如果 placement 是 "auto left",提示工具將會盡可能顯示在左邊,在情況不允許的情況下它才會顯示在右邊。
selectorstring
預設值:false
data-selector

預設值:''
title 屬性,則title 選項是預設的title 值。

預設值:'hover focus'
click| hover | focus | manual。您可以傳遞多個觸發器,每個觸發器之間以空格分隔。

預設值:''
data-content 屬性,則使用預設的content 值。

預設值:0

預設值:false
實例: container: 'body'
描述 實例
Options: .tooltip(options)#向元素集合附加提示工具句柄。
$().tooltip(options)
Toggle: .tooltip('toggle')#切換顯示/隱藏元素的提示工具。
$('#element').tooltip('toggle')
Show: .tooltip('show')顯示元素的提示工具。
$('#element').tooltip('show')
Hide: .tooltip('hide')隱藏元素的提示工具。
$('#element').tooltip('hide')
Destroy: .tooltip('destroy') 隱藏並銷毀元素的提示工具。
$('#element').tooltip('destroy')

實例

下面的實例示範了提示工具(Tooltip)外掛程式方法的用法。

實例

<!DOCTYPE html>
<html>
<head>
   <title>Bootstrap 实例 - 提示工具(Tooltip)插件方法</title>
   <link href="http://libs.baidu.com/bootstrap/3.3.0/css/bootstrap.min.css" rel="stylesheet">
  <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
  <script src="http://libs.baidu.com/bootstrap/3.3.0/js/bootstrap.min.js"></script>
</head>
<body>

<div style="padding: 100px 100px 10px;">
   这是一个 <a href="#" class="tooltip-show" data-toggle="tooltip" 
      title="show">Tooltip 方法 show
   </a>.

   这是一个 <a href="#" class="tooltip-hide" data-toggle="tooltip" 
      data-placement="left" title="hide">Tooltip 方法 hide
   </a>.

   这是一个 <a href="#" class="tooltip-destroy" data-toggle="tooltip" 
      data-placement="top" title="destroy">Tooltip 方法 destroy
   </a>.

   这是一个 <a href="#" class="tooltip-toggle" data-toggle="tooltip" 
      data-placement="bottom" title="toggle">Tooltip 方法 toggle
   </a>.
   <br><br><br><br><br><br>
   <p class="tooltip-options" >
      这是一个 <a href="#" data-toggle="tooltip" title="<h2>'am Header2
         </h2>">Tooltip 方法 options
      </a>.
   </p>

   <script>
      $(function () { $('.tooltip-show').tooltip('show');});
      $(function () { $('.tooltip-hide').tooltip('hide');});
      $(function () { $('.tooltip-destroy').tooltip('destroy');});
      $(function () { $('.tooltip-toggle').tooltip('toggle');});
      $(function () { $(".tooltip-options a").tooltip({html : true });
      });
   </script>
<div>

</body>
</html>

運行實例»

點擊"運行實例" 按鈕查看線上實例

事件

下表列出了提示工具(Tooltip)外掛程式中要用到的事件。這些事件可在函數中當鉤子使用。

事件描述實例
show.bs.tooltip 當呼叫show 實例方法時立即觸發該事件。
$('#myTooltip').on('show.bs.tooltip', function () {
  // 执行一些动作...
})
shown.bs.tooltip當提示工具對使用者可見時觸發該事件(將等待 CSS 過渡效果完成)。
$('#myTooltip').on('shown.bs.tooltip', function () {
  // 执行一些动作...
})
hide.bs.tooltip當呼叫 hide 實例方法時立即觸發該事件。
$('#myTooltip').on('hide.bs.tooltip', function () {
  // 执行一些动作...
})
hidden.bs.tooltip當提示工具隱藏時觸發該事件(將等待 CSS 過渡效果完成)。
$('#myTooltip').on('hidden.bs.tooltip', function () {
  // 执行一些动作...
})

#實例

下面的實例示範了提示工具(Tooltip)外掛事件的用法

實例

<!DOCTYPE html>
<html>
<head>
   <title>Bootstrap 实例 - 提示工具(Tooltip)插件事件</title>
   <link href="http://libs.baidu.com/bootstrap/3.3.0/css/bootstrap.min.css" rel="stylesheet">
  <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
  <script src="http://libs.baidu.com/bootstrap/3.3.0/js/bootstrap.min.js"></script>
</head>
<body>

<h4>提示工具(Tooltip)插件 - 锚</h4>
这是一个 <a href="#" class="tooltip-show" data-toggle="tooltip" 
   title="默认的 Tooltip">默认的 Tooltip
</a>.

<script>
$(function () { $('.tooltip-show').tooltip('show');});
$(function () { $('.tooltip-show').on('show.bs.tooltip', function () {
   alert("Alert message on show");
})});
</script>

</body>
</html>

運行實例»

點擊"運行實例"按鈕查看線上實例


##### ##