Preview Card

A popup that appears when a link is hovered, showing a preview for sighted users.

The principles of good typography remain into the digital age.

import * as React from 'react';
import { PreviewCard } from '@base-ui-components/react/preview-card';
import styles from './index.module.css';

export default function ExamplePreviewCard() {
  return (
    <PreviewCard.Root>
      <p className={styles.Paragraph}>
        The principles of good{' '}
        <PreviewCard.Trigger
          className={styles.Link}
          href="https://en.wikipedia.org/wiki/Typography"
        >
          typography
        </PreviewCard.Trigger>{' '}
        remain into the digital age.
      </p>

      <PreviewCard.Portal>
        <PreviewCard.Positioner sideOffset={8}>
          <PreviewCard.Popup className={styles.Popup}>
            <PreviewCard.Arrow className={styles.Arrow}>
              <ArrowSvg />
            </PreviewCard.Arrow>
            <img
              width="448"
              height="300"
              className={styles.Image}
              src="https://images.unsplash.com/photo-1619615391095-dfa29e1672ef?q=80&w=448&h=300"
              alt="Station Hofplein signage in Rotterdam, Netherlands"
            />
            <p className={styles.Summary}>
              <strong>Typography</strong> is the art and science of arranging type to
              make written language clear, visually appealing, and effective in
              communication.
            </p>
          </PreviewCard.Popup>
        </PreviewCard.Positioner>
      </PreviewCard.Portal>
    </PreviewCard.Root>
  );
}

function ArrowSvg(props: React.ComponentProps<'svg'>) {
  return (
    <svg width="20" height="10" viewBox="0 0 20 10" fill="none" {...props}>
      <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={styles.ArrowFill}
      />
      <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={styles.ArrowOuterStroke}
      />
      <path
        d="M10.3333 3.34539L5.47654 7.71648C4.55842 8.54279 3.36693 9 2.13172 9H0V8H2.13172C3.11989 8 4.07308 7.63423 4.80758 6.97318L9.66437 2.60207C10.0447 2.25979 10.622 2.2598 11.0023 2.60207L15.8591 6.97318C16.5936 7.63423 17.5468 8 18.5349 8H20V9H18.5349C17.2998 9 16.1083 8.54278 15.1901 7.71648L10.3333 3.34539Z"
        className={styles.ArrowInnerStroke}
      />
    </svg>
  );
}

Anatomy

Import the component and assemble its parts:

Anatomy

import { PreviewCard } from '@base-ui-components/react/previewCard';

<PreviewCard.Root>
  <PreviewCard.Trigger />
  <PreviewCard.Portal>
    <PreviewCard.Backdrop />
    <PreviewCard.Positioner>
      <PreviewCard.Popup>
        <PreviewCard.Arrow />
      </PreviewCard.Popup>
    </PreviewCard.Positioner>
  </PreviewCard.Portal>
</PreviewCard.Root>

API reference

Root

Groups all parts of the preview card. Doesn’t render its own HTML element.

defaultOpen

boolean

(default:

false

)

Name: defaultOpen
Description: Whether the preview card is initially open.

To render a controlled preview card, use the open prop instead.
Type: boolean
Default: false

open

boolean

Name: open
Description: Whether the preview card is currently open.
Type: boolean

onOpenChange

function

Name: onOpenChange
Description: Event handler called when the preview card is opened or closed.
Type: ((open: boolean, event: Event | undefined, reason: PreviewCard.Root.OpenChangeReason | undefined) => void)

actionsRef

RefObject<PreviewCard.Root.Actions>

Name: actionsRef
Description: A ref to imperative actions.

unmount: When specified, the preview card will not be unmounted when closed. Instead, the unmount function must be called to unmount the preview card manually. Useful when the preview card's animation is controlled by an external library.
Type: RefObject<PreviewCard.Root.Actions>

onOpenChangeComplete

function

Name: onOpenChangeComplete
Description: Event handler called after any animations complete when the preview card is opened or closed.
Type: ((open: boolean) => void)

delay

number

