@botmesh/core - v2.0.0-alpha.2
    Preparing search index...

    Interface TextFormField

    Free text.

    interface TextFormField {
        name: string;
        label: string;
        required?: boolean;
        helper?: string;
        prompt?: string;
        error?: string;
        type: "text";
        minLength?: number;
        maxLength?: number;
        pattern?: string | RegExp;
        multiline?: boolean;
    }

    Hierarchy (View Summary)

    Index
    name label required? helper? prompt? error? type minLength? maxLength? pattern? multiline?
    name: string

    Key of the answer in the form's values (and in c.state with flatten). Letters, digits and _, starting with a letter or _ (/^[A-Za-z_][A-Za-z0-9_]*$/).

    label: string

    Short label shown next to the input (native) or used as the question (degraded).

    required?: boolean

    Whether an answer is mandatory. Default true (false for optin).

    helper?: string

    Extra hint under the input (native) / appended to the question (degraded).

    prompt?: string

    Degraded mode only: full question text instead of label (+ helper).

    error?: string

    Error message used when an answer for this field is invalid (overrides the built-in ones).

    type: "text"
    minLength?: number
    maxLength?: number
    pattern?: string | RegExp

    Server-side pattern the whole answer must match (checked in both modes).

    multiline?: boolean

    Render as a multi-line text area where the transport supports it.

    Settings
    Member Visibility

    On This Page
    Properties