FieldProps

@firecms/core

---

@firecms/core / FieldProps

Interface: FieldProps<T, CustomProps, M>

Defined in: types/fields.tsx:12

When building a custom field you need to create a React component that takes this interface as props.

Type Parameters

T

T extends CMSType = any

CustomProps

CustomProps = any

M

M extends Record<string, any> = any

Properties

autoFocus?

optional autoFocus: boolean

Defined in: types/fields.tsx:93

Should this field autofocus on mount

---

context

context: FormContext<M>

Defined in: types/fields.tsx:103

Additional values related to the state of the form or the entity

---

customProps

customProps: CustomProps

Defined in: types/fields.tsx:98

Additional properties set by the developer

---

disabled?

optional disabled: boolean

Defined in: types/fields.tsx:108

Flag to indicate if this field should be disabled

---

error?

optional error: any

Defined in: types/fields.tsx:56

Is there an error in this field. The error field has the same shape as the field, replacing values with a string containing the error. It takes the value null if there is no error

---

includeDescription?

optional includeDescription: boolean

Defined in: types/fields.tsx:71

Should this field include a description

---

isSubmitting?

optional isSubmitting: boolean

Defined in: types/fields.tsx:41

Is the form currently submitting

---

minimalistView?

optional minimalistView: boolean

Defined in: types/fields.tsx:88

Display the child properties directly, without being wrapped in an extendable panel. Note that this will also hide the title of this property.

---

onPropertyChange()?

optional onPropertyChange: (property) => void

Defined in: types/fields.tsx:122

Some properties might change internal state (like expanding a panel). This function should be called when the internal state changes. This is used to preserve state in array containers.

Parameters

property

Partial<ArrayProperty<any, any> | MapProperty<any> | AnyProperty>

Returns

void

---

partOfArray?

optional partOfArray: boolean

Defined in: types/fields.tsx:82

Is this field part of an array

---

property

property: Property<T> | ResolvedProperty<T>

Defined in: types/fields.tsx:66

Property related to this field

---

propertyKey

propertyKey: string

Defined in: types/fields.tsx:18

Key of the property E.g. “user.name” for a property with path “user.name”

---

setFieldValue()

setFieldValue: (propertyKey, value, shouldValidate?) => void

Defined in: types/fields.tsx:36

Set value of a different field directly

Parameters

propertyKey

string

value

CMSType | null

shouldValidate?

boolean

Returns

void

---

setValue()

setValue: (value, shouldValidate?) => void

Defined in: types/fields.tsx:28

Set value of field directly

Parameters

value

T | null

shouldValidate?

boolean

Returns

void

---

showError?

optional showError: boolean

Defined in: types/fields.tsx:49

Should this field show the error indicator. Note that there might be an error (like an empty field that should be filled) but we don’t want to show the error until the user has tried saving.

---

size?

optional size: "small" | "medium" | "large"

Defined in: types/fields.tsx:113

Size of the field

---

touched?

optional touched: boolean

Defined in: types/fields.tsx:61

Has this field been touched

---

underlyingValueHasChanged?

optional underlyingValueHasChanged: boolean

Defined in: types/fields.tsx:77

Flag to indicate that the underlying value has been updated in the datasource

---

value

value: T

Defined in: types/fields.tsx:23

Current value of this field