Interface ContentComponentSchema

The content component schema, intended for WYSIWYG content.

The content component type is a mechanism to include additional text/content by form designers to provide additional information. It is not possible to submit any value(s) for it.

Hierarchy

  • Omit<LayoutComponentSchema<never>, "tooltip" | "multiple" | "defaultValue" | "clearOnHide" | "validate" | "errors" | "description" | "hideLabel" | "disabled" | "widget" | "validateOn" | "placeholder">
  • DisplayConfig
  • OFExtensions<TranslatableKeys>
    • ContentComponentSchema

Properties

conditional? customClass? hidden? html id isSensitiveData? key label? openForms? registration? showInEmail? showInPDF? showInSummary? type

Properties

Optional conditional

conditional?: ConditionalOptions

Determines when this component should be added to the form for both processing and input.

Optional customClass

customClass?: "" | "error" | "success" | "info" | "warning"

Optional hidden

hidden?: boolean

html

html: string

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

id

id: string

Optional isSensitiveData

isSensitiveData?: boolean

key

key: string

Optional label

label?: string

Optional openForms

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

Type declaration

Optional registration

registration?: {
    attribute: string;
}

Type declaration

  • attribute: string

Optional showInEmail

showInEmail?: boolean

Optional showInPDF

showInPDF?: boolean

Optional showInSummary

showInSummary?: boolean

type

type: "content"

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc