Skip to main content

Interface: CMSFormFieldProps<M>

In case you need to render a field bound to a Property inside your custom field you can call buildPropertyField with these props.

Type parameters

NameType
Mextends Object = any

Properties

autoFocus

โ€ข Optional autoFocus: boolean

Should the field take focus when rendered. When opening the popup view in table mode, it makes sense to put the focus on the only field rendered.

Defined in

models/fields.tsx:201


context

โ€ข context: FormContext<M>

The context where this field is being rendered. You get a context as a prop when creating a custom field.

Defined in

models/fields.tsx:174


disabled

โ€ข Optional disabled: boolean

Should this field be disabled

Defined in

models/fields.tsx:206


includeDescription

โ€ข Optional includeDescription: boolean

Should the description be included in this field

Defined in

models/fields.tsx:179


name

โ€ข name: string

The name of the property, such as age. You can use nested and array indexed such as address.street or people[3]

Defined in

models/fields.tsx:156


partOfArray

โ€ข Optional partOfArray: boolean

Is this field part of an array

Defined in

models/fields.tsx:195


property

โ€ข property: StringProperty | NumberProperty | BooleanProperty | TimestampProperty | GeopointProperty | ReferenceProperty<any> | ArrayProperty<any[], any> | MapProperty<any>

The CMS property you are binding this field to

Defined in

models/fields.tsx:161


shouldAlwaysRerender

โ€ข Optional shouldAlwaysRerender: boolean

This flag is used to avoid using Formik FastField internally, which prevents being updated from the values. Set this value to true if you are developing a custom field which value gets updated dynamically based on others.

Defined in

models/fields.tsx:214


tableMode

โ€ข Optional tableMode: boolean

Is this field being rendered in a table

Defined in

models/fields.tsx:190


underlyingValueHasChanged

โ€ข Optional underlyingValueHasChanged: boolean

Has the value of this property been updated in the database while this field is being edited

Defined in

models/fields.tsx:185