Skip to main content

Interface: UseClusterConfiguratorReturn

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

Selection state and actions returned by useClusterConfigurator.

Properties​

handleAttributeSelect​

handleAttributeSelect: (settingName, value) => void

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

Selects a value for a setting and cascades defaults onto later settings.

Parameters​

settingName​

string

value​

string

Returns​

void


initFromProduct​

initFromProduct: (product) => void

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

Seeds the selection from an existing product's attribute values.

Parameters​

product​

Product

Returns​

void


reset​

reset: () => void

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

Clears all selections.

Returns​

void


selectedAttributes​

selectedAttributes: Record<string, string>

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

Map of setting name to currently selected value.


settingsWithValues​

settingsWithValues: ConfiguredSetting[]

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

The cluster settings resolved with available values and disabled state.