Interface: FieldProps<T, CustomProps, M>
When building a custom field you need to create a React component that takes this interface as props.
Type parameters​
| Name | Type |
|---|---|
T | extends CMSType = CMSType |
CustomProps | any |
M | extends Record<string, any> = any |
Properties​
autoFocus​
• autoFocus: boolean
Should this field autofocus on mount
Defined in​
context​
• context: FormContext<M>
Additional values related to the state of the form or the entity
Defined in​
customProps​
• customProps: CustomProps
Additional properties set by the developer
Defined in​
disabled​
• disabled: boolean
Flag to indicate if this field should be disabled
Defined in​
error​
• error: any
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
Defined in​
includeDescription​
• includeDescription: boolean
Should this field include a description
Defined in​
initialValue​
• initialValue: undefined | T
Initial value of this field
Defined in​
isSubmitting​
• isSubmitting: boolean
Is the form currently submitting
Defined in​
partOfArray​
• partOfArray: boolean
Is this field part of an array
Defined in​
property​
• property: ResolvedProperty<T>
Property related to this field
Defined in​
propertyKey​
• propertyKey: string
Key of the property E.g. "user.name" for a property with path "user.name"
Defined in​
setFieldValue​
• setFieldValue: (propertyKey: string, value: null | CMSType, shouldValidate?: boolean) => void
Type declaration​
â–¸ (propertyKey, value, shouldValidate?): void
Set value of a different field directly
Parameters​
| Name | Type |
|---|---|
propertyKey | string |
value | null | CMSType |
shouldValidate? | boolean |
Returns​
void
Defined in​
setValue​
• setValue: (value: null | T, shouldValidate?: boolean) => void
Type declaration​
â–¸ (value, shouldValidate?): void
Set value of field directly
Parameters​
| Name | Type |
|---|---|
value | null | T |
shouldValidate? | boolean |
Returns​
void
Defined in​
showError​
• showError: boolean
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.
Defined in​
tableMode​
• tableMode: boolean
Is this field being rendered in the table
Defined in​
touched​
• touched: boolean
Has this field been touched
Defined in​
underlyingValueHasChanged​
• underlyingValueHasChanged: boolean
Flag to indicate that the underlying value has been updated in the datasource
Defined in​
value​
• value: T
Current value of this field