--- title: Preview Card subtitle: A popup that appears when a link is hovered, showing a preview for sighted users. description: A high-quality, unstyled React preview card component that appears when a link is hovered, showing a preview for sighted users. --- # Preview Card ## Demo ### Tailwind This example shows how to implement the component using Tailwind CSS. ```tsx /* index.tsx */ import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; export default function ExamplePreviewCard() { return (

The principles of good{' '} typography {' '} remain in the digital age.

Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type to make written language clear, visually appealing, and effective in communication.

); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ### CSS Modules This example shows how to implement the component using CSS Modules. ```tsx /* index.tsx */ import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; import styles from './demos.module.css'; export default function ExamplePreviewCard() { return (

The principles of good{' '} typography {' '} remain in the digital age.

Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type to make written language clear, visually appealing, and effective in communication.

); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ```css /* demos.module.css */ .Positioner { height: var(--positioner-height); width: var(--positioner-width); max-width: var(--available-width); } .Popup { box-sizing: border-box; width: var(--popup-width, auto); height: var(--popup-height, auto); border-radius: 0.5rem; background-color: canvas; transform-origin: var(--transform-origin); transition: transform 150ms, opacity 150ms; &[data-starting-style], &[data-ending-style] { opacity: 0; transform: scale(0.9); } @media (prefers-color-scheme: light) { outline: 1px solid var(--color-gray-200); box-shadow: 0 10px 15px -3px var(--color-gray-200), 0 4px 6px -4px var(--color-gray-200); } @media (prefers-color-scheme: dark) { outline: 1px solid var(--color-gray-300); outline-offset: -1px; } } .Arrow { display: flex; &[data-side='top'] { bottom: -8px; rotate: 180deg; } &[data-side='bottom'] { top: -8px; rotate: 0deg; } &[data-side='left'] { right: -13px; rotate: 90deg; } &[data-side='right'] { left: -13px; rotate: -90deg; } } .ArrowFill { fill: canvas; } .ArrowOuterStroke { @media (prefers-color-scheme: light) { fill: var(--color-gray-200); } } .ArrowInnerStroke { @media (prefers-color-scheme: dark) { fill: var(--color-gray-300); } } .PopupContent { width: min-content; display: flex; flex-direction: column; gap: 0.5rem; padding: 0.5rem; box-sizing: border-box; } .Image { display: block; border-radius: 0.25rem; max-width: none; } .Summary { margin: 0; font-size: 0.875rem; line-height: 1.25rem; color: var(--color-gray-900); text-wrap: pretty; } .Container { display: flex; gap: 0.5rem; flex-wrap: wrap; justify-content: center; align-items: baseline; } .Paragraph { margin: 0; font-size: 1rem; line-height: 1.5rem; color: var(--color-gray-900); text-wrap: balance; } .Link { outline: 0; color: var(--color-blue); text-decoration-line: none; text-decoration-thickness: 1px; text-decoration-color: color-mix(in oklab, var(--color-blue), transparent 40%); text-underline-offset: 2px; @media (hover: hover) { &:hover { text-decoration-line: underline; } } &[data-popup-open] { text-decoration-line: underline; } &:focus-visible { border-radius: 0.125rem; outline: 2px solid var(--color-blue); text-decoration-line: none; } } .LinkGroup { display: flex; flex-wrap: wrap; gap: 0.25rem; align-items: baseline; } .Button { box-sizing: border-box; display: flex; align-items: center; justify-content: center; height: 2.5rem; padding: 0 0.875rem; margin: 0; outline: 0; border: 1px solid var(--color-gray-200); border-radius: 0.375rem; background-color: var(--color-gray-50); font-family: inherit; font-size: 1rem; font-weight: 500; line-height: 1.5rem; color: var(--color-gray-900); user-select: none; @media (hover: hover) { &:hover { background-color: var(--color-gray-100); } } &:active { background-color: var(--color-gray-100); } &:focus-visible { outline: 2px solid var(--color-blue); outline-offset: -1px; } } ``` ## Anatomy Import the component and assemble its parts: ```jsx title="Anatomy" import { PreviewCard } from '@base-ui/react/preview-card'; ; ``` ## Examples ### Detached triggers A preview card can be controlled by a trigger located either inside or outside the `` component. For simple, one-off interactions, place the `` inside ``, as shown in the example at the top of this page. However, if defining the preview card's content next to its trigger is not practical, you can use a detached trigger. This involves placing the `` outside of `` and linking them with a `handle` created by the `PreviewCard.createHandle()` function. ```jsx title="Detached triggers" {3,5} "handle={demoPreviewCard}" const demoPreviewCard = PreviewCard.createHandle(); Link ... ``` ## Demo ### Tailwind This example shows how to implement the component using Tailwind CSS. ```tsx /* index.tsx */ 'use client'; import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; const demoPreviewCard = PreviewCard.createHandle(); export default function PreviewCardDetachedTriggersSimpleDemo() { return (

