Skip to main content

Interface: Favourite

Extends FavouriteItem with ProductListItem properties to create a complete favorite representation for UI display.

This interface combines the saved favorite information with product catalog details, making it suitable for rendering in favorite lists and selection interfaces. It includes additional UI-specific properties for expandable list behavior.

The combined data reduces the need for separate lookups when displaying favorites, providing all the necessary information for both visual representation and interactive functionality.

Extends​

Properties​

categories?​

optional categories: string[]

List of category identifiers this product belongs to.

These identifiers can be used to filter and organize products in category-based navigation. Products may belong to multiple categories to improve discoverability.

Well-structured categorization is essential for helping users find products through browsing rather than searching.

Inherited from​

ProductListItem.categories

code​

code: string

Unique product variant code.

This code identifies the specific product variant and is often used in API calls and data lookups. The code typically follows a standardized format that may include manufacturer prefixes or category indicators.

In modular configurations, this code helps identify compatible components and ensures the correct product is loaded.

Inherited from​

ProductListItem.code

collectionType​

collectionType: "private" | "public"

Identifies the type of collection this item belongs to.

Typically indicates whether this is a public or private favorite, which affects its visibility to other users in the organization.

Inherited from​

FavouriteItem.collectionType

configurationCode?​

optional configurationCode: string

Configuration code for a standard product favorite.

For standard products, this code captures the selected options and configuration state. It will be undefined for modular scenes.

The configuration code allows the system to restore the exact set of option selections when the favorite is loaded.

Inherited from​

FavouriteItem.configurationCode

defaultCode?​

optional defaultCode: string

Default configuration code for this product.

If provided, this code represents the factory default or recommended configuration for the product. When a user selects this product with no specific configuration, this default will be applied automatically.

Setting an attractive and popular configuration as the default ensures a good first impression when users view the product.

Inherited from​

ProductListItem.defaultCode

description?​

optional description: Nullable<string>

Product description text.

A brief description of the product for display in listings and detail views. This should highlight key features and benefits to help users quickly understand the product's purpose.

A concise but informative description helps users determine if a product meets their needs without requiring detailed investigation.

Inherited from​

ProductListItem.description

doMatchAllSnaps?​

optional doMatchAllSnaps: boolean

When true, the product can be replaced while maintaining connections.

For modular products, this indicates that this product can be swapped with another compatible product while preserving all connections to child components. This enables "in-place" product substitution in complex assemblies.

This capability is particularly valuable in modular furniture or building systems where users may want to try different options without disrupting the entire arrangement.

Inherited from​

ProductListItem.doMatchAllSnaps

expanded​

expanded: boolean

Indicates whether this item is currently expanded in the UI.

When true, additional details or options for this favorite should be shown in expandable/collapsible UI components. This helps manage screen real estate in favorites listings.

favouriteCollectionId​

favouriteCollectionId: string

Unique identifier for this favorite.

This ID uniquely identifies the favorite item within the system and is used for operations like loading, updating, or deleting the favorite.

Inherited from​

FavouriteItem.favouriteCollectionId

favouriteCollectionName​

favouriteCollectionName: string

Name of the collection this item belongs to.

This identifies the organizational group under which this favorite is saved, helping users locate and manage related favorites together.

Inherited from​

FavouriteItem.favouriteCollectionName

freeMove?​

optional freeMove: boolean

When true, the product can be placed freely on the scene.

For modular products, this indicates that this product doesn't connect to snapping points and can be positioned anywhere on the scene. Free-moving products are not constrained by connection rules.

Free-moving products are ideal for accessories, decorative items, or standalone pieces that should be flexibly positioned.

Inherited from​

ProductListItem.freeMove

history​

history: History

Information about creation and last modification.

Tracks when this favorite was created and last updated, along with user identification for these actions. This audit trail helps track the evolution of saved configurations.

Inherited from​

FavouriteItem.history

hoverImage?​

optional hoverImage: ProductThumb

Hover state thumbnail image settings.

Defines the image to display when the user hovers over the product in listings, if different from the standard thumbnail. This can be used to show alternate angles or highlight key features.

Hover images can provide users with additional visual information without requiring them to click through to detailed product pages.

Inherited from​

ProductListItem.hoverImage

id?​

optional id: string

ID of the product.

Deprecated​

Use productId instead.

Inherited from​

ProductListItem.id

isDisabled?​

optional isDisabled: boolean

When true, the product is currently unavailable for selection.

Used to temporarily disable products without removing them from listings. Disabled products may be shown but cannot be selected, configured, or added to designs.

