Function useViewerImporter

useViewerImporter<I extends string>(
    viewer: ViewerRef,
    input: I,
    options: ImportAssetOptions,
    onImport?: (obj: undefined | (undefined | ImportResult)[]) => void,
    onProgress?: (event: ProgressEvent<EventTarget>) => void,
): undefined | (undefined | ImportResult)[]
Synchronously loads and caches assets with a viewer asset importer.

Note: this hook's caller must be wrapped with React.Suspense
Type Parameters
- I extends string
Parameters
- viewer: ViewerRef
- input: I
- options: ImportAssetOptions
- OptionalonImport: (obj: undefined | (undefined | ImportResult)[]) => void
- OptionalonProgress: (event: ProgressEvent<EventTarget>) => void
Returns undefined | (undefined | ImportResult)[]
- Defined in useViewerImporter.tsx:26

Index

Methods

Methods

clear

clear<I extends string>(input: I): void
Removes a loaded asset from cache.
Type Parameters
- I extends string
Parameters
- input: I
Returns void
- Defined in useViewerImporter.tsx:54

preload

preload<I extends string>(
    viewer: ViewerRef,
    input: I,
    options: ImportAssetOptions,
    onImport: (obj: undefined | (undefined | ImportResult)[]) => void,
): void
Preloads an asset into cache as a side-effect.
Type Parameters
- I extends string
Parameters
- viewer: ViewerRef
- input: I
- options: ImportAssetOptions
- onImport: (obj: undefined | (undefined | ImportResult)[]) => void
Returns void
- Defined in useViewerImporter.tsx:42