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​
Name | Type |
---|---|
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​
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​
disabled​
• Optional
disabled: boolean
Should this field be disabled
Defined in​
includeDescription​
• Optional
includeDescription: boolean
Should the description be included in this field
Defined in​
partOfArray​
• Optional
partOfArray: boolean
Is this field part of an array
Defined in​
property​
• property: PropertyOrBuilder
<T
> | ResolvedProperty
<T
>
The CMS property you are binding this field to
Defined in​
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​
tableMode​
• Optional
tableMode: boolean
Is this field being rendered in a table
Defined in​
underlyingValueHasChanged​
• Optional
underlyingValueHasChanged: boolean
Has the value of this property been updated in the database while this field is being edited