AboutSupportDeveloper GuideVersion 22.3.24

Interface StringField<W>

String field within a form.

interface StringField<W> {
    helperText?: string;
    key: string;
    label?: string;
    type: "string";
    validation?: Partial<{
        length: ValidationEntry<number>;
        match: ValidationEntry<string>;
        max: ValidationEntry<number>;
        min: ValidationEntry<number>;
        required: ValidationEntry<any>;
    }>;
    value?: string;
    widget: W;
}

Type Parameters

Hierarchy (view full)

Properties

helperText? key label? type validation? value? widget

Properties

OptionalhelperText

helperText?: string

Helper text.

key

key: string

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

Optionallabel

label?: string

Input label.

type

type

Field data type.

Optionalvalidation

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

Optionalvalue

value?: string

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

widget

widget: W

What input widget is used.

Default

StringWidgets StringWidgets

Settings

On This Page

Properties