(default:

600

)

Name: delay
Description: How long to wait before the preview card opens. Specified in milliseconds.
Type: number
Default: 600

closeDelay

number

(default:

300

)

Name: closeDelay
Description: How long to wait before closing the preview card. Specified in milliseconds.
Type: number
Default: 300

children

ReactNode

Name: children
Type: ReactNode

Trigger

A link that opens the preview card. Renders an <a> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: PreviewCard.Trigger.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | ((props: HTMLProps, state: PreviewCard.Trigger.State) => ReactElement)

data-popup-open

Present when the corresponding preview card is open.

Attribute	Description
`data-popup-open`	Present when the corresponding preview card is open.

Portal

A portal element that moves the popup to a different part of the DOM. By default, the portal element is appended to <body>.

container

Union

Name: container
Description: A parent element to render the portal element into.
Type: | HTMLElement | ShadowRoot | RefObject<HTMLElement | ShadowRoot | null> | null

children

ReactNode

Name: children
Type: ReactNode

keepMounted

boolean

(default:

false

)

Name: keepMounted
Description: Whether to keep the portal mounted in the DOM while the popup is hidden.
Type: boolean
Default: false

Backdrop

An overlay displayed beneath the popup. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: PreviewCard.Backdrop.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | ((props: HTMLProps, state: PreviewCard.Backdrop.State) => ReactElement)

data-open

Present when the preview card is open.

data-closed

Present when the preview card is closed.

data-starting-style

Present when the preview card is animating in.

data-ending-style

Present when the preview card is animating out.

Attribute	Description
`data-open`	Present when the preview card is open.
`data-closed`	Present when the preview card is closed.
`data-starting-style`	Present when the preview card is animating in.
`data-ending-style`	Present when the preview card is animating out.

Positioner

Positions the popup against the trigger. Renders a <div> element.

collisionAvoidance

CollisionAvoidance

Name: collisionAvoidance
Description: Determines how to handle collisions when positioning the popup.
Type: CollisionAvoidance

align

Union

(default:

'center'

)

Name: align
Description: How to align the popup relative to the specified side.
Type: 'center' | 'start' | 'end'
Default: 'center'

alignOffset

number | OffsetFunction

(default:

0

)

Name: alignOffset
Description: Additional offset along the alignment axis in pixels. Also accepts a function that returns the offset to read the dimensions of the anchor and positioner elements, along with its side and alignment.

data.anchor: the dimensions of the anchor element with properties width and height.

data.positioner: the dimensions of the positioner element with properties width and height.

data.side: which side of the anchor element the positioner is aligned against.

data.align: how the positioner is aligned relative to the specified side.
Type: number | OffsetFunction
Default: 0

side

Side

(default:

'bottom'

)

Name: side
Description: Which side of the anchor element to align the popup against. May automatically change to avoid collisions.
Type: Side
Default: 'bottom'

sideOffset

number | OffsetFunction

(default:

0

)

Name: sideOffset
Description: Distance between the anchor and the popup in pixels. Also accepts a function that returns the distance to read the dimensions of the anchor and positioner elements, along with its side and alignment.

data.anchor: the dimensions of the anchor element with properties width and height.

data.positioner: the dimensions of the positioner element with properties width and height.

data.side: which side of the anchor element the positioner is aligned against.

data.align: how the positioner is aligned relative to the specified side.
Type: number | OffsetFunction
Default: 0

arrowPadding

number

(default:

5

)

Name: arrowPadding
Description: Minimum distance to maintain between the arrow and the edges of the popup.

Use it to prevent the arrow element from hanging out of the rounded corners of a popup.
Type: number
Default: 5

anchor

Union

Name: anchor
Description: An element to position the popup against. By default, the popup will be positioned against the trigger.
Type: | Element | RefObject<Element | null> | VirtualElement | (() => Element | VirtualElement | null) | null

collisionBoundary

Boundary

(default:

'clipping-ancestors'

)

Name: collisionBoundary
Description: An element or a rectangle that delimits the area that the popup is confined to.
Type: Boundary
Default: 'clipping-ancestors'

