AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

PreviewSurfaceProps

Since Plugin API: 1.0.0

Signature

interface PreviewSurfaceProps {
    file: FileEntry;
    api: PreviewAPI;
    session?: PreviewSession;
    destination?: PreviewDestination;
    focusEditor?: boolean;
    onConsumeFocusEditor?: () => void;
}

Members

Name	Type	Required	Description
`file`	`FileEntry`	yes	-
`api`	`PreviewAPI`	yes	-
`session`	`PreviewSession`	no	-
`destination`	`PreviewDestination`	no	Host destination; `embed` requires inspection-only behavior.
`focusEditor`	`boolean`	no	One-shot focus request; does not describe the host destination.
`onConsumeFocusEditor`	`() => void`	no	-