Components

Hover Card

For sighted users to preview content available behind a link.

import React from 'react';
import * as HoverCard from '@radix-ui/react-hover-card';
import './styles.css';
const HoverCardDemo = () => (
<HoverCard.Root>
<HoverCard.Trigger asChild>
<a className="ImageTrigger" href="https://twitter.com/radix_ui" target="_blank" rel="noreferrer noopener" >
<img className="Image normal" src="https://pbs.twimg.com/profile_images/1337055608613253126/r_eiMp2H_400x400.png" alt="Radix UI" />
</a>
</HoverCard.Trigger>
<HoverCard.Portal>
<HoverCard.Content className="HoverCardContent" sideOffset={5}>
<div style={{ display: 'flex', flexDirection: 'column', gap: 7 }}>
<img className="Image large" src="https://pbs.twimg.com/profile_images/1337055608613253126/r_eiMp2H_400x400.png" alt="Radix UI" />
<div style={{ display: 'flex', flexDirection: 'column', gap: 15 }}>
<div>
<div className="Text bold">Radix</div>
<div className="Text faded">@radix_ui</div>
</div>
<div className="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 className="Text bold">0</div> <div className="Text faded">Following</div>
</div>
<div style={{ display: 'flex', gap: 5 }}>
<div className="Text bold">2,900</div> <div className="Text faded">Followers</div>
</div>
</div>
</div>
</div>
<HoverCard.Arrow className="HoverCardArrow" />
</HoverCard.Content>
</HoverCard.Portal>
</HoverCard.Root>
);
export default HoverCardDemo;

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.

npm install @radix-ui/react-hover-card

Anatomy

Import all parts and piece them together.

import * as HoverCard from '@radix-ui/react-hover-card';
export default () => (
<HoverCard.Root>
<HoverCard.Trigger />
<HoverCard.Portal>
<HoverCard.Content>
<HoverCard.Arrow />
</HoverCard.Content>
</HoverCard.Portal>
</HoverCard.Root>
);

API Reference

Root

Contains all the parts of a hover card.

PropTypeDefault
defaultOpen
boolean
No default value
open
boolean
No default value
onOpenChange
function
No default value
openDelay
number
700
closeDelay
number
300

Trigger

The link that opens the hover card when hovered.

PropTypeDefault
asChild
boolean
false
Data attributeValues
[data-state]"open" | "closed"

Portal

When used, portals the content part into the body.

PropTypeDefault
forceMount
boolean
No default value
container
HTMLElement
document.body

Content

The component that pops out when the hover card is open.

PropTypeDefault
asChild
boolean
false
forceMount
boolean
No default value
side
enum
"bottom"
sideOffset
number
0
align
enum
"center"
alignOffset
number
0
avoidCollisions
boolean
true
collisionBoundary
Boundary
[]
collisionPadding
number | Padding
0
arrowPadding
number
0
sticky
enum
"partial"
hideWhenDetached
boolean
false
Data attributeValues
[data-state]"open" | "closed"
[data-side]"left" | "right" | "bottom" | "top"
[data-align]"start" | "end" | "center"
CSS VariableDescription
--radix-hover-card-content-transform-originThe transform-origin computed from the content and arrow positions/offsets
--radix-hover-card-content-available-widthThe remaining width between the trigger and the boundary edge
--radix-hover-card-content-available-heightThe remaining height between the trigger and the boundary edge
--radix-hover-card-trigger-widthThe width of the trigger
--radix-hover-card-trigger-heightThe height of the trigger

Arrow

An optional arrow element to render alongside the hover card. This can be used to help visually link the trigger with the HoverCard.Content. Must be rendered inside HoverCard.Content.

PropTypeDefault
asChild
boolean
false
width
number
10
height
number
5

Examples

Show instantly

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

import * as HoverCard from '@radix-ui/react-hover-card';
export default () => (
<HoverCard.Root openDelay={0}>
<HoverCard.Trigger></HoverCard.Trigger>
<HoverCard.Content></HoverCard.Content>
</HoverCard.Root>
);

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 --radix-hover-card-trigger-width and --radix-hover-card-content-available-height to support this. Use them to constrain the content dimensions.

// index.jsx
import * as HoverCard from '@radix-ui/react-hover-card';
import './styles.css';
export default () => (
<HoverCard.Root>
<HoverCard.Trigger></HoverCard.Trigger>
<HoverCard.Portal>
<HoverCard.Content className="HoverCardContent" sideOffset={5}>
</HoverCard.Content>
</HoverCard.Portal>
</HoverCard.Root>
);
/* styles.css */
.HoverCardContent {
width: var(--radix-hover-card-trigger-width);
max-height: var(--radix-hover-card-content-available-height);
}

Origin-aware animations

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

// index.jsx
import * as HoverCard from '@radix-ui/react-hover-card';
import './styles.css';
export default () => (
<HoverCard.Root>
<HoverCard.Trigger></HoverCard.Trigger>
<HoverCard.Content className="HoverCardContent"></HoverCard.Content>
</HoverCard.Root>
);
/* styles.css */
.HoverCardContent {
transform-origin: var(--radix-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.

// index.jsx
import * as HoverCard from '@radix-ui/react-hover-card';
import './styles.css';
export default () => (
<HoverCard.Root>
<HoverCard.Trigger></HoverCard.Trigger>
<HoverCard.Content className="HoverCardContent"></HoverCard.Content>
</HoverCard.Root>
);
/* 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

KeyDescription
Tab
Opens/closes the hover card.
Enter
Opens the hover card link
PreviousForm
NextLabel