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

    Interface BaseFileComponentSchema

    interface BaseFileComponentSchema {
        clearOnHide?: boolean;
        conditional?: OFConditionalOptions;
        defaultValue?: FileUploadData[];
        description?: string;
        errors?: ComponentErrors<"required">;
        file: FileUploadConfiguration;
        fileMaxSize?: string;
        filePattern: string;
        hidden?: boolean;
        id: string;
        isSensitiveData?: boolean;
        key: string;
        label: string;
        maxNumberOfFiles?: null | number;
        multiple?: boolean;
        of?: {
            image?: {
                resize?: { apply?: boolean; height?: number; width?: number };
            };
        };
        openForms?: { translations: ComponentTranslations<TK> } & {
            softRequired?: boolean;
        };
        options: { withCredentials: true };
        registration?: {
            bronorganisatie?: string;
            docVertrouwelijkheidaanduiding?: string;
            informatieobjecttype?: string;
            titel?: string;
        };
        showInEmail?: boolean;
        showInPDF?: boolean;
        showInSummary?: boolean;
        storage: "url";
        tooltip?: string;
        translatedErrors?: ErrorTranslations<"required">;
        type: "file";
        url: string;
        useConfigFiletypes?: boolean;
        validate?: OFValidateOptions<"required">;
        validateOn?: "blur" | "change";
        webcam: false;
    }

    Hierarchy (View Summary)

    Index

    Properties

    clearOnHide? conditional? defaultValue? description? errors? file fileMaxSize? filePattern hidden? id isSensitiveData? key label maxNumberOfFiles? multiple? of? openForms? options registration? showInEmail? showInPDF? showInSummary? storage tooltip? translatedErrors? type url useConfigFiletypes? validate? validateOn? webcam

    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?: FileUploadData[]

    The default value of this compoennt.

    description?: string
    errors?: ComponentErrors<"required">
    file: FileUploadConfiguration
    fileMaxSize?: string
    filePattern: string
    hidden?: boolean

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

    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.

    maxNumberOfFiles?: null | number
    multiple?: boolean
    of?: {
        image?: {
            resize?: { apply?: boolean; height?: number; width?: number };
        };
    }
    openForms?: { translations: ComponentTranslations<TK> } & {
        softRequired?: boolean;
    }
    options: { withCredentials: true }
    registration?: {
        bronorganisatie?: string;
        docVertrouwelijkheidaanduiding?: string;
        informatieobjecttype?: string;
        titel?: string;
    }
    showInEmail?: boolean
    showInPDF?: boolean
    showInSummary?: boolean
    storage: "url"
    tooltip?: string
    translatedErrors?: ErrorTranslations<"required">
    type: "file"
    url: string
    useConfigFiletypes?: boolean
    validate?: OFValidateOptions<"required">
    validateOn?: "blur" | "change"

    This will perform the validation on either "change" or "blur" of the input element.

    webcam: false

    Settings

    Member Visibility

    On This Page

    Properties