Preview Card

In Nyte

import { PreviewCard } from "@nyte-ai/ui/preview-card";

@nyte-ai/ui/preview-card re-exports the Base UI namespace unchanged. There is no Nyte styling on this subpath; the consumer owns every class, StyleX style, and layout decision. Base UI owns the interaction model, keyboard handling, focus management, and ARIA below.

Consumed by:

• desktop/src/renderer/src/chrome/sidebar-session-preview.tsx
• desktop/src/renderer/src/conversation/composer-suggestions.tsx

The rest of this page is Base UI's documentation for @base-ui/react/preview-card, reproduced verbatim under the MIT license, © Material-UI SAS. Component paths in examples refer to the Base UI package; in Nyte, import from the subpath above.

Usage guidelines

• Protect screen reader users' current context: Exposing each preview to screen readers would force users through its contents before they could continue through the page, repeatedly disrupting their current context. Keep the link as the only accessible interface and include all previewed information at its destination.
• Keep popup content supplementary: Avoid placing unique or essential information in the popup unless it is also available on the linked page. For the reason above, preview card content is not touch, keyboard or screen reader navigable. It acts as a visual progressive enhancement for sighted mouse and keyboard users only.

Anatomy

Import the component and assemble its parts:

import { PreviewCard } from '@base-ui/react/preview-card';

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

Examples

Detached triggers

A preview card can be controlled by a trigger located either inside or outside the <PreviewCard.Root> component. For simple, one-off interactions, place the <PreviewCard.Trigger> inside <PreviewCard.Root>, 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 <PreviewCard.Trigger> outside of <PreviewCard.Root> and linking them with a handle created by the PreviewCard.createHandle() function.

The imperative methods on the handle, such as open() and close(), require a <PreviewCard.Root> using the same handle to be mounted. Calls made while no root is attached to the handle — before one mounts, or after it unmounts — are ignored. Each time a root mounts, it starts from fresh state: a call made while no root was attached is not replayed, and no open state carries over from a previous mount.

const demoPreviewCard = PreviewCard.createHandle();

// @highlight
// @highlight-text "handle={demoPreviewCard}"
<PreviewCard.Trigger handle={demoPreviewCard} href="#">
  Link
</PreviewCard.Trigger>

// @highlight
// @highlight-text "handle={demoPreviewCard}"
<PreviewCard.Root handle={demoPreviewCard}>
  ...
</PreviewCard.Root>;

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 <PreviewCard.Trigger> components inside a single <PreviewCard.Root>.

<PreviewCard.Root>
  <PreviewCard.Trigger href="#">Trigger 1</PreviewCard.Trigger>
  <PreviewCard.Trigger href="#">Trigger 2</PreviewCard.Trigger>
  ...
</PreviewCard.Root>

const demoPreviewCard = PreviewCard.createHandle();

<PreviewCard.Trigger handle={demoPreviewCard} href="#">
  Trigger 1
</PreviewCard.Trigger>

<PreviewCard.Trigger handle={demoPreviewCard} href="#">
  Trigger 2
</PreviewCard.Trigger>

<PreviewCard.Root handle={demoPreviewCard}>
  ...
</PreviewCard.Root>

The preview card can render different content depending on which trigger opened it. This is achieved by passing a payload to the <PreviewCard.Trigger> and using the function-as-a-child pattern in <PreviewCard.Root>.

The payload can be strongly typed by providing a type argument to the createHandle() function:

// @highlight
const demoPreviewCard = PreviewCard.createHandle<{ title: string }>();

// @highlight
// @highlight-text "payload"
<PreviewCard.Trigger handle={demoPreviewCard} payload={{ title: 'Trigger 1' }} href="#">
  Trigger 1
</PreviewCard.Trigger>

// @highlight
// @highlight-text "payload"
<PreviewCard.Trigger handle={demoPreviewCard} payload={{ title: 'Trigger 2' }} href="#">
  Trigger 2
</PreviewCard.Trigger>

<PreviewCard.Root handle={demoPreviewCard}>
  {({ payload }) => ( // @highlight-text "payload"
    <PreviewCard.Portal>
      <PreviewCard.Positioner sideOffset={8}>
        <PreviewCard.Popup>
          {payload !== undefined && ( // @highlight-text "payload"
            <span>
              Preview card opened by {payload.title} {/* @highlight-text "payload" */}
            </span>
          )}
        </PreviewCard.Popup>
      </PreviewCard.Positioner>
    </PreviewCard.Portal>
  )}
</PreviewCard.Root>

Controlled mode with multiple triggers

You can control the preview card's open state externally using the open and onOpenChange props on <PreviewCard.Root>. 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 <PreviewCard.Root> and the id prop on each <PreviewCard.Trigger>.

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.

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 <PreviewCard.Viewport> part. This part provides features to create direction-aware animations. It renders a div with a data-activation-direction attribute that indicates the new trigger's position relative to the previous one. The value is a space-separated set of up to two tokens (one per axis) — left or right for the horizontal axis and up or down for the vertical axis (for example, right down). Match a single token with the ~= attribute selector, such as [data-activation-direction~='right'].

