# Hover Card

For sighted users to preview content available behind a link.

## Installation

```bash
npx shadcn@latest add https://reactdocs.canceydejean.dev/r/hover-card.json
```

[Registry JSON](https://reactdocs.canceydejean.dev/r/hover-card.json)

## Preview

```tsx
import { HoverCard, HoverCardContent, HoverCardTrigger } from "@/components/ui/hover-card/hover-card";

export function Preview() {
  return (
    <HoverCard>
      <HoverCardTrigger
        href="https://github.com/shadcn"
        className="text-sm font-medium underline-offset-4 hover:underline"
      >
        @shadcn
      </HoverCardTrigger>
      <HoverCardContent>
        <div className="flex flex-col gap-2">
          <p className="font-medium">@shadcn</p>
          <p className="text-sm text-muted-foreground">
            Building open-source UI that works out of the box.
          </p>
          <p className="text-xs text-muted-foreground">Joined December 2021</p>
        </div>
      </HoverCardContent>
    </HoverCard>
  );
}
```


## Source

### hover-card.tsx

```tsx
"use client";

import { PreviewCard as PreviewCardPrimitive } from "@base-ui/react/preview-card";

import { cn } from "cn";

function HoverCard({ ...props }: PreviewCardPrimitive.Root.Props) {
  return <PreviewCardPrimitive.Root data-slot="hover-card" {...props} />;
}

function HoverCardTrigger({ ...props }: PreviewCardPrimitive.Trigger.Props) {
  return (
    <PreviewCardPrimitive.Trigger data-slot="hover-card-trigger" {...props} />
  );
}

function HoverCardContent({
  className,
  side = "bottom",
  sideOffset = 4,
  align = "center",
  alignOffset = 4,
  ...props
}: PreviewCardPrimitive.Popup.Props &
  Pick<
    PreviewCardPrimitive.Positioner.Props,
    "align" | "alignOffset" | "side" | "sideOffset"
  >) {
  return (
    <PreviewCardPrimitive.Portal data-slot="hover-card-portal">
      <PreviewCardPrimitive.Positioner
        align={align}
        alignOffset={alignOffset}
        side={side}
        sideOffset={sideOffset}
        className="isolate z-50"
      >
        <PreviewCardPrimitive.Popup
          data-slot="hover-card-content"
          className={cn(
            "bg-popover text-popover-foreground ring-foreground/10 data-[side=bottom]:slide-in-from-top-2 data-[side=inline-end]:slide-in-from-left-2 data-[side=inline-start]:slide-in-from-right-2 data-[side=left]:slide-in-from-right-2 data-[side=right]:slide-in-from-left-2 data-[side=top]:slide-in-from-bottom-2 data-open:animate-in data-open:fade-in-0 data-open:zoom-in-95 data-closed:animate-out data-closed:fade-out-0 data-closed:zoom-out-95 z-50 w-64 origin-(--transform-origin) rounded-lg p-2.5 text-sm shadow-md ring-1 outline-hidden duration-100",
            className,
          )}
          {...props}
        />
      </PreviewCardPrimitive.Positioner>
    </PreviewCardPrimitive.Portal>
  );
}

export { HoverCard, HoverCardTrigger, HoverCardContent };
```



## Usage

Use a hover card to show rich preview content when the user hovers a trigger. Built on
[Base UI Preview Card](https://base-ui.com/react/components/preview-card).

```tsx
import {
  HoverCard,
  HoverCardContent,
  HoverCardTrigger,
} from "@/components/hover-card/hover-card";

export function Example() {
  return (
    <HoverCard>
      <HoverCardTrigger href="https://github.com/shadcn">
        @shadcn
      </HoverCardTrigger>
      <HoverCardContent>
        <div className="flex flex-col gap-2">
          <p className="font-medium">@shadcn</p>
          <p className="text-muted-foreground text-sm">
            The React library for building web applications.
          </p>
        </div>
      </HoverCardContent>
    </HoverCard>
  );
}
```

Position with `side`, `sideOffset`, `align`, and `alignOffset` on `HoverCardContent`.