README.md

Angular 2 SignaturePad

Source @ https://github.com/dimpu/angular2-signature-pad

Table of contents

1. Getting Started
2. Installation instructions
3. Usage & Demo
4. Contributing
5. License

Getting Started

angular2-signature-pad contains SignaturePadModule for Angular 2.

Additionally we use signature_pad for this component.

Installation instructions

Install angular2-signature-pad from npm:

npm install angular2-signature-pad --save

or using yarn:

yarn add angular2-signature-pad

How to use it with:

• angular-cli — please refer to Getting started with angular-cli
• angular-seed — please refer to Getting started with angular-seed
• system.js (and Angular 2 QuickStart) — please checkout sample repository
• webpack — you can view our demo page source code
• plnkr — sample available here
• AoT using ngc and rollup — please refer to How to use angular2-signature-pad in Angular 2 with AoT compilation using ngc and rollup

Usage & Demo

Main source of API documentation and usage scenarios is available at https://dimpu.github.io/angular2-signature-pad/.

Contribution

Is very welcome! And remember, contribution is not only PRs and code, but any help with docs or helping other developers to solve issues are very appreciated! Thanks in advance!

Quick Guide

app.module.js

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { SignaturePadModule } from 'angular2-signature-pad';
import { AppComponent } from '../src/app.component';

@NgModule({
  imports: [
    BrowserModule,
    SignaturePadModule,
  ],
  declarations: [AppComponent],
  bootstrap: [AppComponent],
})

app.component.html

<signature-pad 
        (onSave)="onSaveHandler($event)" 
        (onClear)="onClearHandler()" 
        [width]="width" 
        [height]="height" 
        [hideFooter]="noFooter" 
        [formDataURL]="dataUrlVar" 
        [label]="label"></signature-pad>

Example

You can find a working example inside the demo directory.

To serve it locally, run:

git clone https://github.com/dimpu/angular2-signature-pad.git

npm i

npm run demo.serve