components.[component-name].properties |
Array <Object> |
An array of objects that includes all the properties
of the component and all relevant information about
those properties. |
components.[component-name].properties[].name |
String |
Name of the property in your component's
code. |
components.[component-name].properties[].label |
String |
Display name of the property to display in UI Builder, if applicable. |
components.[component-name].properties[].description |
String |
A short description of what the property does or how
to use it. |
components.[component-name].properties[].readOnly |
Boolean |
When true, prevents a user from configuring the
property in UI Builder. Default: false. |
components.[component-name].properties[].required |
Boolean |
When true, the user must configure the property.
Default: false. |
components.[component-name].properties[].defaultValue |
String |
The default value when the user does not provide
one. |
components.[component-name].properties[].associatedTypes |
Array |
Describes where in the UI Builder toolbox the
component appears. Value must be
"global.core" . |
components.[component-name].properties[].typeMetadata |
Object |
Extra configuration data that some data types
require, such as reference properties and choice
lists. |