PropertyFieldBindingProps

@firecms/core

---

@firecms/core / PropertyFieldBindingProps

Interface: PropertyFieldBindingProps<T, M>

Defined in: types/fields.tsx:188

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

T extends CMSType

M

M extends Record<string, any> = any

Properties

autoFocus?

optional autoFocus: boolean

Defined in: types/fields.tsx:233

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.

---

context

context: FormContext<M>

Defined in: types/fields.tsx:205

The context where this field is being rendered. You get a context as a prop when creating a custom field.

---

disabled?

optional disabled: boolean

Defined in: types/fields.tsx:238

Should this field be disabled

---

includeDescription?

optional includeDescription: boolean

Defined in: types/fields.tsx:210

Should the description be included in this field

---

index?

optional index: number

Defined in: types/fields.tsx:244

Index of the field in the array. Only used when the field is part of an array.

---

minimalistView?

optional minimalistView: boolean

Defined in: types/fields.tsx:227

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:258

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:221

Is this field part of an array

---

property

property: PropertyOrBuilder<T> | ResolvedProperty<T>

Defined in: types/fields.tsx:199

The CMS property you are binding this field to

---

propertyKey

propertyKey: string

Defined in: types/fields.tsx:194

The key/path of the property, such as age. You can use nested and array indexed such as address.street or people[3]

---

size?

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

Defined in: types/fields.tsx:249

The size of the field

---

underlyingValueHasChanged?

optional underlyingValueHasChanged: boolean

Defined in: types/fields.tsx:216

Has the value of this property been updated in the database while this field is being edited