Hover Card

For sighted users to preview content available behind a link.

<script setup lang="ts">
import { HoverCardArrow, HoverCardContent, HoverCardPortal, HoverCardRoot, HoverCardTrigger } from 'akar';
import { ref } from 'vue';
import './styles.css';

const hoverState = ref(false);
</script>

<template>
  <div class="akar-demo akar-demo-HoverCard">
    <HoverCardRoot v-model:open="hoverState">
      <HoverCardTrigger
        class="ImageTrigger"
        href="https://twitter.com/unovue"
        target="_blank"
        rel="noreferrer noopener"
      >
        <img
          class="Image normal"
          src="https://pbs.twimg.com/profile_images/1833445381986045952/jwoHkIIq_400x400.jpg"
          alt="Radix UI"
        >
      </HoverCardTrigger>
      <HoverCardPortal>
        <HoverCardContent
          class="HoverCardContent"
          :side-offset="5"
        >
          <div :style="{ display: 'flex', flexDirection: 'column', gap: 7 }">
            <img
              class="Image large"
              src="https://pbs.twimg.com/profile_images/1833445381986045952/jwoHkIIq_400x400.jpg"
              alt="Radix UI"
            >
            <div :style="{ display: 'flex', flexDirection: 'column', gap: 15 }">
              <div>
                <div class="Text bold">
                  Radix
                </div>
                <div class="Text faded">
                  @radix_ui
                </div>
              </div>
              <div class="Text">
                Components, icons, colors, and templates for building high-quality, accessible UI. Free and open-source.
              </div>
              <div :style="{ display: 'flex', gap: 15 }">
                <div :style="{ display: 'flex', gap: 5 }">
                  <div class="Text bold">
                    0
                  </div>
                  <div class="Text faded">
                    Following
                  </div>
                </div>
                <div :style="{ display: 'flex', gap: 5 }">
                  <div class="Text bold">
                    2,900
                  </div>
                  <div class="Text faded">
                    Followers
                  </div>
                </div>
              </div>
            </div>
          </div>

          <HoverCardArrow
            class="HoverCardArrow"
            :width="8"
          />
        </HoverCardContent>
      </HoverCardPortal>
    </HoverCardRoot>
  </div>
</template>

@import '../_colors/mauve.css';

@scope (.akar-demo-HoverCard) {
  /* reset */
  a {
    all: unset;
  }

  .HoverCardContent {
    border-radius: 6px;
    padding: 20px;
    width: 300px;
    background-color: white;
    box-shadow:
      hsl(206 22% 7% / 35%) 0px 10px 38px -10px,
      hsl(206 22% 7% / 20%) 0px 10px 20px -15px;
    animation-duration: 400ms;
    animation-timing-function: cubic-bezier(0.16, 1, 0.3, 1);
    will-change: transform, opacity;
  }
  .HoverCardContent[data-side='top'] {
    animation-name: slideDownAndFade;
  }
  .HoverCardContent[data-side='right'] {
    animation-name: slideLeftAndFade;
  }
  .HoverCardContent[data-side='bottom'] {
    animation-name: slideUpAndFade;
  }
  .HoverCardContent[data-side='left'] {
    animation-name: slideRightAndFade;
  }

  .HoverCardArrow {
    fill: white;
  }

  .ImageTrigger {
    cursor: pointer;
    border-radius: 100%;
    display: inline-block;
  }
  .ImageTrigger:focus {
    box-shadow: 0 0 0 2px white;
  }

  .Image {
    display: block;
    border-radius: 100%;
  }
  .Image.normal {
    width: 45px;
    height: 45px;
  }
  .Image.large {
    width: 60px;
    height: 60px;
  }

  .Text {
    margin: 0;
    color: var(--mauve-12);
    font-size: 15px;
    line-height: 1.5;
  }
  .Text.faded {
    color: var(--mauve-10);
  }
  .Text.bold {
    font-weight: 500;
  }

  @keyframes slideUpAndFade {
    0% {
      opacity: 0;
      transform: translateY(2px);
    }
    100% {
      opacity: 1;
      transform: translateY(0);
    }
  }

  @keyframes slideRightAndFade {
    0% {
      opacity: 0;
      transform: translateX(-2px);
    }
    100% {
      opacity: 1;
      transform: translateX(0);
    }
  }

  @keyframes slideDownAndFade {
    0% {
      opacity: 0;
      transform: translateY(-2px);
    }
    100% {
      opacity: 1;
      transform: translateY(0);
    }
  }

  @keyframes slideLeftAndFade {
    0% {
      opacity: 0;
      transform: translateX(2px);
    }
    100% {
      opacity: 1;
      transform: translateX(0);
    }
  }
}

