Skip to content

Commit e7f56b4

Browse files
amro-dynamsoftamro-dynamsoft
committed
More work for Flutter and addition of React Native
1 parent cd338ce commit e7f56b4

File tree

22 files changed

+1187
-62
lines changed

22 files changed

+1187
-62
lines changed

‎_config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@ maui_api: /mrz-scanner/docs/mobile/programming/maui/api-reference/
2323
maui_release_notes: /mrz-scanner/docs/mobile/programming/maui/release-notes/
2424
maui_faq: /mrz-scanner/docs/mobile/programming/maui/faq/
2525

26+
flutter: /mrz-scanner/docs/mobile/programming/flutter/
27+
flutter_api: /mrz-scanner/docs/mobile/programming/flutter/api-reference/
28+
flutter_release_notes: /mrz-scanner/docs/mobile/programming/flutter/release-notes/
29+
30+
react_native: /mrz-scanner/docs/mobile/programming/react-native/
31+
react_native_api: /mrz-scanner/docs/mobile/programming/react-native/api-reference/
32+
react_native_release_notes: /mrz-scanner/docs/mobile/programming/react-native/release-notes/
33+
2634
dcvb_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
2735
dcvb_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
2836

‎_includes/sidelist-full-tree.html‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
<li lang="objectivec-swift">
2-
<a href="{{ site.ios }}" class="otherLinkColour">MRZ Scanner-iOS Introduction</a>
2+
<a href="{{ site.ios }}" class="otherLinkColour">MRZ Scanner iOS Introduction</a>
33
</li>
44
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
55
<li lang="android">
6-
<a href="{{ site.android }}" class="otherLinkColour">MRZ Scanner-Android Introduction</a>
6+
<a href="{{ site.android }}" class="otherLinkColour">MRZ Scanner Android Introduction</a>
77
</li>
88
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%}
99
<li lang="maui">
10-
<a href="{{ site.maui }}" class="otherLinkColour">MRZ Scanner-MAUI Introduction</a>
10+
<a href="{{ site.maui }}" class="otherLinkColour">MRZ Scanner MAUI Introduction</a>
1111
</li>
1212
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
13+
<li lang="flutter">
14+
<a href="{{ site.flutter }}" class="otherLinkColour">MRZ Scanner Flutter Introduction</a>
15+
</li>
16+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
17+
<li lang="maui">
18+
<a href="{{ site.react_native }}" class="otherLinkColour">MRZ Scanner React Native Introduction</a>
19+
</li>
20+
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
21+

‎_includes/sidelist-programming/programming-flutter.html‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<li lang="flutter" class="category">DEVELOPMENT</li>
2+
3+
<li lang="flutter" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
4+
<ul lang="flutter" >
5+
<li lang="flutter" ><a href="{{ site.flutter }}user-guide/index.html" class="otherLinkColour">MRZ Scanner User Guide</a> </li>
6+
<li lang="flutter" ><a href="{{ site.flutter }}user-guide/customize-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Customization</a></li>
7+
</ul>
8+
</li>
9+
<li lang="flutter"><a href="{{ site.flutter }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
10+
11+
<li lang="flutter"><a href="{{ site.flutter_api }}index.html" class="otherLinkColour">API Reference</a>
12+
<ul lang="flutter">
13+
<li lang="flutter"><a>Classes</a>
14+
<ul lang="flutter">
15+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-scanner.html" class="otherLinkColour">MRZScanner</a></li>
16+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-scanner-config.html" class="otherLinkColour">MRZScannerConfig</a></li>
17+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-scan-result.html" class="otherLinkColour">MRZScanResult</a></li>
18+
<li lang="flutter"><a href="{{ site.flutter_api }}mrz-data.html" class="otherLinkColour">MRZData</a></li>
19+
</ul>
20+
</li>
21+
<li lang="flutter"><a class="otherLinkColour">Enumerations</a>
22+
<ul lang="flutter">
23+
<li lang="flutter"><a href="{{ site.flutter_api }}document-type.html?lang=flutter" class="otherLinkColour">EnumDocumentType</a></li>
24+
</ul>
25+
<ul lang="flutter">
26+
<li lang="flutter"><a href="{{ site.flutter_api }}result-status.html?lang=flutter" class="otherLinkColour">EnumResultStatus</a></li>
27+
</ul>
28+
</li>
29+
</ul>
30+
</li>
31+
32+
<li lang="flutter" class="category">USEFUL RESOURCES</li>
33+
34+
<li lang="flutter" ><a href="{{ site.flutter_release_notes }}" class="otherLinkColour">Release Notes</a>
35+
<ul lang="flutter" >
36+
<li lang="flutter" ><a href="{{ site.flutter_release_notes }}index.html" class="otherLinkColour">Version 3.x</a></li>
37+
</ul>
38+
</li>
39+
40+
<li lang="flutter" ><a href="{{ site.flutter }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
41+
42+
<li lang="flutter" class="category">OTHERS</li>
43+
<li lang="flutter" ><a target="_blank" href="{{ site.ios }}" class="otherLinkColour refreshLink">Develop for iOS (Objective-C & Swift)</a></li>
44+
<li lang="flutter" ><a target="_blank" href="{{ site.android }}" class="otherLinkColour refreshLink">Develop for Android (Java & Kotlin)</a></li>
45+
<li lang="react-native" ><a target="_blank" href="{{ site.maui }}" class="otherLinkColour refreshLink">Develop for MAUI</a></li>
46+
<li lang="react-native" ><a target="_blank" href="{{ site.react_native }}" class="otherLinkColour refreshLink">Develop for React Native</a></li>
47+

