Skip to content

Search documentation

Search guides, examples, and component APIs.

Quick links
↑↓ NavigateEnter OpenEsc Close
Get started

Documentation navigation

Components / Overlays

Hover Card

A preview panel opened by hover, focus, or click.

Last changed in version 0.13.0: Add avatar groups and chips, expand the block gallery, and improve component colors, spacing, and motion.

Interactive showcase

Install

Run in your project
bunx --bun @getweini/cli@latest add hover-card

Start with this example

Import the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.

Vue
<script setup lang="ts">
import HoverCard from './components/ui/hover-card/HoverCard.vue'
</script>
<template>
  <HoverCard trigger="Project details" label="Project preview">
    <strong>Design system</strong>
    <p>Shared components and tokens</p>
  </HoverCard>
</template>

The panel triangle points to its trigger, including when the panel flips near a viewport edge. Use a button for previews that must work on touch. Escape closes and restores trigger focus; custom triggers bind all provided props.

When to use it

Person preview

Show brief contextual information without opening a full profile.

Project summary

Let readers inspect metadata while keeping the underlying navigation available.

More examples

Person summary

The trigger remains a button and the panel has its own name.

Person summary
<script setup lang="ts">
import HoverCard from './components/ui/hover-card/HoverCard.vue'
</script>
<template>
  <HoverCard trigger="Avery Lee" label="Avery Lee profile preview">
    <h3>Avery Lee</h3>
    <p>Design lead · Luxembourg</p>
  </HoverCard>
</template>

Project preview

Align a wider card with its trigger.

Project preview
<script setup lang="ts">
import HoverCard from './components/ui/hover-card/HoverCard.vue'
</script>
<template>
  <HoverCard
    trigger="Design system"
    label="Design system preview"
    :width="360"
    align="start"
    side="bottom"
  >
    <h3>Design system</h3>
    <p>Shared components, patterns, and tokens.</p>
  </HoverCard>
</template>

Complete API

Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.

HoverCard

Complete API for HoverCard
NameType or signatureDefaultWhat it does
labelpropstringRequiredVisible or accessible name for this item.
triggerpropstring | undefinedNot setElement or interaction that opens this content.
disabledpropboolean | undefinedNot setPrevent interaction and show the disabled state.
openDelaypropnumber | undefined500Time to wait before opening after pointer hover.
closeDelaypropnumber | undefined200Time to wait before closing after the pointer leaves.
widthpropnumber | undefined320Choose the width of this content.
gappropnumber | undefined12Space in pixels between the trigger and floating content.
alignprop"start" | "end" | "center" | undefined"center"Choose how content aligns within its container.
sideprop"top" | "bottom" | undefined"bottom"Choose the side on which this content appears.
openmodelboolean | undefinedfalseCurrent open state. Use v-model:open to keep it in sync with your page.
update:openevent[value: boolean]—Requests a new open value from the parent.
triggerslot{ props: { ref: (value: TriggerElement) => void; 'aria-haspopup': "dialog"; 'aria-expanded': boolean; 'aria-controls': string | undefined; onPointerenter: (event: PointerEvent) => void; onPointerleave: (event: PointerEvent) => void; onFocusin: () => void; onFocusout: (event: FocusEvent) => void; onClick: () => void; onKeydown: (event: KeyboardEvent) => void; }; open: boolean; }OptionalContent for the trigger area of HoverCard.
defaultslot{}OptionalContent shown inside HoverCard.
openexposed() => void—Open this component from application code.
closeexposed() => void—Close this component from application code.
Public type definitions
Public types
// packages/frameworks/vue/components/hover-card/types.ts
export interface HoverCardProps {
  label: string
  trigger?: string
  disabled?: boolean
  openDelay?: number
  closeDelay?: number
  width?: number
  gap?: number
  align?: 'start' | 'center' | 'end'
  side?: 'top' | 'bottom'
}

Implementation notes

  • Provide trigger text or a trigger slot with an accessible name.
  • Focus or click opens immediately; pointer hover uses openDelay and pointer leave uses closeDelay.
  • Essential information should also be accessible through normal navigation, especially on touch devices.

Accessibility and localization

  • Provide the panel label in the application’s language.
  • Escape closes and restores focus to the trigger.

Source contract and editing guidance