ObjectField ​

ObjectField model returned by createObjectField.

Since ObjectField inherits from Field, most APIs are covered by the Field model. This document only covers the extended methods.

Methods ​

addProperty ​

Description ​

Adds a property to the object and triggers onInput.

Signature ​

interface addProperty {
  (key: string, value: any): Promise<void>
}

removeProperty ​

Description ​

Removes a property from the object and triggers onInput.

Signature ​

interface removeProperty {
  (key: string): Promise<void>
}

existProperty ​

Description ​

Checks whether a property exists.

Signature ​

interface existProperty {
  (key: string): boolean
}

Types ​

IObjectFieldState ​

Main properties follow IFieldState, with the value type required to be an object.

type IObjectFieldState = IFieldState<any, any, any, Record<string, any>>