Skip to main content

Interface: FilterOption

Represents a selectable option value within a filter category.

Filter options are the individual selectable values within a filter category. In the typical two-level structure, these represent the actual choices users can make, such as specific colors, materials, or styles.

Well-organized filter options make the configuration process more intuitive by grouping related choices together under logical categories.

Properties​

active?​

optional active: boolean

Indicates whether this option is currently active/selected.

When true, this option is currently selected and contributes to the active configuration. The active state determines whether this specific value is applied to the configured product.

amount?​

optional amount: number

Optional count of compatible configurations with this option.

When specified, this indicates how many other options or configurations are compatible with this selection. Displaying this count helps users understand the impact of selecting this option on their available choices.

color?​

optional color: string

Optional color identifier associated with this option.

When specified, this color is used for visual indicators related to the option in the interface, such as swatches or highlighting. This is particularly useful for color-related options where the visual representation is the primary identifier.

hideInUi?​

optional hideInUi: boolean

Controls visibility in the filter interface.

When true, this option will not be displayed in the filter selection UI even though it may be valid for configuration. Hidden options typically represent special cases, deprecated values, or options reserved for specific scenarios.

id​

id: string

Unique identifier for this filter option.

This ID uniquely identifies the option throughout the system and is used for state management, selection tracking, and mapping to actual parameter values.

name?​

optional name: string

Display name for this filter option.

This is the human-readable label shown to users in the filter interface, such as "Red," "Oak," or "Matte." It should clearly describe the specific value this option represents to help users make appropriate selections.

Deprecated​

parentId?​

optional parentId: string

Parent filter id

thumbnail?​

optional thumbnail: string

Option image thumbnail associated with this filter.

When specified, this thumbnail is used for visual indicators related to the filter in the interface, such as category headers or selection highlights.

title​

title: string

Display name for this filter option.

This is the human-readable label shown to users in the filter interface, such as "Red," "Oak," or "Matte." It should clearly describe the specific value this option represents to help users make appropriate selections.