Skip to content

PreviewAPI

Since Plugin API: 1.0.0

Preview API - extended API for preview providers

extends PluginAPI

Signature

interface PreviewAPI extends PluginAPI {
getMetadata(file: FileEntry): Promise<FileMetadata>;
openFullscreen(file: FileEntry): void;
navigateTo(path: string): void;
}

Members

Name Type Required Description
getMetadata (file: FileEntry) => Promise<FileMetadata> yes Get metadata for a file
openFullscreen (file: FileEntry) => void yes Open fullscreen preview for a file
navigateTo (path: string) => void yes Navigate to a path

This article includes AI-assisted content.

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