Skip to content

PreviewProvider

Since Plugin API: 1.0.0

Preview provider - renders File previews and fullscreen views

Signature

interface PreviewProvider {
type: "preview";
id: string;
name: string;
priority?: number;
extensions?: string[];
mimeTypes?: string[];
categories?: FileCategory[];
canHandle?: (file: FileEntry, api: FileMatchAPI) => boolean;
surface?: import("svelte").Component<PreviewSurfaceProps>;
createSession?: (props: PreviewSessionFactoryProps) => PreviewSession | Promise<PreviewSession>;
toolbar?: import("svelte").Component<PreviewToolbarContributionProps>;
destinations?: PreviewDestinationCapabilities;
overridesDoubleClick?: boolean;
isEditable?: (file: FileEntry, metadata?: FileMetadata) => boolean;
}

Members

Name Type Required Description
type "preview" yes -
id string yes -
name string yes -
priority number no -
extensions string[] no File matching criteria
mimeTypes string[] no -
categories FileCategory[] no -
canHandle (file: FileEntry, api: FileMatchAPI) => boolean no -
surface import("svelte").Component<PreviewSurfaceProps> no Responsive file-specific viewer/editor used by every host destination.
createSession (props: PreviewSessionFactoryProps) => PreviewSession &#124; Promise<PreviewSession> no -
toolbar import("svelte").Component<PreviewToolbarContributionProps> no Single reactive provider control group mounted at the host toolbar’s trailing edge.
destinations PreviewDestinationCapabilities no -
overridesDoubleClick boolean no Behavior
isEditable (file: FileEntry, metadata?: FileMetadata) => boolean no Preview can modify file contents; the host exposes editor chrome only when this returns true.

This article includes AI-assisted content.

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