Interface: PropertyFieldBindingProps<T, M>
In case you need to render a field bound to a Property inside your custom field you can use PropertyFieldBinding with these props.
Type Parameters​
• T extends CMSType
• M extends Record
<string
, any
> = 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​
packages/firecms_core/src/types/fields.tsx:218
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​
packages/firecms_core/src/types/fields.tsx:191
disabled?​
optional
disabled:boolean
Should this field be disabled
Defined in​
packages/firecms_core/src/types/fields.tsx:223
includeDescription?​
optional
includeDescription:boolean
Should the description be included in this field
Defined in​
packages/firecms_core/src/types/fields.tsx:196
index?​
optional
index:number
Index of the field in the array. Only used when the field is part of an array.
Defined in​
packages/firecms_core/src/types/fields.tsx:229
minimalistView?​
optional
minimalistView:boolean
Is this field part of a block (oneOf array)
Defined in​
packages/firecms_core/src/types/fields.tsx:212
onPropertyChange()?​
optional
onPropertyChange: (property
) =>void
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
Defined in​
packages/firecms_core/src/types/fields.tsx:243
partOfArray?​
optional
partOfArray:boolean
Is this field part of an array
Defined in​
packages/firecms_core/src/types/fields.tsx:207
property​
property:
PropertyOrBuilder
<T
> |ResolvedProperty
<T
>
The CMS property you are binding this field to
Defined in​
packages/firecms_core/src/types/fields.tsx:185
propertyKey​
propertyKey:
string
The key/path of the property, such as age
. You can use nested and array
indexed such as address.street
or people[3]
Defined in​
packages/firecms_core/src/types/fields.tsx:180
size?​
optional
size:"small"
|"medium"
|"large"
The size of the field
Defined in​
packages/firecms_core/src/types/fields.tsx:234
underlyingValueHasChanged?​
optional
underlyingValueHasChanged:boolean
Has the value of this property been updated in the database while this field is being edited