The principles of good{' '} typography {' '} remain in the digital age.

Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type to make written language clear, visually appealing, and effective in communication.

); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ### CSS Modules This example shows how to implement the component using CSS Modules. ```tsx /* index.tsx */ 'use client'; import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; import styles from './demos.module.css'; const demoPreviewCard = PreviewCard.createHandle(); export default function PreviewCardDetachedTriggersSimpleDemo() { return (

The principles of good{' '} typography {' '} remain in the digital age.

Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type to make written language clear, visually appealing, and effective in communication.

); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ```css /* demos.module.css */ .Positioner { height: var(--positioner-height); width: var(--positioner-width); max-width: var(--available-width); } .Popup { box-sizing: border-box; width: var(--popup-width, auto); height: var(--popup-height, auto); border-radius: 0.5rem; background-color: canvas; transform-origin: var(--transform-origin); transition: transform 150ms, opacity 150ms; &[data-starting-style], &[data-ending-style] { opacity: 0; transform: scale(0.9); } @media (prefers-color-scheme: light) { outline: 1px solid var(--color-gray-200); box-shadow: 0 10px 15px -3px var(--color-gray-200), 0 4px 6px -4px var(--color-gray-200); } @media (prefers-color-scheme: dark) { outline: 1px solid var(--color-gray-300); outline-offset: -1px; } } .Arrow { display: flex; &[data-side='top'] { bottom: -8px; rotate: 180deg; } &[data-side='bottom'] { top: -8px; rotate: 0deg; } &[data-side='left'] { right: -13px; rotate: 90deg; } &[data-side='right'] { left: -13px; rotate: -90deg; } } .ArrowFill { fill: canvas; } .ArrowOuterStroke { @media (prefers-color-scheme: light) { fill: var(--color-gray-200); } } .ArrowInnerStroke { @media (prefers-color-scheme: dark) { fill: var(--color-gray-300); } } .PopupContent { width: min-content; display: flex; flex-direction: column; gap: 0.5rem; padding: 0.5rem; box-sizing: border-box; } .Image { display: block; border-radius: 0.25rem; max-width: none; } .Summary { margin: 0; font-size: 0.875rem; line-height: 1.25rem; color: var(--color-gray-900); text-wrap: pretty; } .Container { display: flex; gap: 0.5rem; flex-wrap: wrap; justify-content: center; align-items: baseline; } .Paragraph { margin: 0; font-size: 1rem; line-height: 1.5rem; color: var(--color-gray-900); text-wrap: balance; } .Link { outline: 0; color: var(--color-blue); text-decoration-line: none; text-decoration-thickness: 1px; text-decoration-color: color-mix(in oklab, var(--color-blue), transparent 40%); text-underline-offset: 2px; @media (hover: hover) { &:hover { text-decoration-line: underline; } } &[data-popup-open] { text-decoration-line: underline; } &:focus-visible { border-radius: 0.125rem; outline: 2px solid var(--color-blue); text-decoration-line: none; } } .LinkGroup { display: flex; flex-wrap: wrap; gap: 0.25rem; align-items: baseline; } .Button { box-sizing: border-box; display: flex; align-items: center; justify-content: center; height: 2.5rem; padding: 0 0.875rem; margin: 0; outline: 0; border: 1px solid var(--color-gray-200); border-radius: 0.375rem; background-color: var(--color-gray-50); font-family: inherit; font-size: 1rem; font-weight: 500; line-height: 1.5rem; color: var(--color-gray-900); user-select: none; @media (hover: hover) { &:hover { background-color: var(--color-gray-100); } } &:active { background-color: var(--color-gray-100); } &:focus-visible { outline: 2px solid var(--color-blue); outline-offset: -1px; } } ``` ### Multiple triggers A single preview card can be opened by multiple trigger elements. You can achieve this by using the same `handle` for several detached triggers, or by placing multiple `` components inside a single ``. ```jsx title="Multiple triggers within the Root part" Trigger 1 Trigger 2 ... ``` ```jsx title="Multiple detached triggers" const demoPreviewCard = PreviewCard.createHandle(); Trigger 1 Trigger 2 ... ``` The preview card can render different content depending on which trigger opened it. This is achieved by passing a `payload` to the `` and using the function-as-a-child pattern in ``. The payload can be strongly typed by providing a type argument to the `createHandle()` function: ```jsx title="Detached triggers with payload" {1,3,7} "payload" const demoPreviewCard = PreviewCard.createHandle<{ title: string }>(); Trigger 1 Trigger 2 {({ payload }) => ( {payload !== undefined && ( Preview card opened by {payload.title} )} )} ``` ### Controlled mode with multiple triggers You can control the preview card's open state externally using the `open` and `onOpenChange` props on ``. This allows you to manage the preview card's visibility based on your application's state. When using multiple triggers, you have to manage which trigger is active with the `triggerId` prop on `` and the `id` prop on each ``. Note that there is no separate `onTriggerIdChange` prop. Instead, the `onOpenChange` callback receives an additional argument, `eventDetails`, which contains the trigger element that initiated the state change. ## Demo ### Tailwind This example shows how to implement the component using Tailwind CSS. ```tsx /* index.tsx */ 'use client'; import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; const demoPreviewCard = PreviewCard.createHandle(); const cardContents = { typography: (
Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type.

), design: (
Braun ABW30

A design is the concept or proposal for an object, process, or system.

), art: (
Mona Lisa

Art is a diverse range of cultural activity centered around works utilizing creative or imaginative talents, which are expected to evoke a worthwhile experience, generally through an expression of emotional power, conceptual ideas, technical proficiency, or beauty.

), }; export default function PreviewCardDetachedTriggersControlledDemo() { const [open, setOpen] = React.useState(false); const [triggerId, setTriggerId] = React.useState(null); const handleOpenChange = (isOpen: boolean, eventDetails: PreviewCard.Root.ChangeEventDetails) => { setOpen(isOpen); setTriggerId(eventDetails.trigger?.id ?? null); }; return (

Discover{' '} typography ,{' '} design , or{' '} art .

{({ payload }) => ( {payload} )}
); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ### CSS Modules This example shows how to implement the component using CSS Modules. ```tsx /* index.tsx */ 'use client'; import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; import styles from './demos.module.css'; const demoPreviewCard = PreviewCard.createHandle(); const cardContents = { typography: (
Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type.

), design: (
Braun ABW30

A design is the concept or proposal for an object, process, or system.

), art: (
Mona Lisa

Art is a diverse range of cultural activity centered around works utilizing creative or imaginative talents, which are expected to evoke a worthwhile experience, generally through an expression of emotional power, conceptual ideas, technical proficiency, or beauty.

), }; export default function PreviewCardDetachedTriggersControlledDemo() { const [open, setOpen] = React.useState(false); const [triggerId, setTriggerId] = React.useState(null); const handleOpenChange = (isOpen: boolean, eventDetails: PreviewCard.Root.ChangeEventDetails) => { setOpen(isOpen); setTriggerId(eventDetails.trigger?.id ?? null); }; return (

Discover{' '} typography ,{' '} design , or{' '} art .

{({ payload }) => ( {payload} )}
); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ```css /* demos.module.css */ .Positioner { height: var(--positioner-height); width: var(--positioner-width); max-width: var(--available-width); } .Popup { box-sizing: border-box; width: var(--popup-width, auto); height: var(--popup-height, auto); border-radius: 0.5rem; background-color: canvas; transform-origin: var(--transform-origin); transition: transform 150ms, opacity 150ms; &[data-starting-style], &[data-ending-style] { opacity: 0; transform: scale(0.9); } @media (prefers-color-scheme: light) { outline: 1px solid var(--color-gray-200); box-shadow: 0 10px 15px -3px var(--color-gray-200), 0 4px 6px -4px var(--color-gray-200); } @media (prefers-color-scheme: dark) { outline: 1px solid var(--color-gray-300); outline-offset: -1px; } } .Arrow { display: flex; &[data-side='top'] { bottom: -8px; rotate: 180deg; } &[data-side='bottom'] { top: -8px; rotate: 0deg; } &[data-side='left'] { right: -13px; rotate: 90deg; } &[data-side='right'] { left: -13px; rotate: -90deg; } } .ArrowFill { fill: canvas; } .ArrowOuterStroke { @media (prefers-color-scheme: light) { fill: var(--color-gray-200); } } .ArrowInnerStroke { @media (prefers-color-scheme: dark) { fill: var(--color-gray-300); } } .PopupContent { width: min-content; display: flex; flex-direction: column; gap: 0.5rem; padding: 0.5rem; box-sizing: border-box; } .Image { display: block; border-radius: 0.25rem; max-width: none; } .Summary { margin: 0; font-size: 0.875rem; line-height: 1.25rem; color: var(--color-gray-900); text-wrap: pretty; } .Container { display: flex; gap: 0.5rem; flex-wrap: wrap; justify-content: center; align-items: baseline; } .Paragraph { margin: 0; font-size: 1rem; line-height: 1.5rem; color: var(--color-gray-900); text-wrap: balance; } .Link { outline: 0; color: var(--color-blue); text-decoration-line: none; text-decoration-thickness: 1px; text-decoration-color: color-mix(in oklab, var(--color-blue), transparent 40%); text-underline-offset: 2px; @media (hover: hover) { &:hover { text-decoration-line: underline; } } &[data-popup-open] { text-decoration-line: underline; } &:focus-visible { border-radius: 0.125rem; outline: 2px solid var(--color-blue); text-decoration-line: none; } } .LinkGroup { display: flex; flex-wrap: wrap; gap: 0.25rem; align-items: baseline; } .Button { box-sizing: border-box; display: flex; align-items: center; justify-content: center; height: 2.5rem; padding: 0 0.875rem; margin: 0; outline: 0; border: 1px solid var(--color-gray-200); border-radius: 0.375rem; background-color: var(--color-gray-50); font-family: inherit; font-size: 1rem; font-weight: 500; line-height: 1.5rem; color: var(--color-gray-900); user-select: none; @media (hover: hover) { &:hover { background-color: var(--color-gray-100); } } &:active { background-color: var(--color-gray-100); } &:focus-visible { outline: 2px solid var(--color-blue); outline-offset: -1px; } } ``` ### Animating the Preview Card You can animate a preview card as it moves between different trigger elements. This includes animating its position, size, and content. #### Position and Size To animate the preview card's position, apply CSS transitions to the `left`, `right`, `top`, and `bottom` properties of the **Positioner** part. To animate its size, transition the `width` and `height` of the **Popup** part. #### Content The preview card also supports content transitions. This is useful when different triggers display different content within the same preview card. To enable content animations, wrap the content in the `` part. This part provides features to create direction-aware animations. It renders a `div` with a `data-activation-direction` attribute (`left`, `right`, `up`, or `down`) that indicates the new trigger's position relative to the previous one. Inside the ``, the content is further wrapped in `div`s with data attributes to help with styling: - `data-current`: The currently visible content when no transitions are present or the incoming content. - `data-previous`: The outgoing content during a transition. You can use these attributes to style the enter and exit animations. ## Demo ### Tailwind This example shows how to implement the component using Tailwind CSS. ```tsx /* index.tsx */ 'use client'; import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; const demoPreviewCard = PreviewCard.createHandle(); const cardContents = { typography: (
Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type.

), design: (
Braun ABW30

A design is the concept or proposal for an object, process, or system.

), art: (
Mona Lisa

Art is a diverse range of cultural activity centered around works utilizing creative or imaginative talents, which are expected to evoke a worthwhile experience, generally through an expression of emotional power, conceptual ideas, technical proficiency, or beauty.

), }; export default function PreviewCardDetachedTriggersFullDemo() { return (

Discover{' '} typography ,{' '} design , or{' '} art .

{({ payload }) => ( {payload} )}
); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ### CSS Modules This example shows how to implement the component using CSS Modules. ```css /* index.module.css */ .Positioner { --easing: cubic-bezier(0.22, 1, 0.36, 1); --animation-duration: 0.35s; height: var(--positioner-height); width: var(--positioner-width); max-width: var(--available-width); transition-property: top, left, right, bottom, transform; transition-timing-function: var(--easing); transition-duration: var(--animation-duration); } .Popup { position: relative; background-color: canvas; color: var(--color-gray-900); border-radius: 0.5rem; transform-origin: var(--transform-origin); /* These are required to make the size animations work */ width: var(--popup-width, auto); height: var(--popup-height, auto); /* width and height are essential for the resize animation; opacity and transform handle the enter/exit animation */ transition-property: width, height, opacity, transform; transition-timing-function: var(--easing); transition-duration: var(--animation-duration); &[data-starting-style], &[data-ending-style] { opacity: 0; transform: scale(0.9); } @media (prefers-color-scheme: light) { outline: 1px solid var(--color-gray-200); box-shadow: 0 10px 15px -3px var(--color-gray-200), 0 4px 6px -4px var(--color-gray-200); } @media (prefers-color-scheme: dark) { outline: 1px solid var(--color-gray-300); outline-offset: -1px; } } .Arrow { display: flex; &[data-side='top'] { bottom: -8px; rotate: 180deg; } &[data-side='bottom'] { top: -8px; rotate: 0deg; } &[data-side='left'] { right: -13px; rotate: 90deg; } &[data-side='right'] { left: -13px; rotate: -90deg; } } .ArrowFill { fill: canvas; } .ArrowOuterStroke { @media (prefers-color-scheme: light) { fill: var(--color-gray-200); } } .ArrowInnerStroke { @media (prefers-color-scheme: dark) { fill: var(--color-gray-300); } } .Viewport { /* Required to clip the overflowing content during the slide in/out animations */ position: relative; overflow: clip; width: 100%; height: 100%; & [data-previous], & [data-current] { /* This freezes the width of the content while transitioning. The 'previous` container receives the width of the previous content, while the `next` container receives the width of the new content. */ width: var(--popup-width); translate: 0; opacity: 1; transition: translate var(--animation-duration) var(--easing), opacity calc(var(--animation-duration) / 2) var(--easing); } &[data-activation-direction~='left'] [data-current][data-starting-style] { translate: -30% 0; opacity: 0; } &[data-activation-direction~='right'] [data-current][data-starting-style] { translate: 30% 0; opacity: 0; } &[data-activation-direction~='left'] [data-previous][data-ending-style] { translate: 30% 0; opacity: 0; } &[data-activation-direction~='right'] [data-previous][data-ending-style] { translate: -30% 0; opacity: 0; } } .PopupContent { width: min-content; display: flex; flex-direction: column; gap: 0.5rem; padding: 0.5rem; box-sizing: border-box; } .Image { display: block; border-radius: 0.25rem; max-width: none; } .Summary { margin: 0; font-size: 0.875rem; line-height: 1.25rem; color: var(--color-gray-900); text-wrap: pretty; } .Paragraph { margin: 0; font-size: 1rem; line-height: 1.5rem; color: var(--color-gray-900); text-wrap: balance; } .Link { outline: 0; color: var(--color-blue); text-decoration-line: none; text-decoration-thickness: 1px; text-decoration-color: color-mix(in oklab, var(--color-blue), transparent 40%); text-underline-offset: 2px; @media (hover: hover) { &:hover { text-decoration-line: underline; } } &[data-popup-open] { text-decoration-line: underline; } &:focus-visible { border-radius: 0.125rem; outline: 2px solid var(--color-blue); text-decoration-line: none; } } ``` ```tsx /* index.tsx */ 'use client'; import * as React from 'react'; import { PreviewCard } from '@base-ui/react/preview-card'; import styles from './index.module.css'; const demoPreviewCard = PreviewCard.createHandle(); const cardContents = { typography: (
Station Hofplein signage in Rotterdam, Netherlands

Typography is the art and science of arranging type.

), design: (
Braun ABW30

A design is the concept or proposal for an object, process, or system.

), art: (
Mona Lisa

Art is a diverse range of cultural activity centered around works utilizing creative or imaginative talents, which are expected to evoke a worthwhile experience, generally through an expression of emotional power, conceptual ideas, technical proficiency, or beauty.

), }; export default function PreviewCardDetachedTriggersFullDemo() { return (

Discover{' '} typography ,{' '} design , or{' '} art .

{({ payload }) => ( {payload} )}
); } function ArrowSvg(props: React.ComponentProps<'svg'>) { return ( ); } ``` ## API reference ### Root Groups all parts of the preview card. Doesn’t render its own HTML element. **Root Props:** | Prop | Type | Default | Description | | :------------------------------------------------------------ | :----------------------------------------------------------------------------- | :------ | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | defaultOpen | `boolean` | `false` | Whether the preview card is initially open.To render a controlled preview card, use the `open` prop instead. | | open | `boolean` | - | Whether the preview card is currently open. | | onOpenChange | `((open: boolean, eventDetails: PreviewCard.Root.ChangeEventDetails) => void)` | - | Event handler called when the preview card is opened or closed. | | actionsRef | `RefObject` | - | A ref to imperative actions.\* `unmount`: Unmounts the preview card popup. | | \* `close`: Closes the preview card imperatively when called. | | defaultTriggerId | `string \| null` | - | ID of the trigger that the preview card is associated with. This is useful in conjunction with the `defaultOpen` prop to create an initially open preview card. | | handle | `PreviewCard.Handle` | - | A handle to associate the preview card with a trigger. If specified, allows external triggers to control the card's open state. Can be created with the PreviewCard.createHandle() method. | | onOpenChangeComplete | `((open: boolean) => void)` | - | Event handler called after any animations complete when the preview card is opened or closed. | | triggerId | `string \| null` | - | ID of the trigger that the preview card is associated with. This is useful in conjuntion with the `open` prop to create a controlled preview card. There's no need to specify this prop when the preview card is uncontrolled (i.e. when the `open` prop is not set). | | children | `ReactNode \| PayloadChildRenderFunction` | - | The content of the preview card. This can be a regular React node or a render function that receives the `payload` of the active trigger. | ### Trigger A link that opens the preview card. Renders an `` element. **Trigger Props:** | Prop | Type | Default | Description | | :--------- | :--------------------------------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | handle | `PreviewCard.Handle` | - | A handle to associate the trigger with a preview card. | | payload | `Payload` | - | A payload to pass to the preview card when it is opened. | | delay | `number` | `600` | How long to wait before the preview card opens. Specified in milliseconds. | | closeDelay | `number` | `300` | How long to wait before closing the preview card. Specified in milliseconds. | | className | `string \| ((state: PreviewCard.Trigger.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Trigger.State) => CSSProperties \| undefined)` | - | - | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Trigger.State) => ReactElement)` | - | 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. | **Trigger Data Attributes:** | Attribute | Type | 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 ``. Renders a `
` element. **Portal Props:** | Prop | Type | Default | Description | | :---------- | :-------------------------------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | container | `HTMLElement \| ShadowRoot \| RefObject \| null` | - | A parent element to render the portal element into. | | className | `string \| ((state: PreviewCard.Portal.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Portal.State) => CSSProperties \| undefined)` | - | - | | keepMounted | `boolean` | `false` | Whether to keep the portal mounted in the DOM while the popup is hidden. | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Portal.State) => ReactElement)` | - | 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. | ### Backdrop An overlay displayed beneath the popup. Renders a `
` element. **Backdrop Props:** | Prop | Type | Default | Description | | :-------- | :---------------------------------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | `string \| ((state: PreviewCard.Backdrop.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Backdrop.State) => CSSProperties \| undefined)` | - | - | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Backdrop.State) => ReactElement)` | - | 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. | **Backdrop Data Attributes:** | Attribute | Type | 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 `
` element. **Positioner Props:** | Prop | Type | Default | Description | | :-------------------- | :------------------------- | :--------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | disableAnchorTracking | `boolean` | `false` | Whether to disable the popup from tracking any layout shift of its positioning anchor. | | align | `Align` | `'center'` | How to align the popup relative to the specified side. | | alignOffset | `number \| OffsetFunction` | `0` | 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.The function takes a `data` object parameter with the following properties:\* `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. | | side | `Side` | `'bottom'` | Which side of the anchor element to align the popup against. May automatically change to avoid collisions. | | sideOffset | `number \| OffsetFunction` | `0` | 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.The function takes a `data` object parameter with the following properties:\* `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. | | arrowPadding | `number` | `5` | 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. | | anchor | `Element \| VirtualElement \| RefObject \| (() => Element \| VirtualElement \| null) \| null` | - | An element to position the popup against. By default, the popup will be positioned against the trigger. | | collisionAvoidance | `CollisionAvoidance` | - | Determines how to handle collisions when positioning the popup. | | collisionBoundary | `Boundary` | `'clipping-ancestors'` | An element or a rectangle that delimits the area that the popup is confined to. | | collisionPadding | `Padding` | `5` | Additional space to maintain from the edge of the collision boundary. | | sticky | `boolean` | `false` | Whether to maintain the popup in the viewport after the anchor element was scrolled out of view. | | positionMethod | `'absolute' \| 'fixed'` | `'absolute'` | Determines which CSS `position` property to use. | | className | `string \| ((state: PreviewCard.Positioner.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Positioner.State) => CSSProperties \| undefined)` | - | - | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Positioner.State) => ReactElement)` | - | 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. | **Positioner Data Attributes:** | Attribute | Type | 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 | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to specified side. | | data-side | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | Indicates which side the popup is positioned relative to the trigger. | **Positioner CSS Variables:** | Variable | Type | Default | Description | | :----------------- | :------- | :------ | :------------------------------------------------------------------------------------- | | --anchor-height | `number` | - | The anchor's height. | | --anchor-width | `number` | - | The anchor's width. | | --available-height | `number` | - | The available height between the trigger and the edge of the viewport. | | --available-width | `number` | - | The available width between the trigger and the edge of the viewport. | | --transform-origin | `string` | - | The coordinates that this element is anchored to. Used for animations and transitions. | ### Popup A container for the preview card contents. Renders a `
` element. **Popup Props:** | Prop | Type | Default | Description | | :-------- | :------------------------------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | `string \| ((state: PreviewCard.Popup.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Popup.State) => CSSProperties \| undefined)` | - | - | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Popup.State) => ReactElement)` | - | 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. | **Popup Data Attributes:** | Attribute | Type | Description | | :------------------ | :------------------------------------------------------------------------- | :-------------------------------------------------------------------- | | data-open | - | Present when the preview card is open. | | data-closed | - | Present when the preview card is closed. | | data-align | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to specified side. | | data-side | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | 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. | ### Viewport A viewport for displaying content transitions. This component is only required if one popup can be opened by multiple triggers, its content change based on the trigger and switching between them is animated. Renders a `
` element. **Viewport Props:** | Prop | Type | Default | Description | | :-------- | :---------------------------------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | children | `ReactNode` | - | The content to render inside the transition container. | | className | `string \| ((state: PreviewCard.Viewport.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Viewport.State) => CSSProperties \| undefined)` | - | - | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Viewport.State) => ReactElement)` | - | 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. | **Viewport Data Attributes:** | Attribute | Type | Description | | :------------------------ | :----------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | data-activation-direction | `` `${'left' \| 'right'} {'top' \| 'bottom'}` `` | Indicates the direction from which the popup was activated. This can be used to create directional animations based on how the popup was triggered. Contains space-separated values for both horizontal and vertical axes. | | data-current | - | Applied to the direct child of the viewport when no transitions are present or the new content when it's entering. | | data-instant | `'delay' \| 'dismiss' \| 'focus'` | Present if animations should be instant. | | data-previous | - | Applied to the direct child of the viewport that contains the exiting content when transitions are present. | | data-transitioning | - | Indicates that the viewport is currently transitioning between old and new content. | **Viewport CSS Variables:** | Variable | Type | Default | Description | | :------------- | :--- | :------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --popup-height | - | - | The height of the parent popup. This variable is placed on the 'previous' container and stores the height of the popup when the previous content was rendered. It can be used to freeze the dimensions of the popup when animating between different content. | | --popup-width | - | - | The width of the parent popup. This variable is placed on the 'previous' container and stores the width of the popup when the previous content was rendered. It can be used to freeze the dimensions of the popup when animating between different content. | ### Arrow Displays an element positioned against the preview card anchor. Renders a `
` element. **Arrow Props:** | Prop | Type | Default | Description | | :-------- | :------------------------------------------------------------------------------------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | className | `string \| ((state: PreviewCard.Arrow.State) => string \| undefined)` | - | CSS class applied to the element, or a function that returns a class based on the component’s state. | | style | `CSSProperties \| ((state: PreviewCard.Arrow.State) => CSSProperties \| undefined)` | - | - | | render | `ReactElement \| ((props: HTMLProps, state: PreviewCard.Arrow.State) => ReactElement)` | - | 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. | **Arrow Data Attributes:** | Attribute | Type | 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-align | `'start' \| 'center' \| 'end'` | Indicates how the popup is aligned relative to specified side. | | data-side | `'top' \| 'bottom' \| 'left' \| 'right' \| 'inline-end' \| 'inline-start'` | Indicates which side the popup is positioned relative to the trigger. |