Features

Can be controlled or uncontrolled.
Customize side, alignment, offsets, collision handling.
Optionally render a pointing arrow.
Supports custom open and close delays.
Ignored by screen readers.

Installation

Install the component from your command line.

pnpm add akar

yarn add akar

npm install akar

bun add akar

Anatomy

Import all parts and piece them together.

<script setup>
import { HoverCardArrow, HoverCardContent, HoverCardPortal, HoverCardRoot, HoverCardTrigger } from 'akar';
</script>

<template>
  <HoverCardRoot>
    <HoverCardTrigger />
    <HoverCardPortal>
      <HoverCardContent>
        <HoverCardArrow />
      </HoverCardContent>
    </HoverCardPortal>
  </HoverCardRoot>
</template>

Prop	Default	Type
`closeDelay`	`300`	`number` The duration from when the mouse leaves the trigger or content until the hover card closes.
`defaultOpen`	`false`	`boolean` The open state of the hover card when it is initially rendered. Use when you do not need to control its open state.
`enableTouch`	`false`	`boolean` When `true`, tapping the trigger on touch devices toggles the hover card open/closed. By default touch interactions are ignored to match pointer hover semantics.
`open`		`boolean` The controlled open state of the hover card. Can be binded as `v-model:open`.
`openDelay`	`700`	`number` The duration from when the mouse enters the trigger until the hover card opens.

Event	Payload
`update:open`	`value: boolean` Event handler called when the open state of the hover card changes.

Slot (default)	Payload
`open`	`boolean` Current open state

Prop	Default	Type
`as`	`"a"`	`AsTag \| Component` The element or component this component should render as. Can be overwritten by `asChild`.
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
`reference`		`ReferenceElement` The reference (or anchor) element that is being referred to for positioning. If not provided will use the current component as anchor.

Data attribute	Value
`[data-state]`	`"open" \| "closed"`

Prop	Default	Type
`defer`		`boolean` Defer the resolving of a Teleport target until other parts of the application have mounted (requires Vue 3.5.0+) reference
`disabled`		`boolean` Disable teleport and render the component inline reference
`forceMount`		`boolean` Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
`to`		`string \| HTMLElement` Vue native teleport component prop `:to` reference

