Skip to main content

Type Alias: SaveFavouriteConfiguration()

SaveFavouriteConfiguration = (configurationCode, favouriteCollectionIds) => Promise<boolean>

Function

Saves the current product configuration as a favorite.

This method saves the current standard product configuration (with all selected options) to one or more favorite collections. It can be used to bookmark particularly useful or attractive configurations for later reference or to share configurations with colleagues.

If the configuration already exists in some collections but not in others, the method will intelligently update collection assignments, adding it to new collections and removing it from collections not included in the provided list.

Parameters​

configurationCode​

string

The configuration code representing all selected options

favouriteCollectionIds​

string[]

Array of collection IDs to save this configuration to

Returns​

Promise<boolean>

A promise that resolves to true if saving was successful, false otherwise

Example​

// Save the current configuration to two collections when the user clicks "Save"
document.getElementById('save-config-btn').addEventListener('click', async () => {
  // Get the current configuration code
  const configCode = window.mimeeqApp.observers.product.configurationCode.getValue().newValue;

  // Get the selected collection IDs from checkboxes
  const selectedCollections = Array.from(
    document.querySelectorAll('input[name="collections"]:checked')
  ).map(cb => cb.value);

  if (selectedCollections.length === 0) {
    alert('Please select at least one collection');
    return;
  }

  const success = await window.mimeeqApp.actions.saveFavouriteConfiguration(
    configCode,
    selectedCollections
  );

  if (success) {
    showNotification('Configuration saved to favorites');
  } else {
    showNotification('Failed to save configuration', 'error');
  }
});

Emits​

mimeeq-favourites-remove-product This event is fired when Product was removed from favourites

Emits​

mimeeq-favourites-add-product This event is fired when Product was added to favourites