Open Forms TS types
    Preparing search index...

    Interface TextFieldComponentSchema

    Component shape/options for a textfield component.

    The generated documentation might be slightly off due to rendering the type alias as an interface. Double check with the actual TS types!

    interface TextFieldComponentSchema {
        autocomplete?: string;
        clearOnHide?: boolean;
        conditional?: {
            eq?: string | number | boolean;
            show?: boolean;
            when?: string;
        };
        defaultValue?: string
        | string[];
        deriveCity?: boolean;
        deriveHouseNumber?: string;
        derivePostcode?: string;
        deriveStreetName?: boolean;
        description?: string;
        disabled?: boolean;
        errors?: { maxLength?: string; pattern?: string; required?: string };
        hidden?: boolean;
        id: string;
        isSensitiveData?: boolean;
        key: string;
        label: string;
        multiple?: boolean;
        openForms?: {
            translations?: {
                en?: {
                    description?: string;
                    label?: string;
                    placeholder?: string;
                    tooltip?: string;
                };
                nl?: {
                    description?: string;
                    label?: string;
                    placeholder?: string;
                    tooltip?: string;
                };
            };
        };
        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?: {
            en?: { maxLength?: string; pattern?: string; required?: string };
            nl?: { maxLength?: string; pattern?: string; required?: string };
        };
        type: "textfield";
        validate?: {
            maxLength?: number;
            pattern?: string;
            plugins?: string[];
            required?: boolean;
        };
    }
    Index

    Properties

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

    Properties

    autocomplete?: string

    How to autocomplete the input field by the browser. Matches the native HTML attribute.

    clearOnHide?: boolean

    Clear the value (remove the key from the submission data) when the field is hidden. This is applied if the component itself or any parent is hidden, irrespective the mechanism that made it hidden.

    Related: hidden, conditional.

    conditional?: { eq?: string | number | boolean; show?: boolean; when?: string }

    Type declaration

    • Optionaleq?: string | number | boolean

      The value that should be checked against the reference component value.

      For array values (of the reference component), the array is checked if it contains the specified value.

      Only (a subset of) primitives are supported.

    • Optionalshow?: boolean

      Whether the field should be shown (true) or hidden (false) when the condition is met.

    • Optionalwhen?: string

      The reference component key. Its value will be retrieved and tested against eq.

    defaultValue?: string | string[]

    The default/initial value to populate the field with if no value is set yet.

    deriveCity?: boolean

    in favour of addressNL component

    deriveHouseNumber?: string

    in favour of addressNL component

    derivePostcode?: string

    in favour of addressNL component

    deriveStreetName?: boolean

    in favour of addressNL component

    description?: string

    Additional information for the form field, displayed unconditionally.

    disabled?: boolean

    Should be named readOnly instead - displays the field, includes the data in the submission but editing is not allowed.

    errors?: { maxLength?: string; pattern?: string; required?: string }

    Resolved custom error messages, for the active locale. Set by the backend from translatedErrors - should never be written to.

    hidden?: boolean

    Hide or show the form field. This only controls the visibility - whether submission data is retained or not is controlled through clearOnHide.

    id: string

    Unique ID for a component in a form definition. Used to render HTML IDs.

    The new renderer does not need this.

    isSensitiveData?: boolean

    Marker for a form field that requests potentially (privacy) sensitive information.

    Pruning of submission data will clear the data of components marked as sensitive data.

    This is specific to Open Forms.

    key: string

    Unique key for the component in a larger form definition.

    The value must comply with the (\w|\w[\w.\-]*\w) regex, meaning that periods/dots are allowed unless they're start or end. The period character creates a nesting level in the submission data.

    'myField'

    'parent.child' // creates `{parent: {child: <value}}` data.
    label: string

    The form field label text.

    multiple?: boolean

    Flag that controls the multi-value mode of the field.

    If multiple values are enabled, typically an array of values will be submitted for the field instead of a single item.

    openForms?: {
        translations?: {
            en?: {
                description?: string;
                label?: string;
                placeholder?: string;
                tooltip?: string;
            };
            nl?: {
                description?: string;
                label?: string;
                placeholder?: string;
                tooltip?: string;
            };
        };
    }
    placeholder?: string

    Placeholder text displayed in the input field. Matches the native HTML attribute.

    prefill?: {
        attribute: string;
        identifierRole: "main" | "authorised_person";
        plugin: string;
    }

    Configuration on how to prefill the value of the component for the (authenticated) user.

    Type declaration

    • attribute: string

      Attribute within the plugin to read to extract the prefill value. If there's no prefill, the value must be an empty string.

    • identifierRole: "main" | "authorised_person"

      In the event of a mandate, should the prefill be looked up from the beneficiary or the authorizee?

    • plugin: string

      The plugin to use for prefill. If there's no prefill, the value must be an empty string.

    Component-level prefill configuration is not flexible enough, this will be moved in the new admin UI.

    registration?: { attribute: string }

    Configuration on how to process the value of the component in the registration plugin(s).

    Component-level registration configuration does not work reliably when multiple registration plugins are enabled on the form. This will be moved in the new admin UI.

    showCharCount?: boolean

    If enabled, the number of characters entered into the input is displayed. If there's also a maxLength configured in the component validation, the available number of characters is displayed instead.

    validate

    showInEmail?: boolean

    Include the component and its value in the confirmation email data.

    showInPDF?: boolean

    Include the component and its value in the submission report PDF available for download by the end-user and often included in registration plugins.

    showInSummary?: boolean

    Include the component and its value in the submission data summary on the confirmation page or not.

    tooltip?: string

    Extra information or background for the form field. Displayed after interacting with the tooltip icon/control near the label.

    translatedErrors?: {
        en?: { maxLength?: string; pattern?: string; required?: string };
        nl?: { maxLength?: string; pattern?: string; required?: string };
    }

    Custom, user-supplied validation error messages for each error message type supported by the validators used in the validation configuration.

    Specified for each supported language - the backend reads this configuration and writes it to errors.

    type: "textfield"

    Discriminator to determine the component type. Uniquely determines the shape of the component configuration options.

    validate?: {
        maxLength?: number;
        pattern?: string;
        plugins?: string[];
        required?: boolean;
    }

    The validation configuration of the component.

    Type declaration

    • OptionalmaxLength?: number

      Maximum length of a value for text-based fields.

    • Optionalpattern?: string

      RegExp pattern that the value of text-based fields must match.

    • Optionalplugins?: string[]

      List of plugin identifiers for async backend validation. The value is considered valid as soon as one plugin considers the value valid.

      This is an Open Forms-specific feature.

    • Optionalrequired?: boolean

      Set to true to require a non-empty value to be provided for the field.

    Settings

    Member Visibility

    On This Page

    Properties