4.0.0 • Published 2 years ago
ng-fad-fingerprints v4.0.0
Getting started
Installation
npm install ng-fad-fingerprints
Dependencies
Add the folder provided by the technical team within the project assets (images and js)
Configuration project
In angular.json file add identy assets and styles
.
.
"assets": [
"src/favicon.ico",
"src/assets",
{
"glob": "**/*",
"input": "node_modules/@identy/identy-finger/dist/assets",
"output": "./assets/"
},
{
"glob": "**/*",
"input": "node_modules/@identy/identy-common/dist/assets",
"output": "./assets/"
}
],
"styles": [
"node_modules/@identy/identy-finger/dist/identy-finger-style.css",
"node_modules/ng-fad-fingerprints/assets/fad-fingerprints.scss"
],
.
.
In tsconfig.json or add
{ ... "skipLibCheck": true, ... }
Import
In the file necessary example.module.ts import the module.
In this case app.module.ts
import { NgFadFingerprintsModule } from 'ng-fad-fingerprints';
.
.
.
... imports: [
...,
BrowserAnimationsModule
NgFadFingerprintsModule
]...
Note: BrowserAnimationsModule is required.
Usage
HTML
Add the selector inside some component
<ng-fad-fingerprints
[modelURL]="modelURL"
[detectionModes]="detectionModes"
[captureTimeout]="captureTimeout"
[allowClose]="allowClose"
(onerror)="onerror($event)"
(ondata)="ondata($event)"
(onclose)="onclose()">
</ng-fad-fingerprints>
Typescript
import { FingerDetectionMode, NgFadFingerprintsComponent, ResponseIdentyFinger } from 'ng-fad-fingerprints';
.
.
.
modelURL: string = 'yor_model_url';
captureTimeout = 30000;
detectionModes: FingerDetectionMode[] = [L4F];
delay = 5000;
allowClose = true;
onerror(error: ResponseError) {
// manage error
}
ondata(event: ResponseIdentyFinger) {
// capture result
}
onclose() {
// manage close capture
}
Inputs
Name | Type | Required | Default | Description |
---|---|---|---|---|
modelURL | string | true | undefined | Server url |
detectionModes | FingerDetectionMode[] | true | undefined | Hand (right or left) and fingers (4F or thumb) to capture |
captureTimeout | number | false | 30000 | Set capture timeout |
delay | number | false | 5000 | Set init delay |
allowClose | boolean | false | false | Button that allows you to close the capture |
FingerDetectionMode Type |
---|
L4F |
R4F |
RIGHT_INDEX |
RIGHT_MIDDLE |
RIGHT_RING |
RIGHT_LITTLE |
LEFT_INDEX |
LEFT_MIDDLE |
LEFT_RING |
LEFT_LITTLE |
RIGHT_THUMB |
LEFT_THUMB |
Outputs
Name | Return | Description |
---|---|---|
ondata | ResponseIdentyFinger | Is called when capture completes successfully |
onerror | object | Is called when an error happens |
onclose | void | Is called when user close component |