BaseField

Type parameters

  • T

Hierarchy

Index

Properties

Properties

Optional defaultValue

defaultValue: T

Default value for field.

Optional displayName

displayName: undefined | string

The display name for this field shown to the user when validation fails. This should be human readable.

default

If no display name is given the key is used

key

key: string

Field key. This key will be the location in customData that the field's data will be written to when the form has been submitted.

See form for more details.

type

type: keyof object

Field data type.

Optional validation

validation: Record<string, any>

Validation rules used to validate user input.