ng-sign-here
v1.0.1
Published
AngularJS signature pad component
Downloads
5
Readme
ng-sign-here
AngularJS signature capture component. Wrapper for signature_pad.
Install
npm install ng-sign-here
Getting Started
Include ngSignHere.min.js and signature_pad.
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/signature_pad.min.js"></script>
<script src="../dist/ngSignHere.min.js"></script>
Add as a module dependency.
angular.module('demoApp', ['ngSignHere']);
Use the component in html.
<sign-here></sign-here>
Examples
Adding the component in html isn't very useful by itself. You can draw on the canvas, but that's about it.
Size
To set the signature pad size, simply add a css class or inline style. The signature pad will size itself to fit.
<sign-here style="width: 600px; height: 300px;">
</sign-here>
Background Color
Set the background color using background-color. Defaults to transparent. Supports hex, rgb/rgba, and color names.
<!-- Sets background color to black -->
<sign-here background-color="#000000">
</sign-here>
Pen Color
Set the pen color using pen-color. Defaults to a dark blue. Supports hex, rgb/rgba, and color names.
<!-- Sets pen color to green -->
<sign-here pen-color="#6BD425">
</sign-here>
Image Format
Set the returned image format using image-format. Defaults to png. Supported formats are png, jpg/jpeg, and svg.
<!-- Sets image format to svg -->
<sign-here image-format="svg">
</sign-here>
Getting the Signature
Pass a function to on-signature-update.
// Controller signature update function.
ctrl.onSignatureUpdate = function (signatureData) {
// Set a signatureData property on your controller.
ctrl.signature = signatureData;
};
<sign-here on-signature-update="demo.onSignatureUpdate">
</sign-here>
Clearing the Signature
This component does NOT use two-way binding, so you need to register a handler with register-clear-handler. On clear, the component will call onSignatureUpdate with undefined
.
// Your controller's clear handler.
let clearSignatureHandler = null;
// Register clear handler function.
ctrl.registerClearHandler = function (handler) {
// Set the handler returned from the component.
clearSignatureHandler = handler;
};
// Handle the clear button click.
ctrl.clearSignature = function () {
// Check if a the clearSignatureHandler is registered.
if (clearSignatureHandler) {
clearSignatureHandler();
}
};
<!-- Register your controller's clear handler -->
<sign-here demo.registerClearHandler(handler)>
</sign-here>
<!-- A clear button somewhere on your page -->
<button ng-click="demo.clearSignature()">
CLEAR
</button>