Skip to main content

Interface: RelatedItem

Represents a basic related product item with essential information.

This interface defines the core information about a related product, including identifiers, naming, configuration details, and metadata needed for displaying and navigating to the product. This is the foundation for displaying related products in carousels, suggestion panels, or cross-sell sections.

Extended by​

Properties​

code​

code: string

Product code/prefix used in variant codes.

This code forms the prefix part of the complete variant code when combined with a configuration code. It identifies the base product in the system.

defaultConfigurationCode?​

optional defaultConfigurationCode: string

Default configuration code for this product.

When a related product is opened with no specific configuration, this default code is applied to show a recommended setup. This ensures related products always open with an appropriate initial configuration.

description​

description: string

Product description text.

A concise description of the related product that helps users understand its purpose and key features without needing to navigate to the full product page.

hoverImageMeta?​

optional hoverImageMeta: ProductThumb

Thumbnail image settings for hover state.

These settings define an alternative image to show when users hover over the related product, typically showing a different angle or highlighting key features.

imageMeta?​

optional imageMeta: ProductThumb

Thumbnail image settings for the related product.

These settings define how the product thumbnail should be generated or sourced, including whether it's a static image or dynamically rendered based on configuration.

isActive​

isActive: boolean

Indicates whether this product is currently active.

When true, the product is available for configuration and purchase. Inactive products may be shown in related listings but marked as unavailable or coming soon.

isModular​

isModular: boolean

Indicates whether this is a modular product.

When true, this product supports complex scene composition with multiple components rather than simple configuration. This affects how the product is opened and rendered.

mappings?​

optional mappings: Record<string, RelatedMapping>

Configuration mappings between the current product and this related product.

These mappings define how options selected in the current product (like finishes or colors) should be translated to compatible options in the related product, ensuring visual consistency when navigating between them.

name​

name: string

Display name of the related product.

This is the human-readable name shown to users in related product listings, typically the marketing name that customers would recognize.

productId​

productId: string

Unique identifier for the related product.

This ID is used to fetch additional product details and to navigate to the product when selected.