Skip to main content

ComponentProperties

type ComponentProperties = {
[propertyName: string]: {
type: ComponentPropertyType
value: string | boolean
preferredValues?: InstanceSwapPreferredValue[]
readonly boundVariables?: {
[field in VariableBindableComponentPropertyField]?: VariableAlias
}
}
}

type VariableBindableComponentPropertyField = "value"

A map of component properties that exist on an instance node. Each property in the map must have a type matching ComponentPropertyType. A component property can optionally be bound to a Variable, in which case the boundVariables structure will be populated with a VariableAlias describing the variable controlling this property.