Interface UseThumbnailOptions

interface UseThumbnailOptions {
    enabled?: boolean;
    file: FileEntry;
    generators: ThumbnailGenerator[];
    getFileUrl: (file: FileEntry) => Promise<string>;
    maxDimension?: number;
}

Properties

enabled?: boolean

Gate generation on visibility. When false, the hook resolves from the cache but does not run any generator. Defaults to true.

The file to resolve a thumbnail for.

Generators tried in order; the first one whose canHandle returns true runs.

getFileUrl: (file: FileEntry) => Promise<string>

Resolve a fetch-able URL for the file (e.g. a presigned S3 URL).

maxDimension?: number

Longest edge of the generated thumbnail, in pixels. Defaults to 320.