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

    Interface ChildrenComponentSchema

    interface ChildrenComponentSchema {
        clearOnHide?: boolean;
        conditional?: OFConditionalOptions;
        defaultValue?: ChildDetails[];
        description?: string;
        enableSelection: boolean;
        errors?: Object;
        hidden?: boolean;
        hideLabel?: boolean;
        id: string;
        isSensitiveData?: boolean;
        key: string;
        label: string;
        openForms?: { translations: ComponentTranslations<TK> };
        registration?: { attribute: string };
        tooltip?: string;
        type: "children";
    }

    Hierarchy (View Summary)

    Index

    Properties

    clearOnHide? conditional? defaultValue? description? enableSelection errors? hidden? hideLabel? id isSensitiveData? key label openForms? registration? tooltip? type

    Properties

    clearOnHide?: boolean

    If the value of this field should be cleared when it is conditionally hidden.

    conditional?: OFConditionalOptions

    Dynamically determines if the component is visible/available.

    defaultValue?: ChildDetails[]

    The default value of this compoennt.

    description?: string
    enableSelection: boolean
    errors?: Object

    Allows customizable errors to be displayed for each component when an error occurs. This is an object with the following keys: required min max minLength maxLength invalid_email invalid_date pattern custom

    An object (keys listed above), values are the strings you wish to display. Each string has the {{ field }} to use within the string. Example. {"required": "{{ field }} is required. Try again."}

    hidden?: boolean

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

    hideLabel?: boolean
    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 }
    tooltip?: string
    type: "children"

    Settings

    Member Visibility

    On This Page

    Properties