AboutSupportDeveloper GuideVersion 17.0.14

String field within a form.

Type Parameters



helperText?: string

Helper text.

key: string

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

label?: string

Input label.

type: "string"

Field data type.

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

Validation rules used to validate user input.

Type declaration

value?: string

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

widget: W

What input widget is used.


StringWidgets {@link StringWidgets}