component.md

Component

Kind: global interface

• Component
  • .name : String
  • .sourceId : String
  • .description : String
  • .latestVersion : Version
  • .properties : Array<ComponentProperty>
  • .variant : ComponentVariant
  • .findPropertyById(propertyId) ⇒ ComponentProperty
  • .findPropertyByName(name) ⇒ ComponentProperty

See Version for properties of a component that change over time, like layers, image and so on.

component.name : String

Name of the component.

Kind: instance property of Component

component.sourceId : String

Identifier of the component in the source design document.

Kind: instance property of Component

component.description : String

Description of the component.

Kind: instance property of Component

component.latestVersion : Version

Latest version of the component.

Kind: instance property of Component

component.properties : Array<ComponentProperty>

Variant properties of the component.

Kind: instance property of Component

component.variant : ComponentVariant

Variant that the component is part of.

Kind: instance property of Component

component.findPropertyById(propertyId) ⇒ ComponentProperty?

Finds property by unique identifier.

Kind: instance method of Component

Param	Type
propertyId	String

component.findPropertyByName(name) ⇒ ComponentProperty?

Finds property by name.

Kind: instance method of Component

Param	Type
name	String

ComponentProperty : Object

Kind: global typedef

Properties

Name	Type	Description
id	String	Unique identifier of the variant property.
name	String	Name of the variant property.
value	String	Value for the variant property.

Related models

• Version
• ComponentVariant