Skip to main content
Version: 1.0.0

Interface: FieldConfig<T, CustomProps>

Configure how a field is displayed

Type parameters​

NameType
Textends CMSType
CustomPropsany

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:531


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:538


customProps​

• Optional customProps: CustomProps

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

Defined in​

models/properties.ts:544

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!