Class Component

An interface that represents a Component.

Index

Constructors

Properties

description? latestVersion name properties? sourceId variant?

Accessors

Methods

findPropertyById findPropertyByName fromJSON

Constructors

constructor

new Component(
componentData: ComponentData,
variant?: ComponentVariant,
): Component
Parameters
- componentData: ComponentData
- Optionalvariant: ComponentVariant
Returns Component
- Defined in component.ts:75

Properties

`Optional`description

description?: string

Description of the component.

latestVersion

latestVersion: null | Version = null

Latest version of the component.

name

name: string

Name of the component.

`Optional`properties

properties?: ComponentProperty[]

Variant properties of the component.

sourceId

sourceId: string

Identifier from design tool.

`Optional`variant

variant?: ComponentVariant

Variant that the component is part of.

Accessors

`Static`ALLOWED_FIELDS

get ALLOWED_FIELDS(): string[]
Returns string[]
- Defined in component.ts:63

Methods

findPropertyById

findPropertyById(propertyId: string): undefined | ComponentProperty
Finds property by unique identifier
Parameters
- propertyId: string
  Unique identifier of the property
Returns undefined | ComponentProperty
The property or undefined if not found
- Defined in component.ts:123

findPropertyByName

findPropertyByName(name: string): undefined | ComponentProperty
Finds property by name
Parameters
- name: string
  Name of the property
Returns undefined | ComponentProperty
The property or undefined if not found
- Defined in component.ts:133

`Static`fromJSON

fromJSON(json: string): Component
Creates a Component instance from a JSON string
Parameters
- json: string
  JSON string representing a component
Returns Component
A new Component instance
- Defined in component.ts:113