Interface CosignV2ComponentSchema

The cosign component type, otherwise known as 'Cosign'.

This is a custom component sharing most of the functionality with the email input component type - it collects the e-mail address of any/a cosigner so that they receive a notification they're expected to cosign. The actual cosigning happens out-of-band. This component does take form data input, as opposed to the V1 component implementation.

Hierarchy

Properties

autocomplete?: string
clearOnHide?: boolean

If the value of this field should be cleared when it is conditionally hidden.

conditional?: ConditionalOptions

Determines when this component should be added to the form for both processing and input.

defaultValue?: string
description?: string
errors?: Object & ComponentErrors<"required">

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
label: string
openForms?: {
    translations: ComponentTranslations<TranslatableKeys>;
} & EmailExtensions

Type declaration

registration?: {
    attribute: string;
}

Type declaration

  • attribute: string
showInEmail?: boolean
showInPDF?: boolean
showInSummary?: boolean
tooltip?: string
translatedErrors?: ErrorTranslations<"required">
type: "cosign"
validate?: OFValidateOptions<"required" | "plugins">
validateOn: "blur"

Generated using TypeDoc