Prop	Default	Type
`align`	`"center"`	`"start" \| "center" \| "end"` The preferred alignment against the trigger. May change when collisions occur.
`alignFlip`	`true`	`boolean` Flip alignment when colliding with boundary. May only occur when `prioritizePosition` is true.
`alignOffset`	`0`	`number` An offset in pixels from the `start` or `end` alignment options.
`arrowPadding`	`0`	`number` The padding between the arrow and the edges of the content. If your content has border-radius, this will prevent it from overflowing the corners.
`as`	`"div"`	`AsTag \| Component` The element or component this component should render as. Can be overwritten by `asChild`.
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
`avoidCollisions`	`true`	`boolean` When `true`, overrides the side and align preferences to prevent collisions with boundary edges.
`collisionBoundary`	`[]`	`Element \| (Element \| null)[] \| null` The element used as the collision boundary. By default this is the viewport, though you can provide additional element(s) to be included in this check.
`collisionPadding`	`0`	`number \| Partial<Record<"top" \| "right" \| "bottom" \| "left", number>>` The distance in pixels from the boundary edges where collision detection should occur. Accepts a number (same for all sides), or a partial padding object, for example: .
`dir`		`"ltr" \| "rtl"` The reading direction of the popper content when applicable. If omitted, inherits globally from `ConfigProvider` or assumes LTR (left-to-right) reading mode.
`disableUpdateOnLayoutShift`	`false`	`boolean` Whether to disable the update position for the content when the layout shifted.
`forceMount`		`boolean` Used to force mounting when more control is needed. Useful when controlling animation with Vue animation libraries.
`hideShiftedArrow`	`true`	`boolean` When `true`, hides the arrow when it cannot be centered to the reference element.
`hideWhenDetached`	`false`	`boolean` Whether to hide the content when the trigger becomes fully occluded.
`memoDependencies`		`unknown[]` Reactive dependencies that should invalidate the memoized content subtree.
`positionStrategy`		`"fixed" \| "absolute"` The type of CSS position property to use.
`prioritizePosition`	`false`	`boolean` Force content to be position within the viewport. Might overlap the reference element, which may not be desired.
`reference`		`ReferenceElement` The custom element or virtual element that will be set as the reference to position the floating element. If provided, it will replace the default anchor element.
`side`	`"bottom"`	`"top" \| "right" \| "bottom" \| "left"` The preferred side of the trigger to render against when open. Will be reversed when collisions occur and avoidCollisions is enabled.
`sideFlip`	`true`	`boolean` Flip to the opposite side when colliding with boundary.
`sideOffset`	`0`	`number` The distance in pixels from the trigger.
`sticky`	`"partial"`	`"partial" \| "always"` The sticky behavior on the align axis. `partial` will keep the content in the boundary as long as the trigger is at least partially in the boundary whilst "always" will keep the content in the boundary regardless.
`updatePositionStrategy`	`'optimized'`	`"always" \| "optimized"` Strategy to update the position of the floating element on every animation frame.

Event	Payload
`escapeKeyDown`	`event: KeyboardEvent` Event handler called when the escape key is down. Can be prevented.
`focusOutside`	`event: FocusOutsideEvent` Event handler called when the focus moves outside of the `DismissableLayer`. Can be prevented.
`interactOutside`	`event: PointerDownOutsideEvent \| FocusOutsideEvent` Event handler called when an interaction happens outside the `DismissableLayer`. Specifically, when a `pointerdown` event happens outside or focus moves outside of it. Can be prevented.
`pointerDownOutside`	`event: PointerDownOutsideEvent` Event handler called when a `pointerdown` event happens outside of the `DismissableLayer`. Can be prevented.

Data attribute	Value
`[data-state]`	`"open" \| "closed"`
`[data-side]`	`"left" \| "right" \| "bottom" \| "top"`
`[data-align]`	`"start" \| "end" \| "center"`

CSS variable	Description
`--akar-hover-card-content-transform-origin`	The `transform-origin` computed from the content and arrow positions/offsets
`--akar-hover-card-content-available-width`	The remaining width between the trigger and the boundary edge
`--akar-hover-card-content-available-height`	The remaining height between the trigger and the boundary edge
`--akar-hover-card-trigger-width`	The width of the trigger
`--akar-hover-card-trigger-height`	The height of the trigger

Prop	Default	Type
`as`	`"svg"`	`AsTag \| Component` The element or component this component should render as. Can be overwritten by `asChild`.
`asChild`		`boolean` Change the default rendered element for the one passed as a child, merging their props and behavior. Read our Composition guide for more details.
`height`	`5`	`number` The height of the arrow in pixels.
`rounded`	`false`	`boolean` When `true`, render the rounded version of arrow. Do not work with `as`/`asChild`
`width`	`10`	`number` The width of the arrow in pixels.

Examples

Show instantly

Use the openDelay prop to control the time it takes for the hover card to open.

