Type Alias: CreateFavouriteCollection()

CreateFavouriteCollection = (favouriteCollectionName, collectionType) => Promise<boolean | string>

Function

Creates a new collection for organizing saved favorites.

This method allows users to create a new organizational folder for storing their saved product configurations and modular scenes. Collections help users categorize their favorites based on projects, clients, themes, or any other grouping that makes sense for their workflow.

Collections can be either private (visible only to the user) or public (visible to all users within the organization), providing flexibility for both personal use and team collaboration.

Parameters

favouriteCollectionName

string

Display name for the new collection

collectionType

Whether the collection is 'private' (visible only to the creator) or 'public' (visible to all users)

"private" | "public"

Returns

Promise<boolean | string>

If successful, returns the new collection's ID as a string; if unsuccessful, returns false or true (boolean)

Example

// Create a new private collection for a specific project
const newCollectionId = await window.mimeeqApp.actions.createFavouriteCollection(
  'Spring 2025 Collection',  // Collection name
  'private'                  // Visibility type
);

if (newCollectionId && typeof newCollectionId === 'string') {
  console.log(`New collection created with ID: ${newCollectionId}`);

  // Save the current configuration to this new collection
  const configCode = window.mimeeqApp.observers.product.configurationCode.getValue().newValue;
  window.mimeeqApp.actions.saveFavouriteConfiguration(configCode, [newCollectionId]);
}

Emits

mimeeq-favourites-add-collection When a new collection is successfully created