Type Alias: PropertyConfig<T>
PropertyConfig<
T
>:object
This is the configuration object for a property. These configs are generated by default for the properties defined in your collections' configuration, but you can define your own to be used.
Type Parameters​
• T extends CMSType
= any
Type declaration​
Icon?​
optional
Icon:React.ComponentType
Optional icon to be used in the field selector. Use a 24x24 component, in order not to break the layout. Any FireCMS icon can be used.
color?​
optional
color:string
CSS color, used only in some plugins like the field selector. e.g. "#2d7ff9"
description?​
optional
description:string
Description of this field type.
key​
key:
PropertyConfigId
|string
Key used to identify this property config.
name​
name:
string
Name of this field type. This is not the name of the property.
property​
property:
PropertyOrBuilder
<T
>
Default config for the property. This property or builder will be used as the base values for the resulting property. You can also use a builder function to generate the base property.