TooltipDemo
import { Button } from '@/components/ui/button'
import { Tooltip, TooltipContent, TooltipTrigger } from '@/components/ui/tooltip'
export function TooltipDemo() {
return (
<div className='flex flex-wrap items-center gap-4'>
<Tooltip>
<TooltipTrigger asChild>
<Button size={'sm'} variant='outline'>
Hover Me
</Button>
</TooltipTrigger>
<TooltipContent>
<p>Add to library</p>
</TooltipContent>
</Tooltip>
</div>
)
}
Installation
- Install the following dependencies
pnpm add @radix-ui/react-tooltip- Copy and paste the following code into your project
src/components/ui/tooltip.tsx
'use client'
import * as React from 'react'
import * as TooltipPrimitive from '@radix-ui/react-tooltip'
import { cn } from '@/lib/utils'
function TooltipProvider({ delayDuration = 0, ...props }: React.ComponentProps<typeof TooltipPrimitive.Provider>) {
return <TooltipPrimitive.Provider data-slot='tooltip-provider' delayDuration={delayDuration} {...props} />
}
function Tooltip({ ...props }: React.ComponentProps<typeof TooltipPrimitive.Root>) {
return (
<TooltipProvider>
<TooltipPrimitive.Root data-slot='tooltip' {...props} />
</TooltipProvider>
)
}
function TooltipTrigger({ ...props }: React.ComponentProps<typeof TooltipPrimitive.Trigger>) {
return <TooltipPrimitive.Trigger data-slot='tooltip-trigger' {...props} />
}
function TooltipContent({
className,
sideOffset = 4,
children,
...props
}: React.ComponentProps<typeof TooltipPrimitive.Content>) {
return (
<TooltipPrimitive.Portal>
<TooltipPrimitive.Content
data-slot='tooltip-content'
sideOffset={sideOffset}
className={cn(
'z-50 w-fit origin-(--radix-tooltip-content-transform-origin) animate-in rounded-sm bg-inverse-surface px-2 py-1 text-xs text-balance text-inverse-on-surface fade-in-0 zoom-in-95 data-[side=bottom]:slide-in-from-top-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 data-[state=closed]:animate-out data-[state=closed]:fade-out-0 data-[state=closed]:zoom-out-95',
className,
)}
{...props}
>
{children}
</TooltipPrimitive.Content>
</TooltipPrimitive.Portal>
)
}
export { Tooltip, TooltipTrigger, TooltipContent, TooltipProvider }
Usage
import {
Tooltip,
TooltipContent,
TooltipProvider,
TooltipTrigger,
} from "@/components/ui/tooltip"<TooltipProvider>
<Tooltip>
<TooltipTrigger>Hover</TooltipTrigger>
<TooltipContent>
<p>Add to library</p>
</TooltipContent>
</Tooltip>
</TooltipProvider>API Reference
TooltipProvider
| Prop | type | default |
|---|---|---|
| delayDuration | number | 700 |
| skipDelayDuration | number | 300 |
| disableHoverableContent | boolean | false |
Tooltip
| Prop | type | default |
|---|---|---|
| open | boolean | |
| defaultOpen | boolean | |
| onOpenChange | function | |
| delayDuration | number | 700 |
| disableHoverableContent | boolean | false |
TooltipTrigger
| Prop | type | default |
|---|---|---|
| asChild | boolean | false |
TooltipContent
| Prop | type | default |
|---|---|---|
| aria-label | string | |
| onEscapeKeyDown | function | |
| onPointerDownOutside | function | |
| forceMount | boolean | |
| side | top | right | bottom | left | top |
| sideOffset | number | 4 |
| align | start | center | end | center |
| alignOffset | number | 0 |
| avoidCollisions | boolean | true |
| collisionBoundary | element | element[] | |
| collisionPadding | number | padding | 0 |
| arrowPadding | number | 0 |
| sticky | partial | always | partial |
| hideWhenDetached | boolean | false |