Open Forms TS types
    Preparing search index...

    Interface Option

    A predefined choice/option definition.

    interface Option {
        description?: string;
        label: string;
        openForms?: {
            translations: {
                en?: { description?: string; label?: string };
                nl?: { description?: string; label?: string };
            };
        };
        value: string;
    }
    Index

    Properties

    description? label openForms? value

    Properties

    description?: string

    Optional additional information explaining the meaning of the option.

    label: string

    Human readable label that helps the user understand the meaning of the option.

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

    Open Forms specific extensions.

    Type declaration

    • translations: {
          en?: { description?: string; label?: string };
          nl?: { description?: string; label?: string };
      }

      Translations for the user-facing texts. The backend processes this and assigns the matching top-level properties.

    value: string

    The system value that uniquely identifies the option. The value is what ultimately gets sent to registration backends.

    Settings

    Member Visibility

    On This Page

    Properties