Each property in the CMS has its own API, but they all share some common props:
dataTypeDatatype of the property. (e.g.
nameProperty name (e.g. Price).
longDescriptionLonger description of a field, displayed under a popover.
columnWidthWidth in pixels of this column in the collection view. If not set, the width is inferred based on the other configurations.
readOnlyIs this a read only property. When set to true, it gets rendered as a preview.
disabledIs this field disabled. When set to true, it gets rendered as a disabled field. You can also specify a configuration for defining the behaviour of disabled properties (including custom messages, clear value on disabled or hide the field completely) PropertyDisabledConfig
FieldIf you need to render a custom field, you can create a component that takes
FieldPropsas props. You receive the value, a function to update the value and additional utility props such as if there is an error. You can customize it by passing custom props that are received in the component. More details about how to implement custom fields
PreviewConfigure how a property is displayed as a preview, e.g. in the collection view. You can customize it by passing custom props that are received in the component. More details about how to implement custom previews
customPropsAdditional props that are passed to the components defined in
defaultValueThis value will be set by default for new entities.