Type Alias: ImageWidgetAddNewImages()

ImageWidgetAddNewImages = (files, blockId?) => Promise<PrintOnDemandImage | false>

Function

Function signature for adding new images to the image library and optionally applying them.

This function handles the complete process of uploading images to the library, including file processing, storage, and metadata extraction. If a block ID is provided, the image will be immediately applied to that block after upload.

The function supports different image processing based on the widget type, such as treating images as textures for material blocks or as logos for image blocks.

Parameters

files

FileList

An array of file objects to upload (typically from a file input)

blockId?

string

Optional ID of the block to apply the first uploaded image to

Returns

Promise<PrintOnDemandImage | false>

Promise resolving to the created image entry or false if upload failed

Example

// Upload an image and apply it to a specific block
imageWidgetAddNewImages([fileObject], 'logo-block-id');