Type Alias: GetTabGallery()

GetTabGallery = (galleryId) => Promise<Nullable<GalleryTabResponse>>

Function

Retrieves image gallery data for display in a product tab.

This method fetches and processes a gallery of images associated with a product, preparing them for display in the configurator interface. Galleries typically showcase product lifestyle images, detail shots, installation examples, or inspirational content.

The returned data includes both the gallery layout structure (number of columns) and the complete set of prepared images with appropriate sizes and formats for different display contexts.

Parameters

galleryId

string

Unique identifier for the gallery to retrieve

Returns

Promise<Nullable<GalleryTabResponse>>

A promise resolving to a gallery data object, or null if the gallery cannot be found

Example

// Fetch and display a product image gallery
const galleryTab = productTabs.find(tab => tab.tabType === 'GALLERY');
const galleryData = await window.mimeeqApp.actions.getTabGallery(galleryTab.galleryId);

if (galleryData) {
  // Set up the gallery container with the correct column layout
  const gallery = document.getElementById('product-gallery');
  gallery.style.gridTemplateColumns = `repeat(${galleryData.columns}, 1fr)`;

  // Add each gallery item
  galleryData.items.forEach(item => {
    const galleryItem = document.createElement('div');
    galleryItem.className = 'gallery-item';

    // Create appropriate element based on media type
    if (item.isVideo) {
      // Handle video items
      galleryItem.innerHTML = `<video src="${item.original}" controls></video>`;
    } else {
      // Handle image items with lightbox functionality
      galleryItem.innerHTML = `
        <img src="${item.small}" data-large="${item.large}" alt="${item.caption}">
        <div class="caption">${item.caption}</div>
      `;
    }

    gallery.appendChild(galleryItem);
  });
}