This field provides a canvas area on your form that can be "signed" either using a mouse or on touchscreen device. The field's value is a base64 encoded string which represents the image. The SIGNATUREFIELD Handlebars helper can be used to decode the base64 string and embed the image into emails, PDFs, or display later in the form.
The stored signature is classed as a Simple Electronic Signature (SES).
Properties
| Label | Description | Type Name |
|---|---|---|
| Label | The label for this field | LABEL |
| Show Label | Whether to show the label for this field or not. This property adds/removes a class on the field's label element. The styling itself is controlled by the site's stylesheet | SHOWLABEL |
| Hint | Additional information displayed alongside the field to assist the user in completing it. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more information | HINT |
| Required | Whether or not the field is required to have a value to pass validation | REQUIRED |
| Error Message | The error message that will be displayed if this field fails its validation | ERRMSG |
| Error Message Function | A function that can be used to override the default error message. You can return a different message for each error type. The message can include the value of another field by adding the field's name between # characters. See Error Message Functions for more information. This field has the following error types:
| ERRMSGFUNC |
| Start Label | This button expands the canvas so the user can enter their signature. Default "Add Signature" | STARTLABEL |
| Start Aria Label | An optional aria-label (opens new window) that can be output to improve accessibility where the normal label is not enough. If you don't enter a value, the | STARTARIALABEL |
| Cancel Label | The label of the cancel button when a user is adding their signature. If a signature hasn't been confirmed yet, this button resets the field. if a signature is being edited, this button discards those edits and reloads the previous value | CANCELLABEL |
| Cancel Aria Label | See the description of the "Start" button | CANCELARIALABEL |
| Clear Label | The button label to clear the canvas | CLEARLABEL |
| Clear Aria Label | See the description of the "Start" button | CLEARARIALABEL |
| Confirm Label | The button label to save the current contents of the canvas | CONFIRMLABEL |
| Confirm Aria Label | See the description of the "Start" button | CONFIRMARIALABEL |
| Edit Label | The button label to edit an existing signature | EDITLABEL |
| Edit Aria Label | See the description of the "Start" button | EDITARIALABEL |
| Remove Label | The button label to remove an existing signature and restore the field to its initial state | REMOVELABEL |
| Remove Aria Label | See the description of the "Start" button | REMOVEARIALABEL |
| Canvas Width | The canvas (signing area) width in pixels | CANVASWIDTH |
| Canvas Height | The canvas (signing area) height in pixels | CANVASHEIGHT |
| Validation Function | A JavaScript function that can be used to provide custom field validation whenever the field value changes or the form is submitted. This function will be executed client-side, provided JavaScript is enabled in the browser, and repeated server-side | VALFUNC |
| Default Function | A JavaScript function that can be used to calculate the default field value. This function is executed server-side when the field HTML is generated | DEFFUNC |
| Handlers | A JavaScript function that is executed client-side whenever the page loads, or the field value changes. This function is useful for modifying the values of other fields based on an entered value | HANDLERS |
| Read Only | Display the field as read only | READONLY |
| Additional Styling Modifier | An optional CSS modifier for the field. See Common Field Properties for an example | ADDITIONALSTYLINGMODIFIER |
| Documentation | Add documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an example | DOCUMENTATION |
Example
