Interface CheckboxComponentSchema

Hierarchy

Properties

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: boolean
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>;
}

Type declaration

placeholder?: string

The input placeholder for this component.

registration?: {
    attribute: string;
}

Type declaration

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

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

Generated using TypeDoc