Interface BaseTextFieldComponentSchema

Hierarchy

Properties

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

Properties

Optional autocomplete

autocomplete?: string

Optional clearOnHide

clearOnHide?: boolean

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

Optional conditional

conditional?: ConditionalOptions

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

Optional defaultValue

defaultValue?: string | string[]

The default value of this compoennt.

Optional deriveCity

deriveCity?: boolean

Optional deriveHouseNumber

deriveHouseNumber?: string

Optional derivePostcode

derivePostcode?: string

Optional deriveStreetName

deriveStreetName?: boolean

Optional description

description?: string

Optional disabled

disabled?: boolean

Optional errors

errors?: Object & ComponentErrors<ComponentErrorKeys<Validator>>

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."}

Optional hidden

hidden?: boolean

Determines if the component should be within the form, but not visible. This can be overridden with the conditionals.

id

id: string

Optional isSensitiveData

isSensitiveData?: boolean

key

key: string

label

label: string

Optional openForms

openForms?: {
    translations: ComponentTranslations<TranslatableKeys>;
}

Type declaration

Optional placeholder

placeholder?: string

The input placeholder for this component.

Optional prefill

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

Type declaration

  • attribute: string
  • identifierRole: "main" | "authorised_person"
  • plugin: string

Optional registration

registration?: {
    attribute: string;
}

Type declaration

  • attribute: string

Optional showCharCount

showCharCount?: boolean

Optional showInEmail

showInEmail?: boolean

Optional showInPDF

showInPDF?: boolean

Optional showInSummary

showInSummary?: boolean

Optional tooltip

tooltip?: string

Optional translatedErrors

translatedErrors?: ErrorTranslations<ComponentErrorKeys<Validator>>

type

type: "textfield"

Optional validate

validate?: OFValidateOptions<Validator | "plugins">

Optional validateOn

validateOn?: "blur" | "change"

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc