Type Alias: GetProductLightboxImages()

GetProductLightboxImages = (backgroundColor?) => Promise<LightboxItem[]>

Function

Retrieves high-quality images of the current product configuration for lightbox display.

This method fetches optimized, high-resolution images of the product from all available 2D views, formatted specifically for use in lightbox or modal gallery interfaces. The images represent the current product configuration and can be customized with different background colors.

Lightbox images are ideal for providing detailed product visualization when users want to examine a product closely, offering larger and higher quality views than standard thumbnails or carousel images.

Parameters

backgroundColor?

string

Optional background color for the images (uses theme default if not provided)

Returns

Promise<LightboxItem[]>

A promise resolving to an array of lightbox-ready image objects with URLs and metadata

Example

// Get lightbox images for the current product configuration
const lightboxImages = await window.mimeeqApp.actions.getProductLightboxImages();

// Display images in a lightbox gallery with custom background
const customLightboxImages = await window.mimeeqApp.actions.getProductLightboxImages('#f5f5f5');

// Integrate with a lightbox library
lightboxImages.forEach(image => {
  lightbox.addImage({
    src: image.href || image.large,
    thumb: image.large,
    caption: product.metadata.displayName,
    downloadUrl: image.original,
    downloadFilename: image.filename
  });
});