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

    Interface BaseTextFieldComponentSchema

    interface BaseTextFieldComponentSchema {
        autocomplete?: string;
        clearOnHide?: boolean;
        conditional?: OFConditionalOptions;
        defaultValue?: string | string[];
        deriveCity?: boolean;
        deriveHouseNumber?: string;
        derivePostcode?: string;
        deriveStreetName?: boolean;
        description?: string;
        disabled?: boolean;
        errors?: Object & ComponentErrors<ComponentErrorKeys<Validator>>;
        hidden?: boolean;
        id: string;
        isSensitiveData?: boolean;
        key: string;
        label: string;
        openForms?: { translations: ComponentTranslations<TK> };
        placeholder?: string;
        prefill?: {
            attribute: string;
            identifierRole: "main" | "authorised_person";
            plugin: string;
        };
        registration?: { attribute: string };
        showCharCount?: boolean;
        showInEmail?: boolean;
        showInPDF?: boolean;
        showInSummary?: boolean;
        tooltip?: string;
        translatedErrors?: ErrorTranslations<ComponentErrorKeys<Validator>>;
        type: "textfield";
        validate?: OFValidateOptions<Validator | "plugins">;
        validateOn?: "blur" | "change";
    }

    Hierarchy (View Summary)

    Index

    Properties

    autocomplete? clearOnHide? conditional? defaultValue? deriveCity? deriveHouseNumber? derivePostcode? deriveStreetName? description? disabled? errors? hidden? id isSensitiveData? key label openForms? placeholder? prefill? registration? showCharCount? showInEmail? showInPDF? showInSummary? tooltip? translatedErrors? type validate? validateOn?

    Properties

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

    The default value of this compoennt.

    deriveCity?: boolean
    deriveHouseNumber?: string
    derivePostcode?: string
    deriveStreetName?: boolean
    description?: string
    disabled?: boolean
    errors?: Object & ComponentErrors<ComponentErrorKeys<Validator>>

    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.

    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> }
    placeholder?: string

    The input placeholder for this component.

    prefill?: {
        attribute: string;
        identifierRole: "main" | "authorised_person";
        plugin: string;
    }
    registration?: { attribute: string }
    showCharCount?: boolean
    showInEmail?: boolean
    showInPDF?: boolean
    showInSummary?: boolean
    tooltip?: string
    translatedErrors?: ErrorTranslations<ComponentErrorKeys<Validator>>
    type: "textfield"
    validate?: OFValidateOptions<Validator | "plugins">
    validateOn?: "blur" | "change"

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

    Settings

    Member Visibility

    On This Page

    Properties