Optional
clearIf the value of this field should be cleared when it is conditionally hidden.
Optional
conditionalDetermines when this component should be added to the form for both processing and input.
Optional
defaultThe value type of the component. We don't support multiple: true
in this component.
Note that we use the defaultValue
property to infer the value type, we do not
support actually setting a component default value.
Optional
descriptionOptional
errorsAllows 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
footerThe footer is a text displayed below the drawing canvas which may hint the user on what is expected of them.
I'm not sure what the difference is with the 'description' field.
Optional
hiddenDetermines if the component should be within the form, but not visible. This can be overridden with the conditionals.
Optional
isOptional
openOptional
registrationOptional
showOptional
showOptional
showOptional
tooltipOptional
translatedOptional
validateGenerated using TypeDoc
The built-in Formio.js signature component type.
Source code this is based on: https://github.com/formio/formio.js/blob/4.13.x/src/components/signature/Signature.js
Note that we don't offer support for many properties through our form builder, like:
Because of that, they are also not added to the type definitions (yet). That may change once we implement our own renderer.