collisionPadding

Padding

(default:

5

)

Name: collisionPadding
Description: Additional space to maintain from the edge of the collision boundary.
Type: Padding
Default: 5

sticky

boolean

(default:

false

)

Name: sticky
Description: Whether to maintain the popup in the viewport after the anchor element was scrolled out of view.
Type: boolean
Default: false

positionMethod

'fixed' | 'absolute'

(default:

'absolute'

)

Name: positionMethod
Description: Determines which CSS position property to use.
Type: 'fixed' | 'absolute'
Default: 'absolute'

trackAnchor

boolean

(default:

true

)

Name: trackAnchor
Description: Whether the popup tracks any layout shift of its positioning anchor.
Type: boolean
Default: true

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: PreviewCard.Positioner.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | ((props: HTMLProps, state: PreviewCard.Positioner.State) => ReactElement)

data-open

Present when the preview card is open.

data-closed

Present when the preview card is closed.

data-anchor-hidden

Present when the anchor is hidden.

data-align

Indicates how the popup is aligned relative to specified side.

data-side

Indicates which side the popup is positioned relative to the trigger.

Attribute	Description
`data-open`	Present when the preview card is open.
`data-closed`	Present when the preview card is closed.
`data-anchor-hidden`	Present when the anchor is hidden.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-side`	Indicates which side the popup is positioned relative to the trigger.

--anchor-height

The anchor's height.

--anchor-width

The anchor's width.

--available-height

The available height between the trigger and the edge of the viewport.

--available-width

The available width between the trigger and the edge of the viewport.

--transform-origin

The coordinates that this element is anchored to. Used for animations and transitions.

CSS Variable	Description
`--anchor-height`	The anchor's height.
`--anchor-width`	The anchor's width.
`--available-height`	The available height between the trigger and the edge of the viewport.
`--available-width`	The available width between the trigger and the edge of the viewport.
`--transform-origin`	The coordinates that this element is anchored to. Used for animations and transitions.

A container for the preview card contents. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: PreviewCard.Popup.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | ((props: HTMLProps, state: PreviewCard.Popup.State) => ReactElement)

data-open

Present when the preview card is open.

data-closed

Present when the preview card is closed.

data-align

Indicates how the popup is aligned relative to specified side.

data-side

Indicates which side the popup is positioned relative to the trigger.

data-starting-style

Present when the preview card is animating in.

data-ending-style

Present when the preview card is animating out.

Attribute	Description
`data-open`	Present when the preview card is open.
`data-closed`	Present when the preview card is closed.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-side`	Indicates which side the popup is positioned relative to the trigger.
`data-starting-style`	Present when the preview card is animating in.
`data-ending-style`	Present when the preview card is animating out.

Arrow

Displays an element positioned against the preview card anchor. Renders a <div> element.

className

string | function

Name: className
Description: CSS class applied to the element, or a function that returns a class based on the component’s state.
Type: | string | ((state: PreviewCard.Arrow.State) => string)

render

ReactElement | function

Name: render
Description: Allows you to replace the component’s HTML element with a different tag, or compose it with another component.

Accepts a ReactElement or a function that returns the element to render.
Type: | ReactElement | ((props: HTMLProps, state: PreviewCard.Arrow.State) => ReactElement)

data-open

Present when the preview card is open.

data-closed

Present when the preview card is closed.

data-uncentered

Present when the preview card arrow is uncentered.

data-anchor-hidden

Present when the anchor is hidden.

data-align

Indicates how the popup is aligned relative to specified side.

data-side

Indicates which side the popup is positioned relative to the trigger.

Attribute	Description
`data-open`	Present when the preview card is open.
`data-closed`	Present when the preview card is closed.
`data-uncentered`	Present when the preview card arrow is uncentered.
`data-anchor-hidden`	Present when the anchor is hidden.
`data-align`	Indicates how the popup is aligned relative to specified side.
`data-side`	Indicates which side the popup is positioned relative to the trigger.