snapshot of https://github.com/shadcn-ui/ui.git (main, 2026-09-15; blobs > 131072B omitted)
This commit is contained in:
146
apps/v4/content/docs/components/base/tooltip.mdx
Normal file
146
apps/v4/content/docs/components/base/tooltip.mdx
Normal file
@@ -0,0 +1,146 @@
|
||||
---
|
||||
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: base
|
||||
component: true
|
||||
links:
|
||||
doc: https://base-ui.com/react/components/tooltip
|
||||
api: https://base-ui.com/react/components/tooltip#api-reference
|
||||
---
|
||||
|
||||
<ComponentPreview styleName="base-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 @base-ui/react
|
||||
```
|
||||
|
||||
<Step>Copy and paste the following code into your project.</Step>
|
||||
|
||||
<ComponentSource
|
||||
name="tooltip"
|
||||
title="components/ui/tooltip.tsx"
|
||||
styleName="base-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="base-nova" name="tooltip-sides" />
|
||||
|
||||
## With Keyboard Shortcut
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="tooltip-keyboard" />
|
||||
|
||||
## Disabled Button
|
||||
|
||||
Show a tooltip on a disabled button by wrapping it with a span.
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="tooltip-disabled" />
|
||||
|
||||
## RTL
|
||||
|
||||
To enable RTL support in shadcn/ui, see the [RTL configuration guide](/docs/rtl).
|
||||
|
||||
<ComponentPreview styleName="base-nova" name="tooltip-rtl" direction="rtl" />
|
||||
|
||||
## API Reference
|
||||
|
||||
See the [Base UI Tooltip](https://base-ui.com/react/components/tooltip#api-reference) documentation.
|
||||
Reference in New Issue
Block a user