悬停卡片
概述
当鼠标悬停或元素获得焦点时,显示可承载更丰富内容的预览卡片。SHoverCard 组合 Aria HoverCardRoot/HoverCardTrigger/HoverCardPositioner/HoverCardPopup/HoverCardArrow 基础组件家族(构建于共享 Popper)与 hoverCardVariants 样式配方(3 个槽、6 种尺寸)。
悬停卡片适合非阻塞、悬停触发的预览(用户资料、仓库预览、内联元数据)。小的文本提示请用 tooltip;点击触发的丰富内容请用 popover。
用法
特性
- 🧩 Aria/样式分离 —
HoverCardCompact聚合 popper 触发器、定位器、弹层与箭头;SHoverCard只注入样式并转发插槽/事件 - ⏱️ 打开/关闭延迟 —
openDelay(默认 700ms)/closeDelay(默认 300ms)调节悬停延迟 - 🎯 定位 — 完整 popper
placement控制,带碰撞避免与按侧滑入动画 - 🔽 箭头 —
showArrow渲染定位箭头;经arrowProps可配置 - ⌨️ 焦点触发 — 除指针悬停外,键盘焦点也会打开
- 📐 6 种尺寸 — xs–2xl
size;逐槽ui覆盖 - ♿ 无障碍 — Escape/外部交互关闭,打开与关闭时
axe-core零违规
组件家族
SHoverCard(样式层)— 入口包装组件;hoverCardVariants配方配合动态插槽转发HoverCardRoot(Aria)— 状态持有者;经useControllableState维护open,提供openDelay/closeDelay与 popper rootHoverCardTrigger(Aria)— 悬停/聚焦打开卡片的锚点HoverCardPositioner/HoverCardPositionerImpl(Aria)— 可关闭、定位表面(构建于PopperPositioner)HoverCardPopup(Aria)— 弹层主体HoverCardArrow(Aria)— popper 箭头HoverCardCompact(Aria)— 聚合组件;组合触发器/定位器/弹层/箭头并暴露各插槽
演示
基础
自定义样式
API
Aria 层
8HoverCard
属性
| 属性名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
class | ClassValue | — | 弹出窗口类 |
size | ThemeSize | — | 组件的视觉尺寸。 |
ui | Partial<HoverCardUi> | — | 该组件的按槽类重写。 |
placement | import("@/index").Placement | — | 位置。 |
showArrow | boolean | — | 是否显示箭头。 |
triggerProps | PopperAnchorProps | — | 转发给触发元素的属性。 |
portalProps | HoverCardPortalProps | — | 转发给 portal 元素的属性。 |
positionerProps | HoverCardPositionerProps | — | 转发给定位器元素的属性。 |
popupProps | HoverCardPopupProps | — | 转发给弹出窗口元素的属性。 |
arrowProps | HoverCardArrowProps | — | 转发给箭头元素的属性。 |
defaultOpen | boolean | — | 悬停卡片在初始渲染时的展开状态。当无需控制其展开状态时使用。 |
open | boolean | — | 悬停卡片的受控打开状态。 |
openDelay | number | — | 指针进入触发区域后,直至悬停卡片展开所经过的时间。 |
closeDelay | number | — | 指针离开触发器或弹出窗口后,直至悬停卡片关闭所经过的时间。 |
dir | Direction | — | — |
modal | boolean | — | — |
disabled | boolean | — | — |
事件
| 事件名 | 参数 | 描述 |
|---|---|---|
update:open | boolean, reason?: PopperOpenChangeReason | undefined | 当悬停卡片的打开状态发生变化时,会调用此事件处理程序。 |
escapeKeyDown | KeyboardEvent | 当 Esc 键被按下时触发的事件处理程序。可被阻止。 |
pointerDownOutside | PointerDownOutsideEvent | 当 `pointerdown` 事件发生在 `DismissableLayer` 外部时调用的事件处理程序。可被阻止。 |
focusOutside | FocusOutsideEvent | 当焦点移出 `DismissableLayer` 时触发的事件处理程序。可被阻止。 |
插槽
| 插槽名 | 参数 | 描述 |
|---|---|---|
default | — | 默认插槽的自定义内容。 |
trigger | — | 触发槽的自定义内容。 |
HoverCardArrow
HoverCardCompact
属性
| 属性名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
placement | import("@/index").Placement | — | 位置。 |
showArrow | boolean | — | 是否显示箭头。 |
triggerProps | PopperAnchorProps | — | 转发给触发元素的属性。 |
portalProps | HoverCardPortalProps | — | 转发给 portal 元素的属性。 |
positionerProps | HoverCardPositionerProps | — | 转发给定位器元素的属性。 |
popupProps | HoverCardPopupProps | — | 转发给弹出窗口元素的属性。 |
arrowProps | HoverCardArrowProps | — | 转发给箭头元素的属性。 |
defaultOpen | boolean | — | 悬停卡片在初始渲染时的展开状态。当无需控制其展开状态时使用。 |
open | boolean | — | 悬停卡片的受控打开状态。 |
openDelay | number | — | 指针进入触发区域后,直至悬停卡片展开所经过的时间。 |
closeDelay | number | — | 指针离开触发器或弹出窗口后,直至悬停卡片关闭所经过的时间。 |
dir | Direction | — | — |
modal | boolean | — | — |
disabled | boolean | — | — |
事件
| 事件名 | 参数 | 描述 |
|---|---|---|
update:open | boolean, reason?: PopperOpenChangeReason | undefined | 当悬停卡片的打开状态发生变化时,会调用此事件处理程序。 |
escapeKeyDown | KeyboardEvent | 当 Esc 键被按下时触发的事件处理程序。可被阻止。 |
pointerDownOutside | PointerDownOutsideEvent | 当 `pointerdown` 事件发生在 `DismissableLayer` 外部时调用的事件处理程序。可被阻止。 |
focusOutside | FocusOutsideEvent | 当焦点移出 `DismissableLayer` 时触发的事件处理程序。可被阻止。 |
插槽
| 插槽名 | 参数 | 描述 |
|---|---|---|
default | — | 默认插槽的自定义内容。 |
trigger | — | 触发槽的自定义内容。 |
HoverCardPopup
HoverCardPortal
HoverCardPositioner
属性
| 属性名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
placement | Placement | undefined | 浮动元素的位置。
若使用该属性,它将覆盖 `side` 和 `align` 属性。 |
side | Side | 'bottom' | 打开时优先渲染的触发器一侧。当发生碰撞且
enableAvoidCollisions 启用时,该方向将被反转。 |
sideOffset | number | 0 | 距触发器的像素距离。 |
sideFlip | boolean | true | 遇到边界时,请翻转至另一侧。 |
align | Align | 'center' | 首选与触发条件保持一致。若发生冲突,则可能调整。 |
alignOffset | number | 0 | 相对于 `start` 或 `end` 对齐选项的像素偏移量。 |
alignFlip | boolean | true | 当与边界发生冲突时,翻转对齐方式。
此情况仅在 `prioritizePosition` 为 true 时才会发生。 |
avoidCollisions | boolean | true | 当值为 `true` 时,将覆盖“侧边”和“对齐”首选项,以避免与边界边缘发生冲突。 |
collisionBoundary | Element | (Element | null)[] | null | [ ] | 用作碰撞边界的元素。默认情况下,该边界为视口,但您可以提供额外的
元素以纳入此检查范围。 |
collisionPadding | Padding | 0 | 从边界边缘开始,碰撞检测应发生的距离(以像素为单位)。接受一个数字(
所有边均相同),或一个部分填充对象,例如:{ top: 20, left: 20 }。 |
arrowPadding | number | 0 | 箭头与内容边缘之间的间距。如果您的内容使用了 border-radius,这将防止内容
溢出到角落。 |
hideShiftedArrow | boolean | true | 当值为 `true` 时,若无法将箭头居中对齐
到引用元素上,则隐藏该箭头。 |
sticky | 'partial' | 'always' | 'partial' | 在对齐轴上的“粘附”行为。`partial` 会在触发器至少部分位于边界内时将内容保留在边界内,而
“always” 则无论触发器是否位于边界内,都会将内容保留在边界内。 |
hideWhenDetached | boolean | false | 当触发器被完全遮挡时,是否隐藏内容。 |
positionStrategy | 'fixed' | 'absolute' | 'fixed' | 要使用的 CSS `position` 属性的类型。 |
updatePositionStrategy | 'always' | 'optimized' | 'optimized' | 在每个动画帧中更新浮动元素位置的策略。 |
disableUpdateOnLayoutShift | boolean | false | 当布局发生变化时,是否禁用内容的更新位置。 |
prioritizePosition | boolean | false | 强制内容位于视口内。可能会与参考元素重叠,这可能并非预期效果。 |
reference | ReferenceElement | — | 将作为浮动元素定位参考点的自定义元素或虚拟元素。如果
提供了该元素,它将替换默认的锚点元素。 |
trapFocus | boolean | modal | 弹出窗口打开时,焦点是否被困在其中(Tab 键在层内循环,且
模态层的页面滚动被锁定)。 |
disableHoverableContent | boolean | false | 当设置为 `true` 时,鼠标悬停会关闭弹出窗口而非保持其打开状态(宽限区域已禁用,
因此离开触发区域会立即关闭该层)。 |
onGracePointerExit | (() => void) | — | 当指针最终离开宽限区域时触发的回调。允许上层组件(例如
Tooltip)在无需注册自己的第二个宽限区域的情况下,执行区域范围内的关闭逻辑。 |
forceMount | boolean | — | 用于在需要更多控制时强制挂载。
在使用 Vue 动画库控制动画时非常有用。 |
事件
| 事件名 | 参数 | 描述 |
|---|---|---|
escapeKeyDown | KeyboardEvent | 当 Esc 键被按下时触发的事件处理程序。可被阻止。 |
pointerDownOutside | PointerDownOutsideEvent | 当 `pointerdown` 事件发生在 `DismissableLayer` 外部时调用的事件处理程序。可被阻止。 |
focusOutside | FocusOutsideEvent | 当焦点移出 `DismissableLayer` 时触发的事件处理程序。可被阻止。 |
HoverCardRoot
属性
| 属性名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
defaultOpen | boolean | — | 悬停卡片在初始渲染时的展开状态。当无需控制其展开状态时使用。 |
open | boolean | — | 悬停卡片的受控打开状态。 |
openDelay | number | — | 指针进入触发区域后,直至悬停卡片展开所经过的时间。 |
closeDelay | number | — | 指针离开触发器或弹出窗口后,直至悬停卡片关闭所经过的时间。 |
dir | Direction | — | — |
modal | boolean | — | — |
disabled | boolean | — | — |
事件
| 事件名 | 参数 | 描述 |
|---|---|---|
update:open | boolean, reason?: PopperOpenChangeReason | undefined | 当悬停卡片的打开状态发生变化时,会调用此事件处理程序。 |
HoverCardTrigger
注意事项
架构与对标差异
HoverCardCompact 负责触发器/定位器/弹层/箭头组合,所有基础组件保持零样式,仅由 UI 包装组件注入 hoverCardVariants 类。这与 radix-ui/shadcn-ui 的 headless 分离一致,构建于共享 Popper 基础组件之上。Ant Design、Element Plus、Mantine、Naive UI 用单一样式化 popover 做悬停预览;VeanUI 提供专用的悬停卡片,带可配置 openDelay/closeDelay、逐槽 *Props、箭头开关与单包库通常缺失的 size 尺寸体系。
| 能力 | VeanUI | shadcn/ui | Ant Design | Element Plus | Mantine | Naive UI |
|---|---|---|---|---|---|---|
| Aria/样式分离 | ✅ | ✅ | — | — | — | — |
| 打开/关闭延迟 | ✅ | ✅ | — | — | ✅ | — |
| Popper 定位(12) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| 箭头 | ✅ | ✅ | — | — | — | — |
| 尺寸(6) | ✅ | — | — | — | — | — |
| 焦点触发 | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
— = 不支持或采用不同交互模型(悬停预览并入通用 popover)。
运行时注意
- 卡片在悬停与键盘焦点时打开;调节
openDelay/closeDelay以减少误触发(默认 700ms/300ms)。 - 弹层经
Portal渲染(传送至document.body);仅在portalProps: { disabled: true }时置于相对定位的祖先内。 showArrow渲染箭头;arrowProps可覆盖其位置/类。- 悬停卡片非模态,Escape 或外部交互关闭;它不陷阱焦点。
Roadmap
不适用——hover-card 对当前对标集已功能完备。
FAQ
如何调整打开/关闭时机?
设置 open-delay 与 close-delay(毫秒):
<SHoverCard :open-delay="200" :close-delay="100">
<template #trigger><SButton>悬停我</SButton></template>
<div>预览内容</div>
</SHoverCard>如何定位卡片?
使用 placement:
<SHoverCard placement="top">
<template #trigger><SButton>悬停我</SButton></template>
<div>预览内容</div>
</SHoverCard>如何隐藏箭头?
设置 show-arrow={false}:
<SHoverCard :show-arrow="false">
<template #trigger><SButton>悬停我</SButton></template>
<div>预览内容</div>
</SHoverCard>如何控制打开状态?
用 v-model 绑定 open 或使用 defaultOpen:
<SHoverCard v-model:open="open">
<template #trigger><SButton>悬停我</SButton></template>
<div>预览内容</div>
</SHoverCard>