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

    Interface FormDefinition

    A transport-agnostic form.

    interface FormDefinition {
        id: string;
        title?: string;
        intro?: string;
        cta?: string;
        submitLabel?: string;
        fields: readonly FormField[];
    }
    Index
    id: string

    Stable form id: default c.state key of the answers, the key a native provider uses to find the published form (e.g. a WhatsApp Flow id mapping), and the node label in describe(). Same charset as field names.

    title?: string

    Title shown on the native form screen.

    intro?: string

    Text sent with the form (native message body) or before the first question (degraded).

    cta?: string

    Label of the button that opens a native form. Default: core.form.cta in ctx.lang ('Abrir formulario' / 'Open form').

    submitLabel?: string

    Label of the submit button of a native form. Default: core.form.submit in ctx.lang ('Enviar' / 'Submit').

    fields: readonly FormField[]

    Fields, in order. At least one; names must be unique.