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.

Hierarchy

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

Properties

html id key label? openForms? type

Properties

html

html: string

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

id

id: string

key

key: string

Optional label

label?: string

Optional openForms

openForms?: {
    translations: ComponentTranslations<"html">;
}

Type declaration

type

type: "softRequiredErrors"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc