@open-formulieren/types
    Preparing search index...

    Interface SoftRequiredErrorsComponentSchema

    The softRequiredErrors component schema. It's a variation on the WYSIWYG content component.

    Any validation errors related to soft-required fields (the fields are required but don't block progressing in the form and are therefore mostly informational/warnings) are displayed here. The form designer can control the body text, and the SDK will then interpolate the actual field labels that violate the requirement(s). If there are no errors, the component is not to be displayed.

    interface SoftRequiredErrorsComponentSchema {
        html: string;
        id: string;
        key: string;
        label?: string;
        openForms?: { translations: ComponentTranslations<TK> };
        type: "softRequiredErrors";
    }

    Hierarchy

    • Omit<
          LayoutComponentSchema<never>,

              | "conditional"
              | "tooltip"
              | "multiple"
              | "defaultValue"
              | "clearOnHide"
              | "validate"
              | "errors"
              | "description"
              | "hidden"
              | "hideLabel"
              | "disabled"
              | "widget"
              | "validateOn"
              | "placeholder",
      >
    • Omit<OFExtensions<TranslatableKeys>, "registration" | "isSensitiveData">
      • SoftRequiredErrorsComponentSchema
    Index

    Properties

    html: string

    Even though the label is present, it is typically not displayed anywhere.

    id: string
    key: string

    The data key for this component (how the data is stored in the database, referenced as API key in docs).

    label?: string

    The HTML label to give this component.

    openForms?: { translations: ComponentTranslations<TK> }
    type: "softRequiredErrors"

    The type of component