Hover card

A preview that appears when a link is hovered or focused, and can be moved into.

Install

If this is the first component in the project, set up once. This writes ermine.json and copies the theme stylesheet. The installation guide covers Vue, Nuxt and Astro.

npx ermineui init
pnpm dlx ermineui init
yarn dlx ermineui init
bunx ermineui init

Then add the component:

npx ermineui add hover-card
pnpm dlx ermineui add hover-card
yarn dlx ermineui add hover-card
bunx ermineui add hover-card

That copies 5 files into src/components/ui/hover-card/, 4 helpers into src/lib/ermine/. Files you already have are kept.

Use

import { HoverCard, HoverCardContent, HoverCardTrigger } from '@/components/ui/hover-card'
<Collapsible v-model:open="open">
  <CollapsibleTrigger as-child><Button variant="outline">Details</Button></CollapsibleTrigger>
  <CollapsibleContent>…</CollapsibleContent>
</Collapsible>

<HoverCard>
  <HoverCardTrigger href="/people/ines">Ines Kovač</HoverCardTrigger>
  <HoverCardContent>Owner · 214 deployments this year</HoverCardContent>
</HoverCard>

<Sidebar v-model:collapsed="collapsed">
  <SidebarGroup label="Project">
    <SidebarItem :as="NuxtLink" to="/deployments" active>
      <template #icon><svg>…</svg></template>
      Deployments
    </SidebarItem>
  </SidebarGroup>
</Sidebar>

<EmptyState title="No deployments yet" description="Push to main and it will show up here.">
  <Button>Deploy now</Button>
</EmptyState>

In Nuxt, with the auto-import setting, the tags work in templates without the import. In Astro, use it inside a Vue island.

What gets copied

FileWhere it goes
HoverCard.vuesrc/components/ui/hover-card/HoverCard.vue
HoverCardContent.vuesrc/components/ui/hover-card/HoverCardContent.vue
HoverCardTrigger.vuesrc/components/ui/hover-card/HoverCardTrigger.vue
context.tssrc/components/ui/hover-card/context.ts
index.tssrc/components/ui/hover-card/index.ts
context.ts helpersrc/lib/ermine/context.ts
floating.ts helpersrc/lib/ermine/floating.ts
layer.ts helpersrc/lib/ermine/layer.ts
primitive.ts helpersrc/lib/ermine/primitive.ts

The folders are the suggested ones. ermine.json says where yours are.

Source

This is exactly what the command copies. To install by hand, create each file below and the helpers listed above.

HoverCard.vue 37 lines
<script setup lang="ts">
import { onBeforeUnmount, ref } from 'vue'
import { provideHoverCard } from './context'

const props = withDefaults(
  defineProps<{
    /** Time the pointer must rest on the trigger before the card appears, in ms. */
    openDelay?: number
    /** Time the card stays after the pointer leaves, in ms — long enough to move into it. */
    closeDelay?: number
  }>(),
  { openDelay: 400, closeDelay: 200 },
)

const open = defineModel<boolean>('open', { default: false })
let timer: ReturnType<typeof setTimeout> | undefined

function show() {
  clearTimeout(timer)
  if (!open.value) timer = setTimeout(() => (open.value = true), props.openDelay)
}

function hide(immediate = false) {
  clearTimeout(timer)
  if (immediate) open.value = false
  else timer = setTimeout(() => (open.value = false), props.closeDelay)
}

onBeforeUnmount(() => clearTimeout(timer))

provideHoverCard({ open, show, hide, anchor: ref(null) })
</script>

<template>
  <slot :open="open" />
</template>
HoverCardContent.vue 66 lines
<script setup lang="ts">
import { ref } from 'vue'
import { useFloating, type Align, type Side } from '../../lib/floating'
import { useLayer } from '../../lib/layer'
import { Portal } from '../../lib/primitive'
import { useHoverCard } from './context'

defineOptions({ inheritAttrs: false })

const props = withDefaults(
  defineProps<{
    side?: Side
    align?: Align
    /** Gap between trigger and card, in px. */
    sideOffset?: number
  }>(),
  { side: 'bottom', align: 'center', sideOffset: 6 },
)

const card = useHoverCard()
const content = ref<HTMLElement | null>(null)

useFloating(card.anchor, content, card.open, props)
useLayer(content, card.open, {
  ignore: () => [card.anchor.value],
  onDismiss: () => card.hide(true),
  // It appears on its own, so it must not pull focus away from wherever the reader is.
  initialFocus: () => false,
  restoreFocus: false,
})
</script>

<template>
  <Portal>
    <Transition name="er-pop">
      <div
        v-if="card.open.value"
        ref="content"
        v-bind="$attrs"
        class="er-floating er-hover-card"
        @pointerenter="card.show()"
        @pointerleave="card.hide()"
        @focusin="card.show()"
        @focusout="card.hide()"
      >
        <slot />
      </div>
    </Transition>
  </Portal>
</template>

<style>
@layer components {
  .er-hover-card {
    width: 18rem;
    padding: 1rem;
    border: 1px solid var(--er-border);
    border-radius: var(--er-radius-md);
    background: var(--er-popover);
    color: var(--er-popover-foreground);
    font-size: 0.875rem;
    box-shadow: var(--er-shadow-md);
  }
}
</style>
HoverCardTrigger.vue 42 lines
<script setup lang="ts">
import type { Component } from 'vue'
import { Primitive, toElement } from '../../lib/primitive'
import { useHoverCard } from './context'

withDefaults(
  defineProps<{
    as?: string | Component
    /** Use the single child (e.g. your own link) as the trigger instead of rendering one. */
    asChild?: boolean
  }>(),
  { as: 'a' },
)

const card = useHoverCard()

function setAnchor(target: unknown) {
  card.anchor.value = toElement(target)
}

function onPointerEnter(event: PointerEvent) {
  // Touch has no hover; a tap should simply follow the link.
  if (event.pointerType !== 'touch') card.show()
}
</script>

<template>
  <!-- The card is a preview of where the link goes, so it is not announced: the link itself says enough. -->
  <Primitive
    :ref="setAnchor"
    :as="as"
    :as-child="asChild"
    :data-state="card.open.value ? 'open' : 'closed'"
    @pointerenter="onPointerEnter"
    @pointerleave="card.hide()"
    @focus="card.show()"
    @blur="card.hide()"
  >
    <slot />
  </Primitive>
</template>
context.ts 12 lines
import type { Ref } from 'vue'
import { createContext } from '../../lib/context'

export interface HoverCardContext {
  open: Ref<boolean>
  show: () => void
  hide: (immediate?: boolean) => void
  anchor: Ref<HTMLElement | null>
}

export const [provideHoverCard, useHoverCard] = createContext<HoverCardContext>('HoverCard')
index.ts 5 lines
/** Hover card — a preview that appears when a link is hovered or focused, and can be moved into. */
export { default as HoverCard } from './HoverCard.vue'
export { default as HoverCardContent } from './HoverCardContent.vue'
export { default as HoverCardTrigger } from './HoverCardTrigger.vue'