MDUI文件
複製 llms.txt 連結複製 llms-full.txt 連結以 Markdown 格式檢視此頁與 ChatGPT 討論此頁內容與 ChatGPT 討論專案完整文件
預設顏色
自選顏色
從桌布擷取顏色
請選擇一張桌布
開發指南
AI 輔助開發
樣式
與框架整合
元件
Avatar 頭像Badge 徽章BottomAppBar 底部應用程式列Button 按鈕ButtonIcon 圖示按鈕Card 卡片Checkbox 核取方塊Chip 標籤CircularProgress 環形進度條Collapse 收合區塊Dialog 對話框Divider 分隔線Dropdown 下拉元件Fab 浮動動作按鈕Icon 圖示Layout 版面配置LinearProgress 線性進度條List 清單Menu 選單NavigationBar 底部導覽列NavigationDrawer 導覽抽屜NavigationRail 側邊導覽列Radio 單選按鈕RangeSlider 範圍滑桿Select 選擇框SegmentedButton 分段按鈕Slider 滑桿Snackbar 消息條Switch 切換開關Tabs 分頁TextField 文字欄位Tooltip 工具提示TopAppBar 頂部應用程式列
函式
獨立程式庫

Tooltip工具提示

工具提示用來為特定元素提供補充文字提示或上下文資訊,方便使用者更好地理解該元素的功能或用途。

使用方法

按需引入元件:

import 'mdui/components/tooltip.js';

按需引入元件的 TypeScript 型別:

import type { Tooltip } from 'mdui/components/tooltip.js';

使用範例:

button
<mdui-tooltip content="Plain tooltip">
  <mdui-button>button</mdui-button>
</mdui-tooltip>

範例

純文字工具提示

預設為純文字工具提示。可以透過 content 屬性設定工具提示的內容。

也可以透過 content slot 設定工具提示的內容。

進階工具提示

設定 variant 屬性為 rich 可以建立進階工具提示。可以透過 headline 屬性設定工具提示的標題,content 屬性設定工具提示的內容。

也可以透過 headlinecontent slot 設定工具提示的標題和內容。透過 action slot 設定工具提示的操作按鈕。

位置

透過 placement 屬性可以設定工具提示的位置。

觸發方式

透過 trigger 屬性,可以設定工具提示的觸發方式。

開啟/關閉延遲

當觸發方式為 hover 時,可以透過 open-delayclose-delay 屬性分別設定開啟與關閉工具提示的延遲,單位為毫秒。

停用狀態

加上 disabled 屬性即可停用工具提示。

API

屬性

HTML 屬性JavaScript 屬性Reflect型別預設值
variantvariant'plain' | 'rich''plain'

tooltip 的形狀。預設為 plain。可選值包括:

  • plain:純文字,適用於簡單的單行文字
  • rich:富文字,可以包含標題、正文和操作按鈕
placementplacement'auto' | 'top-left' | 'top-start' | 'top' | 'top-end' | 'top-right' | 'bottom-left' | 'bottom-start' | 'bottom' | 'bottom-end' | 'bottom-right' | 'left-start' | 'left' | 'left-end' | 'right-start' | 'right' | 'right-end''auto'

tooltip 的位置。預設為 auto。可選值包括:

  • auto:自動判斷位置。variant="plain" 時,優先使用 topvariant="rich" 時,優先使用 bottom-right
  • top-left:位於左上方
  • top-start:位於上方,左對齊
  • top:位於上方,置中對齊
  • top-end:位於上方,右對齊
  • top-right:位於右上方
  • bottom-left:位於左下方
  • bottom-start:位於下方,左對齊
  • bottom:位於下方,置中對齊
  • bottom-end:位於下方,右對齊
  • bottom-right:位於右下方
  • left-start:位於左側,頂部對齊
  • left:位於左側,置中對齊
  • left-end:位於左側,底部對齊
  • right-start:位於右側,頂部對齊
  • right:位於右側,置中對齊
  • right-end:位於右側,底部對齊
open-delayopenDelaynumber150

滑鼠懸停觸發顯示的延遲,單位為毫秒

close-delaycloseDelaynumber150

滑鼠懸停觸發隱藏的延遲,單位為毫秒

headlineheadlinestring-

tooltip 的標題。僅 variant="rich" 時可使用。也可以透過 slot="headline" 設定

contentcontentstring-

tooltip 的內容。也可以透過 slot="content" 設定

triggertrigger'click' | 'hover' | 'focus' | 'manual' | string'hover focus'

觸發方式,支援多個值,用空格分隔。可選值包括:

  • click:點擊時觸發
  • hover:滑鼠懸停時觸發
  • focus:聚焦時觸發
  • manual:只能透過程式方式開啟和關閉 tooltip,不能再指定其他觸發方式
disableddisabledbooleanfalse

是否停用 tooltip

openopenbooleanfalse

是否顯示 tooltip

事件

名稱
open

tooltip 開始顯示時觸發。可透過呼叫 event.preventDefault() 阻止 tooltip 開啟

opened

tooltip 顯示動畫完成時,事件被觸發

close

tooltip 開始隱藏時觸發。可透過呼叫 event.preventDefault() 阻止 tooltip 關閉

closed

tooltip 隱藏動畫完成時,事件被觸發

Slots

名稱
預設

tooltip 觸發的目標元素,只有 default slot 中的第一個元素會作為目標元素

headline

tooltip 的標題,只有當 variant="rich" 時,此 slot 才有效

content

tooltip 的內容,可以包含 HTML。若只包含純文字,可以使用 content 屬性代替

action

tooltip 底部的按鈕,只有當 variant="rich" 時,此 slot 才有效

CSS Parts

名稱
popup

tooltip 的容器

headline

標題

content

正文

action

操作按鈕

CSS 自訂屬性

名稱
--shape-corner-plain

當 variant="plain" 時,元件的圓角大小。可以指定一個具體的像素值;但更推薦引用設計令牌

--shape-corner-rich

當 variant="rich" 時,元件的圓角大小。可以指定一個具體的像素值;但更推薦引用設計令牌

--z-index

元件的 CSS z-index

本頁目錄