Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StringField<W>

String field within a form.

Type parameters

Hierarchy

Index

Properties

Properties

key

key: string

The property key that this field value will appear in the returned form object.

Optional label

label: string

Input label.

type

type: "string"

Field data type.

Optional validation

validation: Partial<{ length: ValidationEntry<number>; match: ValidationEntry<string>; max: ValidationEntry<number>; min: ValidationEntry<number>; required: ValidationEntry<any> }>

Validation rules used to validate user input.

Optional value

value: string

Default value for field, and where it will be written to

widget

widget: W

What input widget is used.

default

StringWidgets {@link StringWidgets}

Generated using TypeDoc