5.2 KiB
id, title, sidebar_label, sidebar_position, custom_edit_url
| id | title | sidebar_label | sidebar_position | custom_edit_url |
|---|---|---|---|---|
| fieldprops | Interface: FieldProps<T, CustomProps, S, Key> | FieldProps | 0 | null |
When building a custom field you need to create a React Element that takes this interface as props.
Type parameters
| Name | Type |
|---|---|
T |
T |
CustomProps |
CustomProps = any |
S |
S: EntitySchema<Key> = EntitySchema<any> |
Key |
Key: string = Extract<keyof S["properties"], string> |
Properties
CMSFormField
• CMSFormField: FunctionComponent<CMSFormFieldProps<S, Key>>
Builder in case this fields needs to build additional fields, e.g. arrays or maps
Defined in
autoFocus
• autoFocus: boolean
Should this field autofocus on mount
Defined in
context
• context: FormContext<S, Key>
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
dependsOnOtherProperties
• dependsOnOtherProperties: boolean
Flag to indicate if this field was built from a property that gets rendered conditionally
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
name
• name: string
Name of the property
Defined in
partOfArray
• partOfArray: boolean
Is this field part of an array
Defined in
property
• property: Property<T, any>
Property related to this field
Defined in
setValue
• setValue: (value: null | T, shouldValidate?: boolean) => void
Set value of field directly
Type declaration
▸ (value, shouldValidate?): void
Parameters
| Name | Type |
|---|---|
value |
null | T |
shouldValidate? |
boolean |
Returns
void
Defined in
showError
• showError: boolean
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
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 Firestore
Defined in
value
• value: T
Current value of this field