<script setup>
import {
  HoverCardArrow,
  HoverCardContent,
  HoverCardPortal,
  HoverCardRoot,
  HoverCardTrigger,
} from 'akar'
</script>

<template>
  <HoverCardRoot :open-delay="0">
    <HoverCardTrigger>…</HoverCardTrigger>
    <HoverCardContent>…</HoverCardContent>
  </HoverCardRoot>
</template>

Constrain the content size

You may want to constrain the width of the content so that it matches the trigger width. You may also want to constrain its height to not exceed the viewport.

We expose several CSS custom properties such as --akar-hover-card-trigger-width and --akar-hover-card-content-available-height to support this. Use them to constrain the content dimensions.

// index.vue
<script setup>
import { HoverCardArrow, HoverCardContent, HoverCardPortal, HoverCardRoot, HoverCardTrigger } from 'akar'
</script>

<template>
  <HoverCardRoot>
    <HoverCardTrigger>…</HoverCardTrigger>
    <HoverCardPortal>
      <HoverCardContent
        class="HoverCardContent"
        :side-offset="5"
      >
        …
      </HoverCardContent>
    </HoverCardPortal>
  </HoverCardRoot>
</template>

/* styles.css */
.HoverCardContent {
  width: var(--akar-hover-card-trigger-width);
  max-height: var(--akar-hover-card-content-available-height);
}

We expose a CSS custom property --akar-hover-card-content-transform-origin. Use it to animate the content from its computed origin based on side, sideOffset, align, alignOffset and any collisions.

<script setup>
import { HoverCardArrow, HoverCardContent, HoverCardPortal, HoverCardRoot, HoverCardTrigger } from 'akar'
</script>

<template>
  <HoverCardRoot>
    <HoverCardTrigger>…</HoverCardTrigger>
    <HoverCardContent class="HoverCardContent">
      …
    </HoverCardContent>
  </HoverCardRoot>
</template>

/* styles.css */
.HoverCardContent {
  transform-origin: var(--akar-hover-card-content-transform-origin);
  animation: scaleIn 0.5s ease-out;
}

@keyframes scaleIn {
  from {
    opacity: 0;
    transform: scale(0);
  }
  to {
    opacity: 1;
    transform: scale(1);
  }
}

Collision-aware animations

We expose data-side and data-align attributes. Their values will change at runtime to reflect collisions. Use them to create collision and direction-aware animations.

<script setup>
import { HoverCardArrow, HoverCardContent, HoverCardPortal, HoverCardRoot, HoverCardTrigger } from 'akar'
</script>

<template>
  <HoverCardRoot>
    <HoverCardTrigger>…</HoverCardTrigger>
    <HoverCardContent class="HoverCardContent">
      …
    </HoverCardContent>
  </HoverCardRoot>
</template>

/* styles.css */
.HoverCardContent {
  animation-duration: 0.6s;
  animation-timing-function: cubic-bezier(0.16, 1, 0.3, 1);
}
.HoverCardContent[data-side="top"] {
  animation-name: slideUp;
}
.HoverCardContent[data-side="bottom"] {
  animation-name: slideDown;
}

@keyframes slideUp {
  from {
    opacity: 0;
    transform: translateY(10px);
  }
  to {
    opacity: 1;
    transform: translateY(0);
  }
}

@keyframes slideDown {
  from {
    opacity: 0;
    transform: translateY(-10px);
  }
  to {
    opacity: 1;
    transform: translateY(0);
  }
}

Accessibility

The hover card is intended for sighted users only, the content will be inaccessible to keyboard users.

Keyboard Interactions

Key	Description
`Tab`	Opens/closes the hover card.
`Enter`	Opens the hover card link

Form

Extends the native form element with server error display and submit-time validation gating.

Label

Renders an accessible label associated with controls.

Hover Card

HoverCard

Features

Installation

Anatomy

API Reference

Root

Trigger

Portal

Content

Arrow