Skip to content

useTooltip

@astryxdesign/core v0.7.1 · useTooltip

参数 ​

参数类型默认值说明
placement'above' | 'below' | 'start' | 'end' | MaybeRefOrGetter'above'相对触发器的方位。逻辑方向:start / end 在 RTL 下自动镜像。空间不够时翻到对面。
alignment'start' | 'center' | 'end' | MaybeRefOrGetter'center'沿方位轴的对齐方式。
delaynumber | MaybeRefOrGetter200悬停多久才显示,单位毫秒。
hideDelaynumber | MaybeRefOrGetter0指针或焦点离开后多久隐藏,单位毫秒。0 表示走内部 100 毫秒的桥接时间。
focusTrigger'auto' | 'always' | 'never' | MaybeRefOrGetter'auto'焦点何时打开提示。auto 只给本来就能聚焦的元素挂焦点监听。
touchTrigger'auto' | 'tap' | 'none' | MaybeRefOrGetter'auto'没有 hover 的触摸设备上轻点做什么。auto 在触发器自己有动作时不打开;tap 总是打开;none 从不打开。
isEnabledboolean | MaybeRefOrGettertrue是否启用悬停与焦点触发。
isOpenboolean | undefined | MaybeRefOrGetter—受控的打开状态。true 强制显示,false 强制隐藏,undefined 交给悬停/焦点管理。
isDefaultOpenbooleanfalse挂载时是否显示。
onShow() => void—提示显示后调用。
onHide() => void—提示隐藏后调用。

返回值 ​

字段类型说明
isOpenComputedRef<boolean>提示当前是否显示。受控的 isOpen 优先于悬停状态。
triggerRefRef<HTMLElement | null>触发器元素。用 :ref 绑上去,hook 会挂事件和 ARIA 关联。
contentRefRef<HTMLElement | null>气泡容器。
idstring气泡的唯一 ID。
anchorIdstring锚点的 CSS 标识,用于高级定位场景。
describedBystring要拼进 aria-describedby 的 ID。hook 已经写到 triggerRef 上了,手写 ARIA 时才需要它。
contentStyleComputedRef<CSSProperties>气泡的内联坐标。
resolvedPlacementComputedRef<'above' | 'below' | 'start' | 'end'>考虑空间翻转之后实际生效的方位。
contentPropsComputedRef<Record<string, unknown>>气泡的属性:id、role="tooltip",以及保持显示的指针事件。