| Line 1: | Line 1: | ||
===Name=== | ===Name=== | ||
| − | + | signature | |
===Type=== | ===Type=== | ||
_input | _input | ||
===Synopsis=== | ===Synopsis=== | ||
| − | How to render | + | How to render a signature field |
===Description=== | ===Description=== | ||
| − | + | A signature field allows person to add a signature to a form. | |
===Parameters=== | ===Parameters=== | ||
| − | type=" | + | type="signature" |
| + | |||
| + | * means required | ||
| + | fname* | ||
| + | type : text | ||
| + | |||
| + | Name of the file to be placed in the Wiki | ||
| + | ftype* | ||
| + | type : text | ||
| + | |||
| + | Filetype. Either png, svg or jpg | ||
| + | pagecontent* | ||
| + | type : text | ||
| + | |||
| + | The (text-) content that goes on the page when saving to the wiki | ||
| + | class | ||
| + | |||
| + | type : text | ||
| + | |||
| + | Adds an additional CSS class to the signature canvas. | ||
| + | |||
| + | By default the signature canvas will always get class: wsform-signature. | ||
| + | clearbuttonclass | ||
| + | |||
| + | type : text | ||
| + | |||
| + | Adds an additional CSS class to the clear button to clear the canvas. | ||
| + | |||
| + | By default the clear button will always get class: wsform-signature-clear. | ||
| + | clearbuttontext | ||
| + | |||
| + | type : text | ||
| + | |||
| + | Text to be placed in the clear button. Default to Clear. | ||
| + | background | ||
| + | |||
| + | type : color. Either hexadecimal, CSS color name or css rgb value | ||
| + | |||
| + | Background color for the signature field | ||
| + | drawcolor | ||
| + | |||
| + | type : color. Either hexadecimal, CSS color name or css rgb value | ||
| + | |||
| + | Color of the signature pen | ||
| + | thickness | ||
| + | |||
| + | type : integer | ||
| + | |||
| + | Thickness of the signature pen | ||
| + | notavailablemessage | ||
| + | |||
| + | type : text | ||
| + | |||
| + | When a browser does not support the signature canvas, this message will be displayed. | ||
| + | |||
| + | Default message : "Your browser doesn't support signing" | ||
| + | guideline | ||
| + | |||
| + | type : text | ||
| + | |||
| + | Show a horizontal line to guide when writing a signature. | ||
| + | |||
| + | Use guideline="true" is the only way to show the guideline. | ||
| + | |||
| + | Please note that the guideline will be saved together with the signature, unless you choose svg as file type. | ||
| + | Additional guideline option, available when guideline is set to true | ||
| + | - guidelineoffset | ||
| + | |||
| + | type: integer | ||
| + | |||
| + | Offset from the bottom of the canvas | ||
| + | - guidelineindent | ||
| + | |||
| + | type: integer | ||
| + | |||
| + | Margin left and right from the line to the side of the canvas | ||
| + | - guidelinecolor | ||
| + | |||
| + | type : color. Either hexadecimal, CSS color name or css rgb value | ||
| + | |||
| + | Color for the guideline | ||
All other valid parameters for an input field are valid | All other valid parameters for an input field are valid | ||
===Example=== | ===Example=== | ||
<syntaxhighlight lang="html"> | <syntaxhighlight lang="html"> | ||
| − | <_input type=" | + | <_input type="signature" fname="Signature-test" ftype="png" pagecontent="test" guideline="true" clearbuttonclass="btn btn-primary" /> |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | <_input type=" | + | <_input type="signature" fname="Signature-test" ftype="png" pagecontent="test" guideline="true" clearbuttonclass="btn btn-primary" /> |
===Note=== | ===Note=== | ||
| − | + | ||
===Links=== | ===Links=== | ||
| − | |||
Revision as of 14:04, 6 April 2022
Name
signature
Type
_input
Synopsis
How to render a signature field
Description
A signature field allows person to add a signature to a form.
Parameters
type="signature"
- means required
fname* type : text
Name of the file to be placed in the Wiki ftype* type : text
Filetype. Either png, svg or jpg pagecontent* type : text
The (text-) content that goes on the page when saving to the wiki class
type : text
Adds an additional CSS class to the signature canvas.
By default the signature canvas will always get class: wsform-signature. clearbuttonclass
type : text
Adds an additional CSS class to the clear button to clear the canvas.
By default the clear button will always get class: wsform-signature-clear. clearbuttontext
type : text
Text to be placed in the clear button. Default to Clear. background
type : color. Either hexadecimal, CSS color name or css rgb value
Background color for the signature field drawcolor
type : color. Either hexadecimal, CSS color name or css rgb value
Color of the signature pen thickness
type : integer
Thickness of the signature pen notavailablemessage
type : text
When a browser does not support the signature canvas, this message will be displayed.
Default message : "Your browser doesn't support signing" guideline
type : text
Show a horizontal line to guide when writing a signature.
Use guideline="true" is the only way to show the guideline.
Please note that the guideline will be saved together with the signature, unless you choose svg as file type. Additional guideline option, available when guideline is set to true
- guidelineoffset
type: integer
Offset from the bottom of the canvas - guidelineindent
type: integer
Margin left and right from the line to the side of the canvas - guidelinecolor
type : color. Either hexadecimal, CSS color name or css rgb value
Color for the guideline
All other valid parameters for an input field are valid
Example
<_input type="signature" fname="Signature-test" ftype="png" pagecontent="test" guideline="true" clearbuttonclass="btn btn-primary" />
Missing attribute "name" for signature field.
