Open Forms TS types
    Preparing search index...

    Interface SoftRequiredErrorsComponentSchema

    Component shape/options for a "soft required errors" component.

    This component tracks the values of other components that are marked as "soft required" - i.e. you can continue without filling in a value, but it's highly recommended not to do that. This component is responsible for displaying a warning message.

    The generated documentation might be slightly off due to rendering the type alias as an interface. Double check with the actual TS types!

    interface SoftRequiredErrorsComponentSchema {
        html: string;
        id: string;
        key: string;
        openForms?: {
            translations?: { en?: { html?: string }; nl?: { html?: string } };
        };
        type: "softRequiredErrors";
    }
    Index

    Properties

    html id key openForms? type

    Properties

    html: string

    Rich text content, in HTML form. Expected to contain the {{ missingFields }} placeholder/token.

    id: string

    Unique ID for a component in a form definition. Used to render HTML IDs.

    The new renderer does not need this.

    key: string

    Unique key for the component in a larger form definition.

    The value must comply with the (\w|\w[\w.\-]*\w) regex, meaning that periods/dots are allowed unless they're start or end. The period character creates a nesting level in the submission data.

    'myField'

    'parent.child' // creates `{parent: {child: <value}}` data.
    openForms?: {
        translations?: { en?: { html?: string }; nl?: { html?: string } };
    }
    type: "softRequiredErrors"

    Discriminator to determine the component type. Uniquely determines the shape of the component configuration options.

    Settings

    Member Visibility

    On This Page

    Properties