ComponentPropertyDefinitions
type ComponentPropertyDefinitions = {
[propertyName: string]: {
type: ComponentPropertyType
defaultValue: string | boolean
variantOptions?: string[]
preferredValues?: InstanceSwapPreferredValue[]
readonly boundVariables?: {
[field in VariableBindableComponentPropertyDefinitionField]?: VariableAlias
}
}
}
type VariableBindableComponentPropertyDefinitionField = "defaultValue"
A map of component property definitions that exist on a component or component set node. Each definition in the map must have a type matching ComponentPropertyType
. defaultValue
represents the value that instances will initially have for that property. 'VARIANT'
properties also have variantOptions
, a list of possible values for that variant property. 'INSTANCE_SWAP'
properties may optionally have a list of InstanceSwapPreferredValue
s. 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.