mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-06-29 15:44:22 +00:00
47c47eaed2
* feat: add base and radix docs * feat: transform code for display * fix * fix * fix * fix * fix * chore: remove claude files * fix * fix * fix * chore: run format:write * fix * feat: add more examples * fix * feat: add aspect-ratio * feat: add avatar * feat: add badge * feat: add breadcrumb * fix * feat: add button * fix * fix * fix * feat: add calendar and card * feat: add carousel * fix: chart * feat: add checkbox * feat: add collapsible * feat: add combobox * feat: add command * feat: add context menu * feat: add data-table dialog and drawer * feat: dropdown-menu * feat: add date-picker * feat: add empty * feat: add field and hover-card * fix: input * feat: add input * feat: add input-group * feat: add input-otp * feat: add item * feat: add kbd and label * feat: add menubar * feat: add native-select * feat: add more components * feat: more components * feat: more components * feat: add skeleton, slider and sonner * feat: add spinner and switch * feat: add more components * fix: tabs * fix: tabs * feat: add docs for sidebar * fix * fix * fi * docs: update * fix: create page * fix * fix * chore: add changelog * fix
126 lines
2.2 KiB
Plaintext
126 lines
2.2 KiB
Plaintext
---
|
||
title: Hover Card
|
||
description: For sighted users to preview content available behind a link.
|
||
base: base
|
||
component: true
|
||
links:
|
||
doc: https://base-ui.com/react/components/hover-card
|
||
api: https://base-ui.com/react/components/hover-card#api-reference
|
||
---
|
||
|
||
<ComponentPreview
|
||
styleName="base-nova"
|
||
name="hover-card-demo"
|
||
previewClassName="h-80"
|
||
/>
|
||
|
||
## Installation
|
||
|
||
<CodeTabs>
|
||
|
||
<TabsList>
|
||
<TabsTrigger value="cli">Command</TabsTrigger>
|
||
<TabsTrigger value="manual">Manual</TabsTrigger>
|
||
</TabsList>
|
||
<TabsContent value="cli">
|
||
|
||
```bash
|
||
npx shadcn@latest add hover-card
|
||
```
|
||
|
||
</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="hover-card"
|
||
title="components/ui/hover-card.tsx"
|
||
styleName="base-nova"
|
||
/>
|
||
|
||
<Step>Update the import paths to match your project setup.</Step>
|
||
|
||
</Steps>
|
||
|
||
</TabsContent>
|
||
|
||
</CodeTabs>
|
||
|
||
## Usage
|
||
|
||
```tsx showLineNumbers
|
||
import {
|
||
HoverCard,
|
||
HoverCardContent,
|
||
HoverCardTrigger,
|
||
} from "@/components/ui/hover-card"
|
||
```
|
||
|
||
```tsx showLineNumbers
|
||
<HoverCard>
|
||
<HoverCardTrigger>Hover</HoverCardTrigger>
|
||
<HoverCardContent>
|
||
The React Framework – created and maintained by @vercel.
|
||
</HoverCardContent>
|
||
</HoverCard>
|
||
```
|
||
|
||
## Trigger Delays
|
||
|
||
Use `delay` and `closeDelay` on the trigger to control when the card opens and
|
||
closes.
|
||
|
||
```tsx showLineNumbers
|
||
<HoverCard>
|
||
<HoverCardTrigger delay={100} closeDelay={200}>
|
||
Hover
|
||
</HoverCardTrigger>
|
||
<HoverCardContent>Content</HoverCardContent>
|
||
</HoverCard>
|
||
```
|
||
|
||
## Positioning
|
||
|
||
Use the `side` and `align` props on `HoverCardContent` to control placement.
|
||
|
||
```tsx showLineNumbers
|
||
<HoverCard>
|
||
<HoverCardTrigger>Hover</HoverCardTrigger>
|
||
<HoverCardContent side="top" align="start">
|
||
Content
|
||
</HoverCardContent>
|
||
</HoverCard>
|
||
```
|
||
|
||
## Examples
|
||
|
||
### Basic
|
||
|
||
<ComponentPreview
|
||
styleName="base-nova"
|
||
name="hover-card-demo"
|
||
previewClassName="h-80"
|
||
/>
|
||
|
||
### Sides
|
||
|
||
<ComponentPreview
|
||
styleName="base-nova"
|
||
name="hover-card-sides"
|
||
previewClassName="h-[22rem]"
|
||
/>
|
||
|
||
## API Reference
|
||
|
||
See the [Base UI](https://base-ui.com/react/components/hover-card#api-reference) documentation for more information.
|