A popup that displays information related to an element when the element receives keyboard focus or the mouse hovers over it.
Installation
Install the packages
Add the shadcn-vue component
Animate it
The CLI finds your shadcn-vue components through components.json, swaps their primitive imports for Animate UI's and removes the CSS animation classes Motion replaces.
Usage
<script setup lang="ts">
import {
TooltipContent,
TooltipPortal,
TooltipProvider,
TooltipRoot,
TooltipTrigger,
} from '@animate-ui/vue/primitives/reka-ui';
</script>
<template>
<TooltipProvider>
<TooltipRoot>
<TooltipTrigger>Hover</TooltipTrigger>
<TooltipPortal>
<TooltipContent>Add to library</TooltipContent>
</TooltipPortal>
</TooltipRoot>
</TooltipProvider>
</template>Animation
The motion of Animate UI's React Tooltip, starting from 0.7, with a warm-up:
- Content grows from 0.7 and fades in, from the trigger (
--reka-tooltip-content-transform-origin), on a spring (stiffness 400, damping 29) that overshoots a little before it settles. - It closes the same way: it shrinks back to 0.7 on the same spring while it fades out, then unmounts.
- Tooltips warm up: once one is open, moving along a toolbar shows the next one at once, without its entrance, and hides the previous one at once. 300ms after the last one closed, the next one plays its entrance again. Animate UI tracks it across all of its tooltips, whatever their Provider.
- reka-ui only opens it on hover for mouse-like pointers, and on keyboard focus.
- With
force-mount(on the Content or the Portal), the closed content stays in the DOM: it plays its exit, then is hidden andinert. - Open from the start (
default-open), it plays the same entrance on page load. - With
follow-cursoron 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'. 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 reka-ui's Tooltip. Animate UI adds the animation props below.
TooltipRoot
reka-ui props, plus:
| Prop | Type | Default |
|---|---|---|
follow-cursor? | boolean | 'x' | 'y' | false |
follow-cursor-spring-options? | SpringOptions | { stiffness: 200, damping: 17 } |
TooltipProvider, TooltipTrigger, TooltipPortal, TooltipArrow
reka-ui props only. They are not animated.
TooltipContent
reka-ui props, plus:
| Prop | Type | Default |
|---|---|---|
transition? | Transition | { type: 'spring', stiffness: 400, damping: 29 } |
exit-transition? | Transition | transition |