Skip to content

Tooltip 文本提示框

一般用在元素hover时展示简短的提示信息

TIP

仅介绍部分用法。

Tooltip是基于Floating组件开发的, 几乎继承了其全部Props, 具体可参考Floating 浮动

基础用法

tooltip提供12种不同的方位来定位floating元素

主题

通过 theme 可以设置提示框的主题,默认为dark

WARNING

在不直接修改样式的情况下, 提示框的颜色固定

通过slot设置提示信息

通过 content 槽也可以设置提示信息, 使用slot.content,使得Tooltip提示的不仅仅是文字。

WARNING

slot.content优先级高于props.content, 两者同时设置时将会选择slot.content

Tooltip API

Tooltip Props

属性名说明可选值默认值
trigger触发浮动元素显示的类型'hover' | 'click' | 'foucs' | 'clickToOpen' | 'unset'hover
placement浮动元素的定位'top' | 'left' | 'bottom' | 'right' | 'top-start' | 'left-start' | 'bottom-start' | 'right-start' | 'top-end' | 'left-end' | 'bottom-end' | 'right-end'bottom
transition浮动元素出现/消失过渡Stringfade
openDelay浮动元素打开延时Number50ms
closeDelay浮动元素关闭延时Number200ms
disabled是否禁用浮动元素Booleanfalse
offset浮动元素的偏移量Number10
variant浮动元素的表现形式'light' | 'dark'dark
closeOnClickBody是否在点击其他元素时关闭Booleanfalse
openOnMounted是否在挂载时立即显示Booleanfalse
teleported是否瞬移到body元素下Booleantrue
showArrow是否显示箭头Booleantrue
floatingClassfloating元素默认会嵌套一层div,设置这层div的类名String---
reference解耦模式下的引用元素Ref<MaybeElement>---
quickTrack是否开启快速跟踪,若浮动元素跟不上引用元素的改变开启此项Booleanfalse
content提示框的文本String---

Tooltip Events

事件名说明类型
open浮动元素打开时的回调() => void
opened浮动元素打开后的回调() => void
close浮动元素关闭时的回调() => void
closed浮动元素关闭后的回调() => void

Tooltip Slots

名称说明
default用作Floating的引用元素
content用作Floating的浮动元素

Tooltip Exposes

属性名说明类型
close用于关闭浮动元素() => void
open用于打开浮动元素() => void
toggle前两者自动选择其一() => void

源代码

组件

贡献者

Released under the MIT License.