On this page

PreviewCard Primitive

PreviewCard is a Starwind Runtime primitive in the presence-floating-overlay contract family.

Anatomy

Use the Astro primitive adapter to render PreviewCard anatomy with the Runtime wiring included.

---
import { PreviewCard } from "@starwind-ui/astro/preview-card";
---

<PreviewCard.Root>
  <PreviewCard.Trigger>Preview profile</PreviewCard.Trigger>
  <PreviewCard.Positioner>
    <PreviewCard.Popup>
      <PreviewCard.Arrow />
    </PreviewCard.Popup>
  </PreviewCard.Positioner>
</PreviewCard.Root>

Use the React primitive adapter when PreviewCard state participates in React rendering.

import { PreviewCard } from "@starwind-ui/react/preview-card";

export function Example() {
  return (
    <PreviewCard.Root>
      <PreviewCard.Trigger>Preview profile</PreviewCard.Trigger>
      <PreviewCard.Positioner>
        <PreviewCard.Popup>
          <PreviewCard.Arrow />
        </PreviewCard.Popup>
      </PreviewCard.Positioner>
    </PreviewCard.Root>
  );
}

Render the PreviewCard data-sw-* contract yourself, then initialize createPreviewCard.

<div data-sw-preview-card>
  <button data-sw-preview-card-trigger type="button">Preview profile</button>
  <div data-sw-preview-card-positioner>
    <div data-sw-preview-card-popup role="tooltip" hidden>
      <div data-sw-preview-card-arrow></div>
    </div>
  </div>
</div>

<script type="module">
  import { createPreviewCard } from "@starwind-ui/runtime/preview-card";

  const root = document.querySelector("[data-sw-preview-card]");
  if (root) {
    createPreviewCard(root);
  }
</script>

Floating Behavior

Fact	Value
Anchor part	trigger
Positioner part	positioner
Popup part	popup
Portal part	portal
Option props	side, align, sideOffset, avoidCollisions

API Reference

Root

The main element that owns the PreviewCard Runtime instance.

Default element: div
Discovery hook: data-sw-preview-card
Role: -

Props

Prop Type Default

open boolean -

Description: Controls whether PreviewCard is open.
Kind: control
Targets: root
Full type: boolean

defaultOpen boolean false

Description: Sets whether PreviewCard starts open.
Kind: control
Targets: root
Full type: boolean

closeDelay number 300

Description: Sets how long PreviewCard waits before closing.
Kind: option
Targets: -
Full type: number

closeOnEscape boolean true

Description: Closes PreviewCard when Escape is pressed.
Kind: option
Targets: -
Full type: boolean

closeOnOutsideInteract boolean true

Description: Closes PreviewCard when the user interacts outside it.
Kind: option
Targets: -
Full type: boolean

disableHoverableContent boolean false

Description: Configures the disable hoverable content option for the Root part.
Kind: option
Targets: root
Full type: boolean

openDelay number 600

Description: Sets how long PreviewCard waits before opening.
Kind: option
Targets: -
Full type: number

onOpenChange (open: boolean, details: PreviewCardOpenChangeDetails) => void -

Description: Runs when PreviewCard opens or closes.
Kind: callback
Targets: -
Full type: (open: boolean, details: PreviewCardOpenChangeDetails) => void

Events

Event Callback Value

openChange onOpenChange open: boolean

Description: Fires when PreviewCard opens or closes.
DOM event: starwind:open-change
Details type: PreviewCardOpenChangeDetails
Timing: before-state-commit
Cancelable: Yes

State

State Type Props

open boolean open / defaultOpen

Description: Tracks whether PreviewCard is open.
Initial attribute: data-default-open
Runtime getter: getOpen
Runtime setter: setOpen
State control support: React supports controlled and default state with open and defaultOpen props. Runtime/HTML reads initial state from data-default-open, emits starwind:open-change, and updates with setOpen. Astro adapters render initial/default state, but do not expose reactive controlled-state props for this state.

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card - Marks the Root part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Root part.

Metadata

Attribute Value Description

data-default-open - Reflects the default open prop on the Root part.

data-close-delay - Reflects the close delay prop on the Root part.

data-close-on-escape - Reflects the close on escape prop on the Root part.

data-close-on-outside-interact - Reflects the close on outside interact prop on the Root part.

data-content-hoverable - Reflects the content hoverable prop on the Root part.

data-open-delay - Reflects the open delay prop on the Root part.

Trigger

The control that opens, closes, or targets the PreviewCard content.

Default element: button
Discovery hook: data-sw-preview-card-trigger
Role: -

Props

Prop Type Default

asChild boolean -

Description: Merges behavior onto your child element instead of rendering the default Trigger element.
Kind: rendering
Targets: trigger
Full type: boolean

disabled boolean false

