For sighted users to preview content available behind a link.
Installation
Install the packages
Add the shadcn/ui component
Animate it
The CLI finds your shadcn/ui components through components.json, swaps their primitive imports for Animate UI's and removes the CSS animation classes Motion replaces.
Usage
Import the primitive from Animate UI instead of Radix UI. Everything else stays the same.
import { HoverCard } from '@animate-ui/react/primitives/radix-ui';
export function ProfileLink() {
return (
<HoverCard.Root openDelay={500}>
<HoverCard.Trigger href="https://github.com/imskyleen/animate-ui">
@animate-ui
</HoverCard.Trigger>
<HoverCard.Portal>
<HoverCard.Content sideOffset={4}>
Animated drop-in primitives for Radix UI, Base UI and React Aria.
<HoverCard.Arrow />
</HoverCard.Content>
</HoverCard.Portal>
</HoverCard.Root>
);
}Coming from the @radix-ui/react-hover-card package? Use the subpath: import * as HoverCardPrimitive from '@animate-ui/react/primitives/radix-ui/hover-card'.
Animation
The motion of Animate UI v1's Hover Card, value for value:
- Content grows from 0.8 and fades in, from the trigger (
--radix-hover-card-content-transform-origin), on a spring (stiffness 400, damping 29) that overshoots a little before it settles. - Once Radix's
closeDelayis over, it closes the same way: it shrinks back to 0.8 on the same spring while it fades out, then unmounts. - Radix only opens it for mouse-like pointers: a tap on a touch screen follows the link, nothing sticks.
- With
forceMount(on the Content or the Portal), the closed content stays in the DOM: it plays its exit, then is hidden andinert. - Reopening while it closes picks up from where it is, on the same spring.
- Open from the start (
defaultOpen), it plays the same entrance on page load, like v1. - With
followCursoron the Root, the content leans towards the pointer while it moves over the trigger, by half its offset from the trigger's center, on a spring (stiffness 200, damping 17): on both axes, or only'x'or'y', as in v1. Under reduced motion it follows without the spring. - Under reduced motion, it only fades (no scale).
API Reference
Every part takes exactly the props of Radix UI's Hover Card. Animate UI adds the animation props below.
Root
Radix UI props, plus:
| Prop | Type | Default |
|---|---|---|
followCursor? | boolean | 'x' | 'y' | false |
followCursorSpringOptions? | SpringOptions | { stiffness: 200, damping: 17 } |
Trigger, Portal, Arrow
Radix UI props only. They are not animated.
Content
Radix UI props, plus:
| Prop | Type | Default |
|---|---|---|
transition? | Transition | { type: 'spring', stiffness: 400, damping: 29 } |
exitTransition? | Transition | transition |