@privyid/pena-angular

Pena ❤️ Angular

PrivyID's Official Client Integration Library for Angular

Installation

• Add as dependencies to your package.json

NPM

npm install --save @privyid/pena-angular @privyid/pena

Yarn

yarn add @privyid/pena-angular @privyid/pena

• Register the module.

import { PenaModule } from '@privyid/pena-angular'

@NgModule({
  /* ... */
  imports: [PenaModule],
  /* ... */
})
export class AppModule {}

Usage

import type { Placement, Payload } from '@privyid/pena'

@Component({
  selector: 'app-root',
  template: `
    <pena
      url="http://sign.document.com/doc/xxx"
      lang="en"
      layout="fixed"
      [signature]="signature"
      (afterAction)="onAfterAction($event)"
    />
  `,
  styles: [],
})
export class AppComponent {
  signature: Placement = {
    x    : 100,
    y    : 200,
    page : 1,
    fixed: false,
  }

  onAfterAction (event: Payload) {
    if (event.action === 'sign') {
      window.alert('Signed')
    }
  }
}

Options

Input Properties

Name	Type	Default	Description
url	string	-	(Required) Document's url
lang	string	en	Set language, valid value is en or id
layout	string	fixed	Set layout mode, valid value is fixed or fit, see the different
visibility	boolean	true	Set signature visibility
privyId	string	-	Set recipient's privyId
signature	object	-	Set signature placement (Deprecated) use API to set placement when upload the document
├ x	number	-	X Coordinate
├ y	number	-	Y Coordinate
├ page	number	-	Target page
└ fixed	boolean	false	Disabled signature for moving
debug	boolean	false	Enable debug mode
ratio	number	210 / 297	Ratio size (Layout fixed only)
needScrollTo	number | string	-	Force user to scroll to target page before doing an action (sign,review,etc). Valid value is a number, or set last to target the last page

Output Events

Name	Arguments	Description
afterAction	Payload	After action hook

License

This project is licensed under the MIT License - see the LICENSE file for details