componentVariant.md

ComponentVariant

Kind: global interface

• ComponentVariant
  • .name : String
  • .propertyDescriptors : Array<ComponentPropertyDescriptor>
  • .components : Array<Component>
  • .findPropertyDescriptorById(propertyId) ⇒ ComponentPropertyDescriptor
  • .findPropertyDescriptorByName(name) ⇒ ComponentPropertyDescriptor

componentVariant.name : String

Name of the component variants.

Kind: instance property of ComponentVariant

componentVariant.propertyDescriptors : Array<ComponentPropertyDescriptor>

Details of the properties that components in this variant can take.

Kind: instance property of ComponentVariant

componentVariant.components : Array<Component>

Components included in the variant.

Kind: instance property of ComponentVariant

compocomponentVariantnent.findPropertyDescriptorById(propertyId) ⇒ ComponentPropertyDescriptor?

Finds property descriptor by unique identifier.

Kind: instance method of ComponentVariant

Param	Type
propertyId	String

componentVariant.findPropertyDescriptorByName(name) ⇒ ComponentPropertyDescriptor?

Finds property descriptor by name.

Kind: instance method of ComponentVariant

Param	Type
name	String

ComponentPropertyDescriptor : Object

Kind: global typedef

Properties

Name	Type	Description
id	String	Unique identifier of the variant property.
name	String	Name of the variant property.
values	Array<String>	Possible values for the variant property.

Related models

• Component