---
title: Preview Card
description: A popup that appears when a link is hovered, showing a preview for sighted users.

links:
  doc: https://base-ui.com/react/components/preview-card#api-reference
---

## Preview

<ComponentPreview name="p-preview-card-1" />

## Installation

<CodeTabs>

<TabsList>
  <TabsTab value="cli">CLI</TabsTab>
  <TabsTab value="manual">Manual</TabsTab>
</TabsList>

<TabsPanel value="cli">

```bash
npx @olyx/cli@latest add preview-card
```

</TabsPanel>

<TabsPanel value="manual">

<Steps>

<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="preview-card" title="components/ui/preview-card.tsx" />

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

</Steps>

</TabsPanel>

</CodeTabs>

## Usage

```tsx
import {
  PreviewCard,
  PreviewCardContent,
  PreviewCardTrigger,
} from "@/components/ui/preview-card"
```

```tsx
<PreviewCard>
  <PreviewCardTrigger>Hover me</PreviewCardTrigger>
  <PreviewCardContent>Preview Card Content</PreviewCardContent>
</PreviewCard>
```

## API Reference

#### PreviewCard

Root component. Alias for `PreviewCard.Root` from Base UI.

#### PreviewCardTrigger

Trigger element that shows the preview card on hover. Alias for `PreviewCard.Trigger` from Base UI.

#### PreviewCardContent

Popup container that displays the preview content. Wraps `PreviewCard.Portal`, `PreviewCard.Positioner`, and `PreviewCard.Popup`.

| Prop          | Type                                           | Default    |
| ------------- | ---------------------------------------------- | ---------- |
| `variant`     | `"dark" \| "light"`                            | `"dark"`   |
| `side`        | `"top" \| "bottom" \| "left" \| "right"`       | -          |
| `align`       | `"start" \| "center" \| "end"`                 | -          |
| `sideOffset`  | `number`                                       | `8`          |
| `alignOffset` | `number`                                       | -          |

## Examples

### Light Variant

<ComponentPreview name="p-preview-card-2" />