Interface: ImageWidgetBlock
Represents a block that supports image uploads in the configurator.
This interface defines the structure of a configuration block that allows users to upload and apply images to their product. These blocks can represent areas for logos, custom graphics, or material textures on the product.
Properties
accept?
optionalaccept:string[]
List of file extensions that are accepted for upload.
This array defines which file types users can upload to this block, typically including image formats like "jpg", "png", "svg".
blockName
blockName:
string
Display name of the block.
This name appears in the user interface and helps users understand which part of the product the image will be applied to.
id
id:
string
Unique identifier for the block.
This ID is used to target operations specifically to this block, such as applying selected images.
printOnDemandSettings?
optionalprintOnDemandSettings:PrintOnDemandOption
Additional settings for print-on-demand functionality.
When present, this block supports advanced print-on-demand capabilities like image positioning, sizing, and multiple layer compositing.
textureMode
textureMode:
boolean
Whether the uploaded image should be treated as a texture.
When true, the image will be applied as a repeating texture that
covers the entire material surface. When false, the image will be
treated as a logo or decal that maintains its aspect ratio.
Texture mode is typically used for materials like fabrics or wood grain, while non-texture mode is used for logos or custom graphics.
widgetType?
optionalwidgetType:string
The type of widget used to render this block.
For image blocks, this will typically be "image" or "printOnDemand" depending on the specific capabilities required.