Skip to main content

buildfire.components.signatureBox

eSignature -or signatureBox- is a component that allows a plugin to make use of electronic form handwritten signatures, it handles showing the signature box view for signing, getting the user written signature and transforming back the data in different representation. The component does not rely on any UI framework with consideration to the configured branding (app theme).

eSignature Demo

Requirements​

Widget​

<head>
  <!-- JS -->
  <script src="../../../scripts/buildfire.min.js"></script>
  <script src="../../../scripts/buildfire/components/signatureBox/signatureBox.js"></script>
</head>
danger

Document's head element is necessary for the component to inject needed dependencies.

Methods​

openDialog()
​

buildfire.components.signatureBox.openDialog(options, callback)

This method is used to show the signature view with its associated controls.

buildfire.components.signatureBox.openDialog({ width: '500', height: '100' });

options​

NameTypeRequiredDescriptionDefault
widthstringnoUsed to set the Canvas width'200'
heightstringnoUsed to set the Canvas height.'400'

callback(err, data)​

When the Save button is clicked, the result data is returned within the callback.

NameTypeDescription
errstringError string, null when operation is successful
dataobjectAn object with dataUrl and base64 properties which are representations of the submitted signature.

More Examples​

buildfire.components.signatureBox.openDialog(
  { width: '150', height: '400' },
  (err, data) => {
    if (err) return console.error(err);

    console.log(data);
})