Skip to content

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 -

This article includes AI-assisted content.

Documentation is licensed under CC BY 4.0. Phoundry names and marks remain reserved.