TsxOverlayConfig
TsxOverlayConfig =
OverlayCommon&NoInlineContent&object
Defined in: asset.ts:208
A full React page overlay: path ends in .tsx. The module default-exports
a React component that screenci bundles (with Vite, an optional peer
dependency) and renders CLIENT-SIDE in the browser during capture, so the
full React runtime runs: function components with hooks and effects, class
components with lifecycle and state, inline styles, and className. With
animate: true the mounted app is advanced by the deterministic virtual clock
that samples each frame, so effect timers / requestAnimationFrame / state
updates drive the captured frames reproducibly.
props are passed to the component; they must be JSON-serializable.
Type Declaration
Section titled “Type Declaration”path:
`${string}.tsx`
Path to a .tsx module that default-exports a React component, resolved relative to the recording file.
props?
Section titled “props?”
optionalprops?:Record<string,unknown>
Serializable props passed to the component.