Skip to main content

componentPropertyDefinitions

All component properties and their default values that exist on this component set. 'VARIANT' properties will also have a list of all variant options. 'BOOLEAN', 'TEXT', and 'INSTANCE_SWAP' properties will have their names suffixed by a unique identifier starting with '#', which is helpful for quickly distinguishing multiple component properties that have the same name in the Figma UI. The entire property name should be used for all Component property-related API methods and properties.

Signature

componentPropertyDefinitions: ComponentPropertyDefinitions [readonly]

Remarks

Component properties define the changeable aspects of a component by tying them to specific design properties. You can create component properties for any main component or component set, and apply them to nested layers of the component or variant.

See the Working with Component Properties guide for how to create properties and change their values in instances.