Inside the <PreviewCard.Viewport>, the content is further wrapped in divs 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.

API reference

Root

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

Root Props:

Root.Props

Re-export of Root props.

Root.State

type PreviewCardRootState = {};

Root.Actions

type PreviewCardRootActions = { unmount: () => void; close: () => void };

Root.ChangeEventReason

type PreviewCardRootChangeEventReason =
  | 'trigger-hover'
  | 'trigger-focus'
  | 'trigger-press'
  | 'outside-press'
  | 'escape-key'
  | 'imperative-action'
  | 'none';

Root.ChangeEventDetails

type PreviewCardRootChangeEventDetails = (
  | { reason: 'trigger-hover'; event: MouseEvent }
  | { reason: 'trigger-focus'; event: FocusEvent }
  | { reason: 'trigger-press'; event: MouseEvent | PointerEvent | TouchEvent | KeyboardEvent }
  | { reason: 'outside-press'; event: MouseEvent | PointerEvent | TouchEvent }
  | { reason: 'escape-key'; event: KeyboardEvent }
  | { reason: 'imperative-action'; event: Event }
  | { reason: 'none'; event: Event }
) & {
  /** Cancels Base UI from handling the event. */
  cancel: () => void;
  /** Allows the event to propagate in cases where Base UI will stop the propagation. */
  allowPropagation: () => void;
  /** Indicates whether the event has been canceled. */
  isCanceled: boolean;
  /** Indicates whether the event is allowed to propagate. */
  isPropagationAllowed: boolean;
  /** The element that triggered the event, if applicable. */
  trigger: Element | undefined;
  preventUnmountOnClose: preventUnmountOnClose;
};

Trigger

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

Trigger Props:

Trigger Data Attributes:

Trigger.Props

Re-export of Trigger props.

Trigger.State

type PreviewCardTriggerState = {
  /** Whether the preview card is currently open and was opened by this trigger. */
  open: boolean;
};

Portal

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

Portal Props:

Portal.Props

Re-export of Portal props.

Portal.State

type PreviewCardPortalState = {};

Backdrop

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

Backdrop Props:

Backdrop Data Attributes:

Backdrop.Props

Re-export of Backdrop props.

Backdrop.State

type PreviewCardBackdropState = {
  /** Whether the preview card is currently open. */
  open: boolean;
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
};

Positioner

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

Positioner Props:

alignOffset Prop Example:

<Positioner
  alignOffset={({ side, align, anchor, positioner }) => {
    return side === 'top' || side === 'bottom' ? anchor.width : anchor.height;
  }}
/>

sideOffset Prop Example:

<Positioner
  sideOffset={({ side, align, anchor, positioner }) => {
    return side === 'top' || side === 'bottom' ? anchor.height : anchor.width;
  }}
/>

collisionAvoidance Prop Example:

<Positioner
  collisionAvoidance={{
    side: 'shift',
    align: 'shift',
    fallbackAxisSide: 'none',
  }}
/>

Positioner Data Attributes:

Positioner CSS Variables:

Positioner.Props

Re-export of Positioner props.

Positioner.State

type PreviewCardPositionerState = {
  /** Whether the preview card is currently open. */
  open: boolean;
  /** The side of the anchor the component is placed on. */
  side: Side;
  /** The alignment of the component relative to the anchor. */
  align: Align;
  /** Whether the anchor element is hidden. */
  anchorHidden: boolean;
  /** Whether transitions should be skipped. */
  instant: 'dismiss' | 'focus' | undefined;
};

Popup

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

Popup Props:

Popup Data Attributes:

Popup.Props

Re-export of Popup props.

Popup.State

type PreviewCardPopupState = {
  /** Whether the preview card is currently open. */
  open: boolean;
  /** The side of the anchor the component is placed on. */
  side: Side;
  /** The alignment of the component relative to the anchor. */
  align: Align;
  /** Whether transitions should be skipped. */
  instant: 'dismiss' | 'focus' | undefined;
  /** The transition status of the component. */
  transitionStatus: TransitionStatus;
};

Arrow

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

Arrow Props:

Arrow Data Attributes:

Arrow.Props

Re-export of Arrow props.

Arrow.State

type PreviewCardArrowState = {
  /** Whether the preview card is currently open. */
  open: boolean;
  /** The side of the anchor the component is placed on. */
  side: Side;
  /** The alignment of the component relative to the anchor. */
  align: Align;
  /** Whether the arrow cannot be centered on the anchor. */
  uncentered: boolean;
};

Viewport

A viewport for displaying content transitions. This component is only required if one popup can be opened by multiple triggers, its content changes based on the trigger, and switching between them is animated. Renders a <div> element.

Viewport Props:

Viewport Data Attributes:

Viewport CSS Variables:

Viewport.Props

Re-export of Viewport props.

Viewport.State

