Docs
Preview Card

Preview Card

For sighted users to preview content available behind a link.

The principles of good typography remain into the digital age.

Installation

Copy and paste the following code into your project.

"use client"
 
import * as React from "react"
import { PreviewCard as PreviewCardPrimitive } from "@base-ui-components/react/preview-card"
 
import { cn } from "@/lib/utils"
 
const PreviewCard = PreviewCardPrimitive.Root
 
const PreviewCardTrigger = PreviewCardPrimitive.Trigger
 
const PreviewCardPortal = PreviewCardPrimitive.Portal
 
const PreviewCardBackdrop = PreviewCardPrimitive.Backdrop
 
const PreviewCardPositioner = React.forwardRef<
  React.ElementRef<typeof PreviewCardPrimitive.Positioner>,
  React.ComponentPropsWithoutRef<typeof PreviewCardPrimitive.Positioner>
>(({ className, sideOffset = 8, ...props }, ref) => (
  <PreviewCardPrimitive.Positioner
    ref={ref}
    sideOffset={sideOffset}
    className={cn("outline-0", className)}
    {...props}
  />
))
PreviewCardPositioner.displayName = PreviewCardPrimitive.Positioner.displayName
 
const PreviewCardPopup = React.forwardRef<
  React.ElementRef<typeof PreviewCardPrimitive.Popup>,
  React.ComponentPropsWithoutRef<typeof PreviewCardPrimitive.Popup>
>(({ className, ...props }, ref) => (
  <PreviewCardPrimitive.Popup
    ref={ref}
    className={cn(
      "w-72 max-w-[calc(100vw-3rem)] origin-[var(--transform-origin)] rounded-lg border bg-popover p-4 text-popover-foreground shadow-md outline-none transition data-[ending-style]:scale-95 data-[starting-style]:scale-95 data-[ending-style]:opacity-0 data-[starting-style]:opacity-0",
      className,
    )}
    {...props}
  />
))
PreviewCardPopup.displayName = PreviewCardPrimitive.Popup.displayName
 
const PreviewCardArrow = React.forwardRef<
  React.ElementRef<typeof PreviewCardPrimitive.Arrow>,
  React.ComponentPropsWithoutRef<typeof PreviewCardPrimitive.Arrow>
>(({ className, ...props }, ref) => (
  <PreviewCardPrimitive.Arrow
    ref={ref}
    className={cn(
      "data-[side=bottom]:top-[-8px] data-[side=left]:right-[-13px] data-[side=right]:left-[-13px] data-[side=top]:bottom-[-8px] data-[side=left]:rotate-90 data-[side=right]:-rotate-90 data-[side=top]:rotate-180",
      className,
    )}
    {...props}
  >
    <svg width="20" height="10" viewBox="0 0 20 10" fill="none">
      <path
        d="M9.66437 2.60207L4.80758 6.97318C4.07308 7.63423 3.11989 8 2.13172 8H0V10H20V8H18.5349C17.5468 8 16.5936 7.63423 15.8591 6.97318L11.0023 2.60207C10.622 2.2598 10.0447 2.25979 9.66437 2.60207Z"
        className="fill-popover"
      />
      <path
        d="M8.99542 1.85876C9.75604 1.17425 10.9106 1.17422 11.6713 1.85878L16.5281 6.22989C17.0789 6.72568 17.7938 7.00001 18.5349 7.00001L15.89 7L11.0023 2.60207C10.622 2.2598 10.0447 2.2598 9.66436 2.60207L4.77734 7L2.13171 7.00001C2.87284 7.00001 3.58774 6.72568 4.13861 6.22989L8.99542 1.85876Z"
        className="fill-border"
      />
    </svg>
  </PreviewCardPrimitive.Arrow>
))
PreviewCardArrow.displayName = PreviewCardPrimitive.Arrow.displayName
 
export {
  PreviewCard,
  PreviewCardTrigger,
  PreviewCardPopup,
  PreviewCardPortal,
  PreviewCardBackdrop,
  PreviewCardPositioner,
  PreviewCardArrow,
}

Update the import paths to match your project setup.

Usage

import {
  PreviewCard,
  PreviewCardArrow,
  PreviewCardPopup,
  PreviewCardPortal,
  PreviewCardPositioner,
  PreviewCardTrigger,
} from "@/components/ui/preview-card"
<PreviewCard>
  <PreviewCardTrigger>Hover</PreviewCardTrigger>
  <PreviewCardPortal>
    <PreviewCardPositioner>
      <PreviewCardPopup>
        <PreviewCardArrow />
        Preview Card Content
      </PreviewCardPopup>
    </PreviewCardPositioner>
  </PreviewCardPortal>
</PreviewCard>