Skip to main content

Interface: ConfiguredSetting

Defined in: composables/react/useClusterConfigurator.ts:16

A cluster-config setting resolved against the current product set and selections.

Properties

attributeType?

optional attributeType?: string

Defined in: composables/react/useClusterConfigurator.ts:31

Source-of-truth attribute type from the underlying attributeDescription.type (e.g. COLOR, TEXT, INT). PIMs sometimes configure a setting with displayType: 'COLOR' even though the attribute holds plain text — the configurator uses this field to decide whether a value is actually a colour (render swatch) or just a label (render chip). undefined when no product carries the attribute yet.


availableValues

availableValues: string[]

Defined in: composables/react/useClusterConfigurator.ts:37

Attribute values still selectable given prior selections.


disabled

disabled: boolean

Defined in: composables/react/useClusterConfigurator.ts:41

true when no values are available or a preceding setting is unselected.


displayName

displayName: string

Defined in: composables/react/useClusterConfigurator.ts:35

Localized, human-readable label for the setting.


displayType

displayType: string

Defined in: composables/react/useClusterConfigurator.ts:22

Display widget hint (e.g. dropdown, swatch).


id

id: number

Defined in: composables/react/useClusterConfigurator.ts:18

Setting id from the cluster config.


name

name: string

Defined in: composables/react/useClusterConfigurator.ts:20

Raw attribute name this setting selects on.


priority

priority: string

Defined in: composables/react/useClusterConfigurator.ts:33

Sort priority — settings render in ascending order.


selectedValue

selectedValue: string

Defined in: composables/react/useClusterConfigurator.ts:39

Currently selected value, or ''.