Skip to main content

Interface: FieldConfig<T, CustomProps>

Configure how a field is displayed

Type parameters#

NameType
TT: CMSType
CustomPropsCustomProps = any

Hierarchy#

Properties#

Field#

Optional Field: ComponentType<FieldProps<T, CustomProps, any>>

If you need to render a custom field, you can create a component that takes FieldProps as 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.

Defined in#

models/properties.ts:522


Preview#

Optional Preview: ComponentType<PreviewComponentProps<T, CustomProps>>

Configure 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.

Defined in#

models/properties.ts:529


customProps#

Optional customProps: CustomProps

Additional props that are passed to the components defined in field or in preview.

Defined in#

models/properties.ts:535