‎_includes/sidelist-programming/programming-react-native.html‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
<li lang="react-native" class="category">DEVELOPMENT</li>
2+
3+
<li lang="react-native" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
4+
<ul lang="react-native" >
5+
<li lang="react-native" ><a href="{{ site.react_native }}user-guide/index.html" class="otherLinkColour">MRZ Scanner User Guide</a> </li>
6+
<li lang="react-native" ><a href="{{ site.react_native }}user-guide/customize-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Customization</a></li>
7+
</ul>
8+
</li>
9+
<li lang="react-native"><a href="{{ site.react_native }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
10+
11+
<li lang="react-native"><a href="{{ site.react_native_api }}index.html" class="otherLinkColour">API Reference</a>
12+
<ul lang="react-native">
13+
<li lang="react-native"><a>Classes</a>
14+
<ul lang="react-native">
15+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-scanner.html" class="otherLinkColour">MRZScanner</a></li>
16+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-scanner-config.html" class="otherLinkColour">MRZScannerConfig</a></li>
17+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-scan-result.html" class="otherLinkColour">MRZScanResult</a></li>
18+
<li lang="react-native"><a href="{{ site.react_native_api }}mrz-data.html" class="otherLinkColour">MRZData</a></li>
19+
</ul>
20+
</li>
21+
<li lang="react-native"><a class="otherLinkColour">Enumerations</a>
22+
<ul lang="react-native">
23+
<li lang="react-native"><a href="{{ site.react_native_api }}document-type.html?lang=react_native" class="otherLinkColour">EnumDocumentType</a></li>
24+
</ul>
25+
<ul lang="react-native">
26+
<li lang="react-native"><a href="{{ site.react_native_api }}result-status.html?lang=react_native" class="otherLinkColour">EnumResultStatus</a></li>
27+
</ul>
28+
</li>
29+
</ul>
30+
</li>
31+
32+
<li lang="react-native" class="category">USEFUL RESOURCES</li>
33+
34+
<li lang="react-native" ><a href="{{ site.react_native_release_notes }}" class="otherLinkColour">Release Notes</a>
35+
<ul lang="react-native" >
36+
<li lang="react-native" ><a href="{{ site.react_native_release_notes }}index.html" class="otherLinkColour">Version 3.x</a></li>
37+
</ul>
38+
</li>
39+
40+
<li lang="react-native" ><a href="{{ site.react_native }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
41+
42+
<li lang="react-native" class="category">OTHERS</li>
43+
<li lang="react-native" ><a target="_blank" href="{{ site.ios }}" class="otherLinkColour refreshLink">Develop for iOS (Objective-C & Swift)</a></li>
44+
<li lang="react-native" ><a target="_blank" href="{{ site.android }}" class="otherLinkColour refreshLink">Develop for Android (Java & Kotlin)</a></li>
45+
<li lang="react-native" ><a target="_blank" href="{{ site.maui }}" class="otherLinkColour refreshLink">Develop for MAUI</a></li>
46+
<li lang="react-native" ><a target="_blank" href="{{ site.flutter }}" class="otherLinkColour refreshLink">Develop for Flutter</a></li>
47+

‎programming/flutter/api-reference/mrz-scan-result.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ MRZData? mrzData;
3939

4040
### status
4141

