Back to Shadcn Ui

Tooltip

apps/v4/content/docs/components/base/tooltip.mdx

latest2.4 KB
Original Source
<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
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
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
import {
  Tooltip,
  TooltipContent,
  TooltipTrigger,
} from "@/components/ui/tooltip"
tsx
<Tooltip>
  <TooltipTrigger>Hover</TooltipTrigger>
  <TooltipContent>
    <p>Add to library</p>
  </TooltipContent>
</Tooltip>

Examples

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.

<ComponentPreview styleName="base-nova" name="tooltip-rtl" direction="rtl" />

API Reference

See the Base UI Tooltip documentation.