type PreviewCardViewportState = {
  /** The activation direction of the transitioned content. */
  activationDirection: string | undefined;
  /** Whether the viewport is currently transitioning between contents. */
  transitioning: boolean;
  /** Present if animations should be instant. */
  instant: 'dismiss' | 'focus' | undefined;
};

createHandle

Creates a new handle to connect a PreviewCard.Root with detached PreviewCard.Trigger components.

Return Value:

type ReturnValue = PreviewCard.Handle<Payload>;

Handle

Controls a PreviewCard imperatively and associates detached PreviewCard.Trigger components with a PreviewCard.Root. Create one with PreviewCard.createHandle() and pass it to the handle prop of the root and of any triggers rendered outside of it.

The imperative methods take effect only while a root using this handle is mounted; calls made before a root attaches (or after it unmounts) are ignored.

Properties:

Methods:

function open(triggerId: string): void;

Opens the preview card and associates it with the trigger with the given id.

This method should only be called in an event handler or an effect (not during rendering).

function close(): void;

Closes the preview card.

This method should only be called in an event handler or an effect (not during rendering).

External Types

PayloadChildRenderFunction

type PayloadChildRenderFunction = (arg: { payload: unknown | undefined }) => ReactNode;

preventUnmountOnClose

type preventUnmountOnClose = () => void;

Side

type Side = 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start';

Align

type Align = 'start' | 'center' | 'end';

OffsetFunction

type OffsetFunction = (data: {
  side: 'top' | 'bottom' | 'left' | 'right' | 'inline-end' | 'inline-start';
  align: 'start' | 'center' | 'end';
  anchor: { width: number; height: number };
  positioner: { width: number; height: number };
}) => number;

Export Groups

• PreviewCard.Root: PreviewCard.Root, PreviewCard.Root.State, PreviewCard.Root.Props, PreviewCard.Root.Actions, PreviewCard.Root.ChangeEventReason, PreviewCard.Root.ChangeEventDetails
• PreviewCard.Portal: PreviewCard.Portal, PreviewCard.Portal.State, PreviewCard.Portal.Props
• PreviewCard.Trigger: PreviewCard.Trigger, PreviewCard.Trigger.State, PreviewCard.Trigger.Props
• PreviewCard.Positioner: PreviewCard.Positioner, PreviewCard.Positioner.State, PreviewCard.Positioner.Props
• PreviewCard.Popup: PreviewCard.Popup, PreviewCard.Popup.State, PreviewCard.Popup.Props
• PreviewCard.Arrow: PreviewCard.Arrow, PreviewCard.Arrow.State, PreviewCard.Arrow.Props
• PreviewCard.Backdrop: PreviewCard.Backdrop, PreviewCard.Backdrop.State, PreviewCard.Backdrop.Props
• PreviewCard.Viewport: PreviewCard.Viewport, PreviewCard.Viewport.Props, PreviewCard.Viewport.State
• PreviewCard.createHandle
• PreviewCard.Handle
• Default: PreviewCardRootState, PreviewCardRootProps, PreviewCardRootActions, PreviewCardRootChangeEventReason, PreviewCardRootChangeEventDetails, PreviewCardTriggerState, PreviewCardTriggerProps, PreviewCardPortalState, PreviewCardPortalProps, PreviewCardPositionerState, PreviewCardPositionerProps, PreviewCardPopupState, PreviewCardPopupProps, PreviewCardArrowState, PreviewCardArrowProps, PreviewCardViewportState, PreviewCardViewportProps, PreviewCardBackdropState, PreviewCardBackdropProps

Canonical Types

Maps Canonical: Alias — Use Canonical when its namespace is already imported; otherwise use Alias.

• PreviewCard.Root.State: PreviewCardRootState
• PreviewCard.Root.Props: PreviewCardRootProps
• PreviewCard.Root.Actions: PreviewCardRootActions
• PreviewCard.Root.ChangeEventReason: PreviewCardRootChangeEventReason
• PreviewCard.Root.ChangeEventDetails: PreviewCardRootChangeEventDetails
• PreviewCard.Portal.State: PreviewCardPortalState
• PreviewCard.Portal.Props: PreviewCardPortalProps
• PreviewCard.Trigger.State: PreviewCardTriggerState
• PreviewCard.Trigger.Props: PreviewCardTriggerProps
• PreviewCard.Positioner.State: PreviewCardPositionerState
• PreviewCard.Positioner.Props: PreviewCardPositionerProps
• PreviewCard.Popup.State: PreviewCardPopupState
• PreviewCard.Popup.Props: PreviewCardPopupProps
• PreviewCard.Arrow.State: PreviewCardArrowState
• PreviewCard.Arrow.Props: PreviewCardArrowProps
• PreviewCard.Backdrop.State: PreviewCardBackdropState
• PreviewCard.Backdrop.Props: PreviewCardBackdropProps
• PreviewCard.Viewport.Props: PreviewCardViewportProps
• PreviewCard.Viewport.State: PreviewCardViewportState