147 lines
2.9 KiB
Plaintext
147 lines
2.9 KiB
Plaintext
---
|
|
title: Tooltip
|
|
description: A popup that displays information related to an element when the element receives keyboard focus or the mouse hovers over it.
|
|
base: radix
|
|
component: true
|
|
links:
|
|
doc: https://www.radix-ui.com/docs/primitives/components/tooltip
|
|
api: https://www.radix-ui.com/docs/primitives/components/tooltip#api-reference
|
|
---
|
|
|
|
<ComponentPreview styleName="radix-nova" name="tooltip-demo" />
|
|
|
|
## Installation
|
|
|
|
<CodeTabs>
|
|
|
|
<TabsList>
|
|
<TabsTrigger value="cli">Command</TabsTrigger>
|
|
<TabsTrigger value="manual">Manual</TabsTrigger>
|
|
</TabsList>
|
|
<TabsContent value="cli">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Run the following command:</Step>
|
|
|
|
```bash
|
|
npx shadcn@latest add tooltip
|
|
```
|
|
|
|
<Step>Add the `TooltipProvider` to the root of your app.</Step>
|
|
|
|
```tsx title="app/layout.tsx" showLineNumbers {1,7}
|
|
import { TooltipProvider } from "@/components/ui/tooltip"
|
|
|
|
export default function RootLayout({ children }) {
|
|
return (
|
|
<html lang="en">
|
|
<body>
|
|
<TooltipProvider>{children}</TooltipProvider>
|
|
</body>
|
|
</html>
|
|
)
|
|
}
|
|
```
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
<TabsContent value="manual">
|
|
|
|
<Steps className="mb-0 pt-2">
|
|
|
|
<Step>Install the following dependencies:</Step>
|
|
|
|
```bash
|
|
npm install radix-ui
|
|
```
|
|
|
|
<Step>Copy and paste the following code into your project.</Step>
|
|
|
|
<ComponentSource
|
|
name="tooltip"
|
|
title="components/ui/tooltip.tsx"
|
|
styleName="radix-nova"
|
|
/>
|
|
|
|
<Step>Update the import paths to match your project setup.</Step>
|
|
|
|
<Step>Add the `TooltipProvider` to the root of your app.</Step>
|
|
|
|
```tsx title="app/layout.tsx" showLineNumbers {1,7}
|
|
import { TooltipProvider } from "@/components/ui/tooltip"
|
|
|
|
export default function RootLayout({ children }) {
|
|
return (
|
|
<html lang="en">
|
|
<body>
|
|
<TooltipProvider>{children}</TooltipProvider>
|
|
</body>
|
|
</html>
|
|
)
|
|
}
|
|
```
|
|
|
|
</Steps>
|
|
|
|
</TabsContent>
|
|
|
|
</CodeTabs>
|
|
|
|
## Usage
|
|
|
|
```tsx showLineNumbers
|
|
import {
|
|
Tooltip,
|
|
TooltipContent,
|
|
TooltipTrigger,
|
|
} from "@/components/ui/tooltip"
|
|
```
|
|
|
|
```tsx showLineNumbers
|
|
<Tooltip>
|
|
<TooltipTrigger>Hover</TooltipTrigger>
|
|
<TooltipContent>
|
|
<p>Add to library</p>
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
```
|
|
|
|
## Composition
|
|
|
|
Use the following composition to build a `Tooltip`:
|
|
|
|
```text
|
|
Tooltip
|
|
├── TooltipTrigger
|
|
└── TooltipContent
|
|
```
|
|
|
|
## Side
|
|
|
|
Use the `side` prop to change the position of the tooltip.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="tooltip-sides" />
|
|
|
|
## With Keyboard Shortcut
|
|
|
|
<ComponentPreview styleName="radix-nova" name="tooltip-keyboard" />
|
|
|
|
## Disabled Button
|
|
|
|
Show a tooltip on a disabled button by wrapping it with a span.
|
|
|
|
<ComponentPreview styleName="radix-nova" name="tooltip-disabled" />
|
|
|
|
## RTL
|
|
|
|
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
|
|
|
<ComponentPreview styleName="radix-nova" name="tooltip-rtl" direction="rtl" />
|
|
|
|
## API Reference
|
|
|
|
See the [Radix Tooltip](https://www.radix-ui.com/docs/primitives/components/tooltip#api-reference) documentation.
|