@regulaforensics/idv-gui 3.2.261-nightly → 3.2.263-nightly
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -3
- package/dist/index.d.ts +1 -0
- package/dist/main.iife.js +4 -4
- package/dist/main.js +925 -920
- package/dist/main.umd.cjs +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
|
-
# Idv
|
|
1
|
+
# Idv Gui Module
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The **idv-gui** module is an npm package plugin that renders client-side workflow steps according to predefined templates.
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
It is delivered as part of the **IDV Capturing** solution and has a version synchronized with **idv-capture-web**. Currently, compatibility is guaranteed at the **major.minor** version level.
|
|
7
|
+
|
|
8
|
+
## What the Module Is
|
|
9
|
+
|
|
10
|
+
The module is an **npm package** that **exports a Web Component**, inside which the **Preact** framework is used for rendering and component logic.
|
|
11
|
+
## How It Works
|
|
12
|
+
|
|
13
|
+
The module receives typed configuration data following the unified interface used by all **idv-capture-web** modules.
|
|
14
|
+
|
|
15
|
+
## Module Output
|
|
16
|
+
|
|
17
|
+
The result of execution can be either:
|
|
18
|
+
|
|
19
|
+
- **Data** for submission to the platform, or
|
|
20
|
+
- A typed **BaseError**, which contains detailed information explaining why the module failed.
|
|
4
21
|
|
|
5
|
-
Module exports React Component which can be used in Idv-capture-web component, Idv Platform
|