Skip to content

XrayOptions

Defined in: index.ts:37

Options for xrayVitePlugin().

Fixed conventions are intentionally not configurable: Plate names come from virtual:xray/plates/<name>, files live under platesDir, and responsive breakpoints are derived from captured CSS plus the matchMedia queries the page evaluates.

optional capture?: boolean

Defined in: index.ts:47

Initial state of the browse-time Capture toggle in dev. Keep this off for normal browsing and let the HUD, capture-all flow, or ?xray-capture turn Capture on per tab. Default: false.


optional delay?: number

Defined in: index.ts:49

Settle delay in milliseconds before capturing a ready Skeleton; override one boundary with the delay prop. Default: 200.


optional hud?: boolean

Defined in: index.ts:41

Mount the dev HUD for coverage, Capture, Light Box, and capture-all controls. Default: false.


optional maxNodes?: number

Defined in: index.ts:53

Refuse captures larger than this many nodes (Skeleton too high in the tree). Default: 4000.


optional platesDir?: string

Defined in: index.ts:39

Directory where Plate JSON files are written and read, relative to the Vite root. Default: plates.


optional settleCap?: number

Defined in: index.ts:51

Upper bound in milliseconds on waiting for a busy subtree to go quiet before capturing anyway. Default: 5000.