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

    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.

    interface ContentComponentSchema {
        conditional?: OFConditionalOptions;
        customClass?: "" | "error" | "success" | "info" | "warning";
        hidden?: boolean;
        html: string;
        id: string;
        isSensitiveData?: boolean;
        key: string;
        label?: string;
        openForms?: { translations: ComponentTranslations<TK> };
        registration?: { attribute: string };
        showInEmail?: boolean;
        showInPDF?: boolean;
        showInSummary?: boolean;
        type: "content";
    }

    Hierarchy (View Summary)

    • Omit<
          LayoutComponentSchema<never>,

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

    Properties

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

    Properties

    conditional?: OFConditionalOptions

    Dynamically determines if the component is visible/available.

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

    Determines if the component should be within the form, but not visible. This can be overridden with the conditionals.

    html: string

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

    id: string
    isSensitiveData?: boolean
    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> }
    registration?: { attribute: string }
    showInEmail?: boolean
    showInPDF?: boolean
    showInSummary?: boolean
    type: "content"

    The type of component

    Settings

    Member Visibility

    On This Page

    Properties