@microblink/blinkid-ux-manager 7.0.0 → 7.1.0
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 +41 -5
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,9 +1,45 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @microblink/blinkid-ux-manager
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This package provides user experience management and feedback UI for the BlinkID browser SDK. It parses results from [`@microblink/blinkid-core`](https://www.npmjs.com/package/@microblink/blinkid-core) and guides the user through the scanning process, controlling [`@microblink/camera-manager`](https://www.npmjs.com/package/@microblink/camera-manager) as needed.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Overview
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- Provides both headless and UI components for user feedback during scanning.
|
|
8
|
+
- Integrates with BlinkID Core and Camera Manager.
|
|
9
|
+
- Used by [`@microblink/blinkid`](https://www.npmjs.com/package/@microblink/blinkid) and can be used directly for custom UI integrations.
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
Install from npm using your preferred package manager:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
npm install @microblink/blinkid-ux-manager
|
|
17
|
+
# or
|
|
18
|
+
yarn add @microblink/blinkid-ux-manager
|
|
19
|
+
# or
|
|
20
|
+
pnpm add @microblink/blinkid-ux-manager
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Usage
|
|
24
|
+
|
|
25
|
+
You can use `@microblink/blinkid-ux-manager` directly in your project for advanced or custom integrations. For most use cases, use [`@microblink/blinkid`](https://www.npmjs.com/package/@microblink/blinkid) for a simpler setup.
|
|
26
|
+
|
|
27
|
+
See the example apps in the `apps/examples` directory in the GitHub repository for usage details.
|
|
28
|
+
|
|
29
|
+
## Development
|
|
30
|
+
|
|
31
|
+
To build the package locally:
|
|
32
|
+
|
|
33
|
+
1. Install dependencies in the monorepo root:
|
|
34
|
+
|
|
35
|
+
```sh
|
|
36
|
+
pnpm install
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
2. Build the package:
|
|
40
|
+
|
|
41
|
+
```sh
|
|
42
|
+
pnpm build
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
The output files will be available in the `dist/` and `types/` directories.
|
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@microblink/blinkid-ux-manager",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.1.0",
|
|
4
4
|
"author": "Microblink",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/blinkid-ux-manager.js",
|
|
7
7
|
"module": "./dist/blinkid-ux-manager.js",
|
|
8
|
-
"description": "",
|
|
8
|
+
"description": "BlinkID UX Manager provides user feedback based on the blinkid process results.",
|
|
9
9
|
"files": [
|
|
10
10
|
"dist",
|
|
11
11
|
"types"
|
|
12
12
|
],
|
|
13
13
|
"dependencies": {
|
|
14
|
-
"@microblink/blinkid-core": "^7.
|
|
15
|
-
"@microblink/camera-manager": "^7.
|
|
14
|
+
"@microblink/blinkid-core": "^7.1.0",
|
|
15
|
+
"@microblink/camera-manager": "^7.1.0",
|
|
16
16
|
"type-fest": "^4.35.0"
|
|
17
17
|
},
|
|
18
18
|
"access": "public",
|