# Tooltip

Contextual tooltip on focus or hover



<ComponentPreview base="ink" name="tooltip-demo" />

Installation [#installation]

<CodeTabs>
  <TabsList>
    <TabsTrigger value="cli">
      Command
    </TabsTrigger>

    <TabsTrigger value="manual">
      Manual
    </TabsTrigger>
  </TabsList>

  <TabsContent value="cli">
    ```bash
    npx shadcn@latest add @termcn/tooltip
    ```
  </TabsContent>

  <TabsContent value="manual">
    <Steps>
      <Step>
        Copy and paste the following code into your project.
      </Step>

      <ComponentSource base="ink" name="tooltip" title="components/ui/tooltip.tsx" />

      <Step>
        Update the import paths to match your project setup.
      </Step>
    </Steps>
  </TabsContent>
</CodeTabs>

Usage [#usage]

```tsx
import { Tooltip } from "@/components/ui/tooltip";
```

```tsx
<Tooltip content="Save your current progress" position="top" isVisible={true}>
  <Text bold>[S] Save</Text>
</Tooltip>
```

API Reference [#api-reference]

Tooltip [#tooltip]

| Prop          | Type                                                                                         | Default    |
| ------------- | -------------------------------------------------------------------------------------------- | ---------- |
| `children`    | `ReactNode`                                                                                  | `required` |
| `content`     | `string`                                                                                     | `required` |
| `position`    | `"top" \| "bottom" \| "left" \| "right"`                                                     | `"top"`    |
| `isVisible`   | `boolean`                                                                                    | `false`    |
| `borderStyle` | `"single" \| "double" \| "round" \| "bold" \| "singleDouble" \| "doubleSingle" \| "classic"` | `"single"` |
| `borderColor` | `string`                                                                                     | -          |
| `paddingX`    | `number`                                                                                     | `1`        |
| `paddingY`    | `number`                                                                                     | `0`        |
| `gap`         | `number`                                                                                     | `1`        |
| `arrowDown`   | `string`                                                                                     | `"↓"`      |
| `arrowUp`     | `string`                                                                                     | `"↑"`      |