OpenFin Workspace API
    Preparing search index...

    Interface StringField<W>

    String field within a form.

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

    Type Parameters

    Hierarchy (View Summary)

    Index
    helperText? key label? type validation? value? widget
    helperText?: string

    Helper text.

    key: string

    The property key that this field value will appear in the returned 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;
        },
    >

    Validation rules used to validate user input.

    value?: string

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

    widget: W

    What input widget is used.

    StringWidgets StringWidgets

    Settings

    On This Page
    Properties