Interface StringField<W>

String field within a form.

Type Parameters

W extends StringWidget = StringWidget

Hierarchy

BaseField<"string", string>
- StringField

Index

Properties

helperText? key label? type validation? value? widget

Properties

`Optional` helperText

helperText?: string

Helper text.

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 StringWidgets

Generated using TypeDoc