Disabling is useful for products that are temporarily out of stock, experiencing technical issues, or awaiting updates.

Inherited from​

ProductListItem.isDisabled

isModular?​

optional isModular: boolean

Indicates whether this is a modular product.

When true, this product is a modular product that supports complex scene composition with multiple components. Modular products require different handling in the configurator interface.

Modular products typically have a different workflow, allowing users to add multiple components and arrange them spatially, unlike standard products which have fixed structures with configurable options.

Inherited from​

ProductListItem.isModular

label​

label: string

Display name for the product.

This is the human-readable name shown in product listings, typically the marketing name that customers would recognize. It should be concise but descriptive, helping users quickly identify products.

For modular components, the label should clearly indicate the component type and key distinguishing features.

Inherited from​

ProductListItem.label

metadata?​

optional metadata: Metadata

Metadata for regular product favorites.

For standard product configurations, this contains information about the product such as name, brand, description, and thumbnail settings. This will be undefined for modular scenes.

Metadata helps provide context about the product in favorites listings without having to load the full product data.

Inherited from​

FavouriteItem.metadata

parentFavouriteCollectionId?​

optional parentFavouriteCollectionId: string

ID of the parent collection, if this belongs to a nested collection structure.

When collections support hierarchical organization, this property links to the parent collection, creating a folder-like structure for organizing favorites.

Inherited from​

FavouriteItem.parentFavouriteCollectionId

productId​

productId: string

ID of the product associated with this favorite.

For standard products, this identifies the base product that was configured. For modular products, this identifies the modular product container.

This ID is used to load the correct product when the favorite is selected, ensuring the saved configuration is applied to the right product.

Inherited from​

ProductListItem.productId

s3Path​

s3Path: string

Relative path to the thumbnail image for this favorite.

This path points to a visual representation of the saved configuration that can be displayed in favorites lists and selection interfaces.

Thumbnails are crucial for helping users visually identify saved configurations in a potentially large list of favorites.

Inherited from​

FavouriteItem.s3Path

sceneName?​

optional sceneName: string

Name of the modular scene.

For modular product scenes, this is the user-defined name of the saved layout, helping users identify specific arrangements or designs. This will be undefined for standard product configurations.

Descriptive scene names help users quickly identify complex layouts in a list of saved favorites.

Inherited from​

FavouriteItem.sceneName

searchString​

searchString: string

Combined string of all searchable product attributes.

This includes the product name, designer, brand, tags, and manufacturer, concatenated to facilitate text searching across multiple fields. A comprehensive searchString improves discovery when users search using various terms.

Including synonyms, common misspellings, or alternate descriptions in the searchString can improve search results without cluttering the display name.

Inherited from​

ProductListItem.searchString

shortCode?​

optional shortCode: string

Short code representing the modular scene layout.

For modular scenes, this code encapsulates the complete scene configuration including all component positions and settings. It can be used to restore the exact scene state when loading a favorite.

The short code serves as a compact representation of potentially complex scene data, making it efficient to store and transfer.

Inherited from​

FavouriteItem.shortCode

standardImage?​

optional standardImage: ProductThumb

Default thumbnail image settings.

Defines how the product's standard thumbnail should be displayed, including whether it's a static image or dynamically generated. The thumbnail is the primary visual representation in listings.

High-quality thumbnails are crucial for effective product discovery, as they provide the first visual impression for customers.

Inherited from​

ProductListItem.standardImage

status​

status: Status

Current status of the product.

Indicates whether the product is active (available for selection) or inactive (hidden from normal listings). This allows products to be temporarily removed from catalogs without deleting them.

Only products with ACTIVE status should normally be shown to end users, while INACTIVE products might still be visible in administrative interfaces.

Inherited from​

ProductListItem.status

title​

title: string

Display title for this favorite item.

This is typically derived from the product name or scene name and is used for display in the favorites interface. A clear title helps users quickly identify saved configurations in a list.

type​

type: FavouriteType

The type of favorite entry.

Distinguishes between standard product configurations ('PRODUCT') and modular scenes ('MODULAR'). This determines how the favorite is processed when loaded and what interface elements are relevant.

Inherited from​

FavouriteItem.type

zoomDisabled?​

optional zoomDisabled: boolean

When true, the thumbnail cannot be zoomed on hover.

This prevents the zoom effect that normally occurs when hovering over product thumbnails in listings. This may be desirable for simpler images or when zoom would not add value.

Disabling zoom is particularly useful for icon-like images or simple graphics where zooming doesn't reveal additional detail.

Inherited from​

ProductListItem.zoomDisabled