PropertyConfig
@firecms/core / PropertyConfig
Type Alias: PropertyConfig<T>
Section titled “Type Alias: PropertyConfig<T>”PropertyConfig<
T> =object
Defined in: types/property_config.tsx:9
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
Section titled “Type Parameters”T extends CMSType = any
Properties
Section titled “Properties”color?
Section titled “color?”
optionalcolor:string
Defined in: types/property_config.tsx:40
CSS color, used only in some plugins like the field selector. e.g. “#2d7ff9”
description?
Section titled “description?”
optionaldescription:string
Defined in: types/property_config.tsx:45
Description of this field type.
optionalIcon:React.ComponentType
Defined in: types/property_config.tsx:34
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.
key:
PropertyConfigId|string
Defined in: types/property_config.tsx:14
Key used to identify this property config.
name:
string
Defined in: types/property_config.tsx:20
Name of this field type. This is not the name of the property.
property
Section titled “property”property:
PropertyOrBuilder<T>
Defined in: types/property_config.tsx:27
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.