Description: Disables the Trigger part.
Kind: option
Targets: trigger
Full type: boolean

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-trigger - Marks the Trigger part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Trigger part.

Metadata

Attribute Value Description

data-as-child - Reflects the as child prop on the Trigger part.

data-close-delay - Reflects the close delay prop on the Trigger part.

data-disabled - Reflects the disabled prop on the Trigger part.

data-open-delay - Reflects the open delay prop on the Trigger part.

Portal

Moves PreviewCard overlay content to the document body when needed.

Default element: div
Discovery hook: data-sw-preview-card-portal
Role: -

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-portal - Marks the Portal part so Starwind Runtime can find it.

Positioner

Positions the PreviewCard content relative to its trigger.

Default element: div
Discovery hook: data-sw-preview-card-positioner
Role: -

Props

Prop Type Default

side "top" | "right" | "bottom" | "left" "bottom"

Description: Sets the preferred side for PreviewCard content.
Kind: option
Targets: positioner, popup
Full type: "top" | "right" | "bottom" | "left"

align "start" | "center" | "end" "center"

Description: Sets how PreviewCard content aligns to its trigger.
Kind: option
Targets: positioner, popup
Full type: "start" | "center" | "end"

sideOffset number 0

Description: Sets the distance between PreviewCard content and its trigger.
Kind: option
Targets: positioner, popup
Full type: number

avoidCollisions boolean true

Description: Allows PreviewCard content to shift or flip to stay visible.
Kind: option
Targets: positioner, popup
Full type: boolean

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-positioner - Marks the Positioner part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Positioner part.

Metadata

Attribute Value Description

data-side - Reflects the side prop on the Positioner part.

data-align - Reflects the align prop on the Positioner part.

data-side-offset - Reflects the side offset prop on the Positioner part.

data-avoid-collisions - Reflects the avoid collisions prop on the Positioner part.

The floating content container for PreviewCard.

Default element: div
Discovery hook: data-sw-preview-card-popup
Role: tooltip

Props

Prop Type Default

side "top" | "right" | "bottom" | "left" "bottom"

Description: Sets the preferred side for PreviewCard content.
Kind: option
Targets: positioner, popup
Full type: "top" | "right" | "bottom" | "left"

align "start" | "center" | "end" "center"

Description: Sets how PreviewCard content aligns to its trigger.
Kind: option
Targets: positioner, popup
Full type: "start" | "center" | "end"

sideOffset number 0

Description: Sets the distance between PreviewCard content and its trigger.
Kind: option
Targets: positioner, popup
Full type: number

avoidCollisions boolean true

Description: Allows PreviewCard content to shift or flip to stay visible.
Kind: option
Targets: positioner, popup
Full type: boolean

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-popup - Marks the Popup part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Popup part.

Metadata

Attribute Value Description

data-side - Reflects the side prop on the Popup part.

data-align - Reflects the align prop on the Popup part.

data-side-offset - Reflects the side offset prop on the Popup part.

data-avoid-collisions - Reflects the avoid collisions prop on the Popup part.

Arrow

The arrow element that visually points to the trigger.

Default element: div
Discovery hook: data-sw-preview-card-arrow
Role: -

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-arrow - Marks the Arrow part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Arrow part.

Backdrop

The backdrop shown behind the PreviewCard overlay.

Default element: div
Discovery hook: data-sw-preview-card-backdrop
Role: -

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-backdrop - Marks the Backdrop part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Backdrop part.

Viewport

The visible viewport for PreviewCard content.

Default element: div
Discovery hook: data-sw-preview-card-viewport
Role: -

Data Attributes

Runtime hooks

Attribute Value Description

data-sw-preview-card-viewport - Marks the Viewport part so Starwind Runtime can find it.

State

Attribute Value Description

data-state - Reflects the current state on the Viewport part.

Runtime API

Factory: createPreviewCard
Import: @starwind-ui/runtime/preview-card
Root hook: root data-sw-preview-card
Option props: closeDelay, closeOnEscape, closeOnOutsideInteract, defaultOpen, disableHoverableContent, onOpenChange, open, openDelay

Option Lifecycles

Option	Lifecycle
closeDelay	constructor-only
closeOnEscape	constructor-only
closeOnOutsideInteract	constructor-only
defaultOpen	constructor-only
disableHoverableContent	constructor-only
onOpenChange	constructor-only
open	setter-backed
openDelay	constructor-only

Runtime Setters

Method Target Description

setOpen state: open Opens or closes PreviewCard from Runtime code.

Component Relationship

Hover Card Renamed primitive

Layer Metadata

Preview Card Primitive uses createPreviewCard. Styled components: Hover Card.

