AI Notice: Most documentation right now was auto-generated by an LLM. Handwritten documentation will be implemented over time on the road to 1.0
PreviewAPI
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 |