menuMDUI文件
color_lens
基於 Material Design 3 與 Web Components 的全新 mdui 2 現已發佈,前往查看 mdui 2 開發文件

工具提示

Tooltip 通常用來為圖示提供說明,其內容多為純文字,不含圖片或格式化文字。

呼叫方式

  1. 透過自訂屬性呼叫
  2. 透過 JavaScript 呼叫

呼叫方式

透過自訂屬性呼叫

透過這種方式無需編寫 JavaScript 程式碼。只要在元素上新增 mdui-tooltip="options" 屬性即可啟用該外掛程式。

範例
<button class="mdui-btn mdui-btn-icon" mdui-tooltip="{content: '列印'}">
  <i class="mdui-icon material-icons">local_printshop</i>
</button>
<button class="mdui-btn mdui-btn-icon" mdui-tooltip="{content: '列印', position: 'top'}">
  <i class="mdui-icon material-icons">local_printshop</i>
</button>
<button class="mdui-btn mdui-btn-icon" mdui-tooltip="{content: '列印', delay: 1000}">
  <i class="mdui-icon material-icons">local_printshop</i>
</button>

透過 JavaScript 呼叫

實例化元件:

// selector 為 CSS 選取器或 DOM 元素
// options 為設定參數,見下面的參數清單
var inst = new mdui.Tooltip(selector, options);
執行

參數

參數名稱類型預設值說明
positionstringautoTooltip 的位置。取值範圍包括 autobottomtopleftright
auto 時,會自動判斷位置。預設在下方。優先順序為 bottom > top > left > right
delayint0延遲觸發,單位毫秒。
contentstringTooltip 的內容。

方法

方法名稱說明
open()

開啟 Tooltip

允許傳入設定參數,以便每次開啟時能修改內容,例如 open({ content: 'new content' })。設定參數見上方的參數清單。

close()關閉 Tooltip
toggle()切換 Tooltip 的狀態
getState()傳回 Tooltip 的狀態。共包含四種狀態(openingopenedclosingclosed)。

事件

事件名稱說明參數
open.mdui.tooltip開啟動畫開始時,事件被觸發。event._detail.inst:實例
opened.mdui.tooltip開啟動畫結束時,事件被觸發。
close.mdui.tooltip關閉動畫開始時,事件被觸發。
closed.mdui.tooltip關閉動畫結束時,事件被觸發。