primitive Preview Card Primitive Preview Card Primitive uses createPreviewCard. Styled components: Hover Card. Runtime primitive Primitive adapter Astro Primitive adapters React Primitive adapters preview-card Preview Card Presence Floating Overlay Overlays that combine open state, portal structure, and floating placement. /docs/primitives/preview-card/ createPreviewCard @starwind-ui/runtime/preview-card /docs/runtime/#create-preview-card root closeDelay closeOnEscape closeOnOutsideInteract defaultOpen disableHoverableContent onOpenChange open openDelay raw-html astro react solid svelte vue HTML Astro React Solid Svelte Vue Raw HTML Render the PreviewCard data-sw-* contract yourself, then initialize createPreviewCard. html Use the Astro primitive adapter to render PreviewCard anatomy with the Runtime wiring included. Use the React primitive adapter when PreviewCard state participates in React rendering. tsx div data-sw-preview-card boolean Controls whether PreviewCard is open. Sets whether PreviewCard starts open. number Sets how long PreviewCard waits before closing. Closes PreviewCard when Escape is pressed. Closes PreviewCard when the user interacts outside it. Configures the disable hoverable content option for the Root part. Sets how long PreviewCard waits before opening. (open: boolean, details: PreviewCardOpenChangeDetails) => void PreviewCardOpenChangeDetails Runs when PreviewCard opens or closes. runtime Marks the Root part so Starwind Runtime can find it. data-default-open prop Reflects the default open prop on the Root part. data-close-delay Reflects the close delay prop on the Root part. data-close-on-escape Reflects the close on escape prop on the Root part. data-close-on-outside-interact Reflects the close on outside interact prop on the Root part. data-content-hoverable Reflects the content hoverable prop on the Root part. data-open-delay Reflects the open delay prop on the Root part. data-state state Reflects the current state on the Root part. getOpen setOpen openChange starwind:open-change trigger button data-sw-preview-card-trigger asChild Merges behavior onto your child element instead of rendering the default Trigger element. disabled Disables the Trigger part. Marks the Trigger part so Starwind Runtime can find it. data-as-child Reflects the as child prop on the Trigger part. Reflects the close delay prop on the Trigger part. data-disabled Reflects the disabled prop on the Trigger part. Reflects the open delay prop on the Trigger part. Reflects the current state on the Trigger part. portal data-sw-preview-card-portal Marks the Portal part so Starwind Runtime can find it. positioner data-sw-preview-card-positioner side "top" | "right" | "bottom" | "left" Sets the preferred side for PreviewCard content. align "start" | "center" | "end" Sets how PreviewCard content aligns to its trigger. sideOffset Sets the distance between PreviewCard content and its trigger. avoidCollisions Allows PreviewCard content to shift or flip to stay visible. Marks the Positioner part so Starwind Runtime can find it. Reflects the current state on the Positioner part. data-side Reflects the side prop on the Positioner part. data-align Reflects the align prop on the Positioner part. data-side-offset Reflects the side offset prop on the Positioner part. data-avoid-collisions Reflects the avoid collisions prop on the Positioner part. popup data-sw-preview-card-popup tooltip Marks the Popup part so Starwind Runtime can find it. Reflects the current state on the Popup part. Reflects the side prop on the Popup part. Reflects the align prop on the Popup part. Reflects the side offset prop on the Popup part. Reflects the avoid collisions prop on the Popup part. arrow data-sw-preview-card-arrow Marks the Arrow part so Starwind Runtime can find it. Reflects the current state on the Arrow part. backdrop data-sw-preview-card-backdrop Marks the Backdrop part so Starwind Runtime can find it. Reflects the current state on the Backdrop part. viewport data-sw-preview-card-viewport Marks the Viewport part so Starwind Runtime can find it. Reflects the current state on the Viewport part. Root Trigger type aria-disabled Portal Positioner Popup role hidden Arrow Backdrop Viewport @starwind-ui/astro @starwind-ui/astro/preview-card Render static closed preview card anatomy and self-initialize; runtime owns hover/focus timers, portal movement, and floating updates. @starwind-ui/react @starwind-ui/react/preview-card Create the controller with creation-time timing/dismissal options and bridge controlled open state through setOpen. hover-card Hover Card /docs/components/hover-card/ Renamed primitive renamed-primitive The styled docs use Hover Card while the primitive is preview-card. Styled component Hover Card

PreviewCard Primitive

Anatomy

Floating Behavior

API Reference

Root

Props

Events

State

Data Attributes

Runtime hooks

State

Metadata

Trigger

Props

Data Attributes

Runtime hooks

State

Metadata

Portal

Data Attributes

Runtime hooks

Positioner

Props

Data Attributes

Runtime hooks

State

Metadata

Popup

Props

Data Attributes

Runtime hooks

State

Metadata

Arrow

Data Attributes

Runtime hooks

State

Backdrop

Data Attributes

Runtime hooks

State

Viewport

Data Attributes

Runtime hooks

State

Runtime API

Option Lifecycles

Runtime Setters

Related Styled Components