Open Forms TS types
    Preparing search index...

    Interface CosignV1ComponentSchema

    Component shape/options for the legacy cosign (v1) 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 CosignV1ComponentSchema {
        authPlugin: string;
        description?: string;
        hidden?: boolean;
        id: string;
        key: string;
        label: string;
        openForms?: {
            translations?: {
                en?: { description?: string; label?: string };
                nl?: { description?: string; label?: string };
            };
        };
        type: "coSign";
    }
    Index

    Properties

    authPlugin description? hidden? id key label openForms? type

    Properties

    authPlugin: string

    Which authentication plugin to use to log the cosigner in with.

    description?: string

    Additional information for the form field, displayed unconditionally.

    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.

    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.

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

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

    Settings

    Member Visibility

    On This Page

    Properties