42-
Represents the status of the result, which can be finished, canceled or exception.
42+
Represents the status of the result, which can be finished, canceled or exception. The status comes in the form of a [`EnumResultStatus`](result-status.md).
4343

4444
```dart
4545
EnumResultStatus status;
@@ -55,15 +55,15 @@ The result status can be one of three things:
5555

5656
### errorCode
5757

58-
Represents the error code should something go wrong during the MRZ scanning process.
58+
Returns the error code when an exception occurs. This value is only valid when resultStatus is `exception`.
5959

6060
```dart
6161
int? errorCode;
6262
```
6363

6464
### errorString
6565

66-
Represents the error message associated with the error code should something go wrong during the MRZ scanning process.
66+
Returns the error message associated with the error code when an exception occurs. This value is only valid when resultStatus is `exception`.
6767

6868
```dart
6969
String? errorMessage;

‎programming/flutter/api-reference/mrz-scanner-config.md‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ final class MRZScannerConfig
3434
| [`isBeepEnabled`](#isbeepenabled) | *bool* | Determines whether a beep sound is triggered upon a successful MRZ scan. |
3535
| [`isCloseButtonVisible`](#isclosebuttonvisible) | *bool* | Represents the visibility status of the close button. |
3636
| [`isGuideFrameVisible`](#isguideframevisible) | *bool* | Represents the visibility status of the guide frame on the display. |
37-
| [`isCameraToggleButtonVisible`](#Iscameratogglebuttonvisible) | *bool* | Specifies whether the camera toggle button is displayed or not. |
37+
| [`isCameraToggleButtonVisible`](#iscameratogglebuttonvisible) | *bool* | Specifies whether the camera toggle button is displayed or not. |
38+
| [`isVibrateEnabled`](#isvibrateenabled) | *bool* | Controls the scanner's ability to make the scanning device vibrate upon a successful MRZ scan. |
3839

3940
### license
4041

@@ -92,9 +93,9 @@ Controls the visibility of the close button on the scanner's UI. If true, a clos
9293
bool? isCloseButtonVisible;
9394
```
9495

95-
### IsGuideFrameVisible
96+
### isGuideFrameVisible
9697

97-
Represents the visibility status of the guide frame on the display.
98+
Determines the visibility status of the guide frame on the display. If set to true, a visual overlay will be displayed in the centre of the camera view to allow users to easily line up the MRZ document
9899

99100
```dart
100101
bool IsGuideFrameVisible { get; set; };
@@ -107,3 +108,11 @@ Specifies whether the camera toggle button is displayed. This button lets users
107108
```dart
108109
bool? isCameraToggleButtonVisible;
109110
```
111+
112+
### isVibrateEnabled
113+
114+
Controls the scanner's ability to make the scanning device vibrate upon a successful MRZ scan. When enabled (true), the scanner will vibrate to provide haptic feedback if the device supports it.
115+
116+
```dart
117+
bool? isVibrateEnabled;
118+
```

‎programming/flutter/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ Dynamsoft MRZ Scanner SDK Flutter Edition is designed to integrate the ability t
2323

2424
- Supported OS: **Android 5.0** (API Level 21) or higher.
2525
- Supported ABI: **armeabi-v7a**, **arm64-v8a**, **x86** and **x86_64**.
26-
- Development Environment: Visual Studio 2022 recommended.
26+
- Development Environment: Android Studio 2022.2.1+ (2025.2.1 recommended); Java 17+; Gradle 8.0+
2727
- JDK: 1.8+
2828

2929
#### iOS
3030

3131
- Supported OS: **iOS 13.0** or higher.
3232
- Supported ABI: **arm64** and **x86_64**.
33-
- Development Environment: Visual Studio 2022 for Mac and Xcode 14.3+ recommended.
33+
- Development Environment: Xcode 14.3+ recommended.
3434

3535
### User Guide
3636

@@ -53,7 +53,7 @@ Dynamsoft MRZ Scanner SDK Flutter Edition is designed to integrate the ability t
5353

5454
To develop and run your application with Dynamsoft MRZ Scanner SDK, you need an active license key:
5555

56-
- [Request a 30-day free trial license](https://www.dynamsoft.com/customer/license/trialLicense?utm_source=docs&product=mrz&package=Flutter){:target="_blank"}
56+
- [Request a 30-day free trial license](https://www.dynamsoft.com/customer/license/trialLicense?utm_source=docs&product=mrz&package=flutter){:target="_blank"}
5757

5858
## Contact Us
5959

‎programming/flutter/user-guide/customize-mrz-scanner.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ When developing with `MRZScanner` component (see the [User Guide](index.md)), yo
1515

1616
## `MRZScannerConfig` Overview
1717

18-
The [**`MRZScannerConfig`**]({{ site.api }}mrz-scanner.html#mrzscannerconfig) class is capable of configuring almost all customization options applicable to MRZ scanning use cases with the MRZ Scanner. The MRZ Scanner uses passes an `MRZScannerConfig` object to the constructor when creating an MRZ Scanner instance. `MRZScannerConfig` contains the following properties:
18+
The [**`MRZScannerConfig`**](../api-reference/mrz-scanner-config.md) class is capable of configuring almost all customization options applicable to MRZ scanning use cases with the MRZ Scanner. The MRZ Scanner uses passes an `MRZScannerConfig` object to the constructor when creating an MRZ Scanner instance. `MRZScannerConfig` contains the following properties:
1919

2020
1. **`license`** - the license key is the only property whose ***value must be specified when instantiating the MRZ Scanner instance***. If the license is undefined, invalid, or expired, the MRZ Scanner cannot proceed with scanning, and instead displays a pop-up error message instructing the user to contact the app administrator to resolve this license issue.
2121

2222
2. **`documentType`** - specifies the type of document that the MRZ Scanner will recognize. This property accepts values defined in the EnumDocumentType such as `EnumDocumentType.all`, `EnumDocumentType.id`, or `EnumDocumentType.passport`. It helps the scanner to optimize its processing based on the expected document type. To learn more about the different document types that are supported, please refer to the [Supported Document Types](index.md#supported-machine-readable-travel-document-types) section of the user guide.
2323

2424
3. **`templateFile`** - a template file is a JSON file or JSON string that contains a series of algorithm parameter settings (called Capture Vision templates) that is usually used for very specific and customized scanning and parsing scenarios. The `templateFile` points to the location of the JSON file. The MRZ Scanner comes with a default template file, but you may choose to use a custom template to target specialized use cases. We recommend contacting the [Dynamsoft Technical Support Team](https://www.dynamsoft.com/company/contact/) for assistance with template customization.
2525

26-
4. **`isBeepEnabled`** - a boolean that determines whether a beep sound is triggered upon a successful MRZ scan. When enabled (true), the scanner will play a sound to provide audible feedback.
26+
4. **`isBeepEnabled`** (default value `false`) - a boolean that determines whether a beep sound is triggered upon a successful MRZ scan. When enabled (true), the scanner will play a sound to provide audible feedback.
2727

28-
5. **`isCameraToggleButtonVisible`** - a boolean that specifies whether the camera toggle button is displayed. This button lets users switch between available cameras (e.g., front and rear).
28+
5. **`isCameraToggleButtonVisible`** (default value `false`) - a boolean that specifies whether the camera toggle button is displayed. This button lets users switch between available cameras (e.g., front and rear).
2929

30-
6. **`isCloseButtonVisible`** - a boolean to control the visibility of the close button on the scanner's UI. If true, a close button will be displayed allowing users to exit the MRZ scanning interface.
30+
6. **`isCloseButtonVisible`** (default value `true`) - a boolean to control the visibility of the close button on the scanner's UI. If true, a close button will be displayed allowing users to exit the MRZ scanning interface.
3131

3232
7. **`isGuideFrameVisible`** (default value `true`) - serves as a toggle to show or hide the guide frame in the UI during scanning. The guide frame assists users in properly aligning the document for optimal MRZ detection. When set to true, a visual overlay is displayed on the scanning interface.
3333

34-
8. **`isTorchButtonVisible`** - determines whether the torch (flashlight) toggle button is visible on the scanning interface. Set to true to allow users to switch the device's flashlight on or off during MRZ scanning.
34+
8. **`isTorchButtonVisible`** (default value `true`) - determines whether the torch (flashlight) toggle button is visible on the scanning interface. Set to true to allow users to switch the device's flashlight on or off during MRZ scanning.
3535

36-
9. **`isVibrateEnabled`** - controls the scanner's ability to make the scanning device vibrate upon a successful MRZ scan. When enabled (true), the scanner will vibrate to provide haptic feedback if the device supports it.
36+
9. **`isVibrateEnabled`** (default value `false`) - controls the scanner's ability to make the scanning device vibrate upon a successful MRZ scan. When enabled (true), the scanner will vibrate to provide haptic feedback if the device supports it.
3737

3838
Next, we go over the different ways that these properties can be used to customize the scanner with a few examples.
3939

0 commit comments

Comments
 (0)