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
MM: 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:200


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


dependsOnOtherProperties#

Optional dependsOnOtherProperties: 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:213


disabled#

Optional disabled: boolean

Should this field be disabled

Defined in#

models/fields.tsx:205


includeDescription#

Optional includeDescription: boolean

Should the description be included in this field

Defined in#

models/fields.tsx:178


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


partOfArray#

Optional partOfArray: boolean

Is this field part of an array

Defined in#

models/fields.tsx:194


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


tableMode#

Optional tableMode: boolean

Is this field being rendered in a table

Defined in#

models/fields.tsx:189


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