Skip to main content
Defined in: forms/types.ts:132 A consent checkbox (c.state gets a boolean). When required, the user must accept it to submit the form.

​
Extends

​
Properties

​
name

Defined in: forms/types.ts:38 Key of the answer in the form’s values (and in c.state with flatten). Letters, digits and _, starting with a letter or _ (/^[A-Za-z_][A-Za-z0-9_]*$/).

​
Inherited from

FormFieldBase.name

​
label

Defined in: forms/types.ts:40 Short label shown next to the input (native) or used as the question (degraded).

​
Inherited from

FormFieldBase.label

​
required?

Defined in: forms/types.ts:42 Whether an answer is mandatory. Default true (false for optin).

​
Inherited from

FormFieldBase.required

​
helper?

Defined in: forms/types.ts:44 Extra hint under the input (native) / appended to the question (degraded).

​
Inherited from

FormFieldBase.helper

​
prompt?

Defined in: forms/types.ts:46 Degraded mode only: full question text instead of label (+ helper).

​
Inherited from

FormFieldBase.prompt

​
error?

Defined in: forms/types.ts:48 Error message used when an answer for this field is invalid (overrides the built-in ones).

​
Inherited from

FormFieldBase.error

​
type

Defined in: forms/types.ts:133