# @fayegram-ai/faye-ui/overlays/preview-card

Public exports and dependency-resolved component properties, with usage and rendering guidance.

## Import

```tsx
import { PreviewCard } from '@fayegram-ai/faye-ui/overlays/preview-card';
```

[Usage and behavior guide](/docs/floating/) · [API JSON](/api/packages/overlays/preview-card.json)

This entry declares a client boundary. Follow the rendering guide for framework integration.

## Public exports

| Name | Kind | Resolved declaration type |
|---|---|---|
| `PreviewCard` | value | `{ readonly Root: <Payload>(props: Base.Root.Props<Payload>) => React.JSX.Element; readonly Trigger: { (input: Base.Trigger.Props<unknown> & import("react").RefAttributes<HTMLElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "tone"> \| undefined; } \| undefined; }): import("react").ReactElement; displayName: string; }; readonly Positioner: { (input: Omit<import("@base-ui/react").PreviewCardPositionerProps, "ref"> & import("react").RefAttributes<HTMLDivElement> & { variants?: { readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "size"> \| undef… (full type in API JSON)` |

## PreviewCard

Public component; use the linked family guide for complete composition and behavior.

Dependency-resolved declaration properties. Common React/native HTML attributes are omitted from the table; use the full declaration and React/native references. Generic and union restrictions remain authoritative in TypeScript.

### PreviewCard.Root

| Property | Required | Type | Meaning |
|---|---|---|---|
| `actionsRef` | No | `RefObject<PreviewCardRootActions \| null> \| undefined` | A ref to imperative actions. - `unmount`: Unmounts the preview card popup. - `close`: Closes the preview card imperatively when called. |
| `children` | No | `ReactNode \| PayloadChildRenderFunction<Payload>` | 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. |
| `defaultOpen` | No | `boolean \| undefined` | Whether the preview card is initially open. To render a controlled preview card, use the `open` prop instead. |
| `defaultTriggerId` | No | `string \| null \| undefined` | 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` | No | `Base.Handle<Payload> \| undefined` | 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. |
| `onOpenChange` | No | `((open: boolean, eventDetails: Base.Root.ChangeEventDetails) => void) \| undefined` | Event handler called when the preview card is opened or closed. |
| `onOpenChangeComplete` | No | `((open: boolean) => void) \| undefined` | Event handler called after any animations complete when the preview card is opened or closed. |
| `open` | No | `boolean \| undefined` | Whether the preview card is currently open. |
| `triggerId` | No | `string \| null \| undefined` | ID of the trigger that the preview card is associated with. This is useful in conjunction with the `open` prop to create a controlled preview card. There's no need to specify this prop when the preview card is uncontrolled (that is, when the `open` prop is not set). |

### PreviewCard.Trigger

| Property | Required | Type | Meaning |
|---|---|---|---|
| `className` | No | `string \| ((state: PreviewCardTriggerState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `closeDelay` | No | `number \| undefined` | How long to wait before closing the preview card. Specified in milliseconds. |
| `delay` | No | `number \| undefined` | How long to wait before the preview card opens. Specified in milliseconds. |
| `handle` | No | `Base.Handle<unknown> \| undefined` | A handle to associate the trigger with a preview card. |
| `payload` | No | `unknown` | A payload to pass to the preview card when it is opened. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<DetailedHTMLProps<AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, PreviewCardTriggerState> \| undefined` | 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. |
| `style` | No | `CSSProperties \| ((state: PreviewCardTriggerState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |
| `variants` | No | `{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "tone"> \| undefined; } \| undefined` | See the usage contract and declaration. |

### PreviewCard.Positioner

| Property | Required | Type | Meaning |
|---|---|---|---|
| `align` | No | `Align \| undefined` | How to align the popup relative to the specified side. |
| `alignOffset` | No | `number \| OffsetFunction \| undefined` | 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. |
| `anchor` | No | `Element \| VirtualElement \| RefObject<Element \| null> \| (() => Element \| VirtualElement \| null) \| null \| undefined` | An element to position the popup against. By default, the popup will be positioned against the trigger. |
| `arrowPadding` | No | `number \| undefined` | 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. |
| `className` | No | `string \| ((state: PreviewCardPositionerState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `collisionAvoidance` | No | `CollisionAvoidance \| undefined` | Determines how to handle collisions when positioning the popup. `side` controls overflow on the preferred placement axis (`top`/`bottom` or `left`/`right`): - `'flip'`: keep the requested side when it fits; otherwise try the opposite side (`top` and `bottom`, or `left` and `right`). - `'shift'`: never change side; keep the requested side and move the popup within the clipping boundary so it stays visible. - `'none'`: do not correct side-axis overflow. `align` controls overflow on the alignment axis (`start`/`center`/`end`): - `'flip'`: keep side, but swap `start` and `end` when the requested alignment overflows. - `'shift'`: keep side and requested alignment, then nudge the popup along the alignment axis to fit. - `'none'`: do not correct alignment-axis overflow. `fallbackAxisSide` controls fallback behavior on the perpendicular axis when the preferred axis cannot fit: - `'start'`: allow perpendicular fallback and try the logical start side first (`top` before `bottom`, or `left` before `right` in LTR). - `'end'`: allow perpendicular fallback and try the logical end side first (`bottom` before `top`, or `right` before `left` in LTR). - `'none'`: do not fallback to the perpendicular axis. When `side` is `'shift'`, explicitly setting `align` only supports `'shift'` or `'none'`. If `align` is omitted, it defaults to `'flip'`. |
| `collisionBoundary` | No | `Boundary \| undefined` | An element or a rectangle that delimits the area that the popup is confined to. |
| `collisionPadding` | No | `Padding \| undefined` | Additional space to maintain from the edge of the collision boundary. |
| `disableAnchorTracking` | No | `boolean \| undefined` | Whether to disable the popup from tracking any layout shift of its positioning anchor. |
| `positionMethod` | No | `"absolute" \| "fixed" \| undefined` | Determines which CSS `position` property to use. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, PreviewCardPositionerState> \| undefined` | 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. |
| `side` | No | `Side \| undefined` | Which side of the anchor element to align the popup against. May automatically change to avoid collisions. |
| `sideOffset` | No | `number \| OffsetFunction \| undefined` | 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. |
| `sticky` | No | `boolean \| undefined` | Whether to maintain the popup in the viewport after the anchor element was scrolled out of view. |
| `style` | No | `CSSProperties \| ((state: PreviewCardPositionerState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |
| `variants` | No | `{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "tone"> \| undefined; } \| undefined` | See the usage contract and declaration. |

### PreviewCard.Popup

| Property | Required | Type | Meaning |
|---|---|---|---|
| `className` | No | `string \| ((state: PreviewCardPopupState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, PreviewCardPopupState> \| undefined` | 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. |
| `style` | No | `CSSProperties \| ((state: PreviewCardPopupState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |
| `variants` | No | `{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "tone"> \| undefined; } \| undefined` | See the usage contract and declaration. |

### PreviewCard.Arrow

| Property | Required | Type | Meaning |
|---|---|---|---|
| `className` | No | `string \| ((state: PreviewCardArrowState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, PreviewCardArrowState> \| undefined` | 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. |
| `style` | No | `CSSProperties \| ((state: PreviewCardArrowState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |
| `variants` | No | `{ readonly size?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "size"> \| undefined; readonly tone?: import("@fayegram-ai/faye-ui/contracts/visual-variants").VisualVariant<"preview-card", "tone"> \| undefined; } \| undefined` | See the usage contract and declaration. |

### PreviewCard.Portal

| Property | Required | Type | Meaning |
|---|---|---|---|
| `className` | No | `string \| ((state: PreviewCardPortalState) => string \| undefined) \| undefined` | CSS class applied to the element, or a function that returns a class based on the component's state. |
| `container` | No | `HTMLElement \| ShadowRoot \| RefObject<HTMLElement \| ShadowRoot \| null> \| null \| undefined` | A parent element to render the portal element into. |
| `keepMounted` | No | `boolean \| undefined` | Whether to keep the portal mounted in the DOM while the popup is hidden. |
| `render` | No | `ReactElement<unknown, string \| JSXElementConstructor<any>> \| ComponentRenderFn<HTMLProps, PreviewCardPortalState> \| undefined` | 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. |
| `style` | No | `CSSProperties \| ((state: PreviewCardPortalState) => React.CSSProperties \| undefined) \| undefined` | Style applied to the element, or a function that returns a style object based on the component's state. |

## Defaults and customization

Descriptor defaults: `{"size":"md","tone":"neutral"}`. Parts: `trigger`, `positioner`, `popup`, `arrow`. Explicit instance props take precedence over configured defaults.

Use semantic tokens, public part hooks and customization sheets. Keep visual configuration separate from application state.

## State, events and accessibility

For interactive controls, pair a controlled value/open prop with its corresponding change callback; default props initialize uncontrolled state. Keep application validation and submission policy explicit. Name controls with visible labels, name icon-only actions on the button, and preserve focus and dismissal behavior when replacing parts. Use native form names and submit/reset types where supported. See the usage guide for component-specific behavior and live examples.

## Declaration authority

Generated from `packages/faye-ui/dist/overlays/preview-card.d.ts` after the semantic package build. Common native/React attributes are intentionally omitted from property tables. Generic overloads, discriminated unions and complete inherited attributes remain authoritative in installed TypeScript declarations. [React DOM attributes](https://react.dev/reference/react-dom/components/common) and [Base UI component contracts](https://base-ui.com/react/overview/quick-start) describe the inherited foundations.