Skip to main content

Interface: GalleryEntry

Represents a single item in a product gallery.

This interface defines a media item (image or video) that appears in a gallery tab within the product configurator. Each entry includes multiple size variations for responsive display, as well as metadata about the content type and original source.

Gallery entries provide visual context beyond the configurator itself, showing products in real environments, highlighting specific features, or demonstrating usage.

Properties​

autoplay?​

optional autoplay: boolean

Indicates whether the video should start playing automatically.

When true, videos will begin playback without requiring the user to press play, typically with sound muted.

caption?​

optional caption: string

Optional descriptive caption for the item.

This text provides context or explanation for the visual content, helping users understand what they're seeing.

filename​

filename: string

Original file name (only available for non-external videos).

For internally hosted media, this preserves the original file name which may contain useful identifying information.

isIframe​

isIframe: boolean

Indicates whether this video is embedded from an external service.

When true, this video comes from an external provider like YouTube or Vimeo and should be displayed in an iframe player.

isVideo​

isVideo: boolean

Indicates whether this gallery item is a video.

When true, this item should be displayed as a video with playback controls rather than as a static image.

large​

large: string

URL to the large high-resolution image (2000px width).

This high-quality version is used for detailed viewing, zooming, fullscreen displays, and high-DPI screens.

loop?​

optional loop: boolean

Indicates whether the video should play in a continuous loop.

When true, videos will automatically restart from the beginning after reaching the end, creating a seamless loop.

medium​

medium: string

URL to the medium-sized image (1200px width).

This mid-size version balances quality and performance for standard desktop viewing experiences.

original​

original: string

Path to the original unmodified item.

This references the source file before any resizing or optimization, useful for maximum quality downloads or processing.

small​

small: string

URL to the small thumbnail image (425px width).

This smaller version is used for gallery thumbnails, previews, and mobile views where bandwidth and screen space are limited.