Preview

_config.yml

@@ -23,6 +23,14 @@ maui_api: /mrz-scanner/docs/mobile/programming/maui/api-reference/
 maui_release_notes: /mrz-scanner/docs/mobile/programming/maui/release-notes/
 maui_faq: /mrz-scanner/docs/mobile/programming/maui/faq/
 
+flutter: /mrz-scanner/docs/mobile/programming/flutter/
+flutter_api: /mrz-scanner/docs/mobile/programming/flutter/api-reference/
+flutter_release_notes: /mrz-scanner/docs/mobile/programming/flutter/release-notes/
+
+react_native: /mrz-scanner/docs/mobile/programming/react-native/
+react_native_api: /mrz-scanner/docs/mobile/programming/react-native/api-reference/
+react_native_release_notes: /mrz-scanner/docs/mobile/programming/react-native/release-notes/
+
 dcvb_android_api: /capture-vision/docs/mobile/programming/android/api-reference/
 dcvb_ios_api: /capture-vision/docs/mobile/programming/ios/api-reference/
 

_includes/sidelist-full-tree.html

@@ -1,12 +1,21 @@
 <li lang="objectivec-swift">
-    <a href="{{ site.ios }}" class="otherLinkColour">MRZ Scanner-iOS Introduction</a>
+    <a href="{{ site.ios }}" class="otherLinkColour">MRZ Scanner iOS Introduction</a>
 </li>
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-ios.html" -%}
 <li lang="android">
-    <a href="{{ site.android }}" class="otherLinkColour">MRZ Scanner-Android Introduction</a>
+    <a href="{{ site.android }}" class="otherLinkColour">MRZ Scanner Android Introduction</a>
 </li>
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-android.html" -%}
 <li lang="maui">
-    <a href="{{ site.maui }}" class="otherLinkColour">MRZ Scanner-MAUI Introduction</a>
+    <a href="{{ site.maui }}" class="otherLinkColour">MRZ Scanner MAUI Introduction</a>
 </li>
 {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
+<li lang="flutter">
+    <a href="{{ site.flutter }}" class="otherLinkColour">MRZ Scanner Flutter Introduction</a>
+</li>
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
+<li lang="maui">
+    <a href="{{ site.react_native }}" class="otherLinkColour">MRZ Scanner React Native Introduction</a>
+</li>
+{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-programming/programming-maui.html" -%}
+

_includes/sidelist-programming/programming-flutter.html

@@ -0,0 +1,47 @@
+<li lang="flutter" class="category">DEVELOPMENT</li>
+
+<li lang="flutter" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
+    <ul lang="flutter" >
+        <li lang="flutter" ><a href="{{ site.flutter }}user-guide/index.html" class="otherLinkColour">MRZ Scanner User Guide</a> </li>
+        <li lang="flutter" ><a href="{{ site.flutter }}user-guide/customize-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Customization</a></li>
+    </ul>
+</li>
+<li lang="flutter"><a href="{{ site.flutter }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
+
+<li lang="flutter"><a href="{{ site.flutter_api }}index.html" class="otherLinkColour">API Reference</a>
+    <ul lang="flutter">
+        <li lang="flutter"><a>Classes</a>
+            <ul lang="flutter">
+                <li lang="flutter"><a href="{{ site.flutter_api }}mrz-scanner.html" class="otherLinkColour">MRZScanner</a></li>
+                <li lang="flutter"><a href="{{ site.flutter_api }}mrz-scanner-config.html" class="otherLinkColour">MRZScannerConfig</a></li>
+                <li lang="flutter"><a href="{{ site.flutter_api }}mrz-scan-result.html" class="otherLinkColour">MRZScanResult</a></li>
+                <li lang="flutter"><a href="{{ site.flutter_api }}mrz-data.html" class="otherLinkColour">MRZData</a></li>
+            </ul>
+        </li>
+        <li lang="flutter"><a class="otherLinkColour">Enumerations</a>
+            <ul lang="flutter">
+                <li lang="flutter"><a href="{{ site.flutter_api }}document-type.html?lang=flutter"  class="otherLinkColour">EnumDocumentType</a></li>
+            </ul>
+            <ul lang="flutter">
+                <li lang="flutter"><a href="{{ site.flutter_api }}result-status.html?lang=flutter"  class="otherLinkColour">EnumResultStatus</a></li>
+            </ul>
+        </li>
+    </ul>
+</li>
+
+<li lang="flutter" class="category">USEFUL RESOURCES</li>
+
+<li lang="flutter" ><a href="{{ site.flutter_release_notes }}" class="otherLinkColour">Release Notes</a>
+    <ul lang="flutter" >
+        <li lang="flutter" ><a href="{{ site.flutter_release_notes }}index.html" class="otherLinkColour">Version 3.x</a></li>
+    </ul>
+</li>
+
+<li lang="flutter" ><a href="{{ site.flutter }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
+
+<li lang="flutter" class="category">OTHERS</li>
+<li lang="flutter" ><a target="_blank" href="{{ site.ios }}" class="otherLinkColour refreshLink">Develop for iOS (Objective-C & Swift)</a></li>
+<li lang="flutter" ><a target="_blank" href="{{ site.android }}" class="otherLinkColour refreshLink">Develop for Android (Java & Kotlin)</a></li>
+<li lang="react-native" ><a target="_blank" href="{{ site.maui }}" class="otherLinkColour refreshLink">Develop for MAUI</a></li>
+<li lang="react-native" ><a target="_blank" href="{{ site.react_native }}" class="otherLinkColour refreshLink">Develop for React Native</a></li>
+

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

@@ -0,0 +1,47 @@
+<li lang="react-native" class="category">DEVELOPMENT</li>
+
+<li lang="react-native" ><a style="cursor:pointer;color:#3c3c3c">User Guide</a>
+    <ul lang="react-native" >
+        <li lang="react-native" ><a href="{{ site.react_native }}user-guide/index.html" class="otherLinkColour">MRZ Scanner User Guide</a> </li>
+        <li lang="react-native" ><a href="{{ site.react_native }}user-guide/customize-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Customization</a></li>
+    </ul>
+</li>
+<li lang="react-native"><a href="{{ site.react_native }}samples/index.html" class="otherLinkColour">Demo &amp; Samples</a></li>
+
+<li lang="react-native"><a href="{{ site.react_native_api }}index.html" class="otherLinkColour">API Reference</a>
+    <ul lang="react-native">
+        <li lang="react-native"><a>Classes</a>
+            <ul lang="react-native">
+                <li lang="react-native"><a href="{{ site.react_native_api }}mrz-scanner.html" class="otherLinkColour">MRZScanner</a></li>
+                <li lang="react-native"><a href="{{ site.react_native_api }}mrz-scanner-config.html" class="otherLinkColour">MRZScannerConfig</a></li>
+                <li lang="react-native"><a href="{{ site.react_native_api }}mrz-scan-result.html" class="otherLinkColour">MRZScanResult</a></li>
+                <li lang="react-native"><a href="{{ site.react_native_api }}mrz-data.html" class="otherLinkColour">MRZData</a></li>
+            </ul>
+        </li>
+        <li lang="react-native"><a class="otherLinkColour">Enumerations</a>
+            <ul lang="react-native">
+                <li lang="react-native"><a href="{{ site.react_native_api }}document-type.html?lang=react_native"  class="otherLinkColour">EnumDocumentType</a></li>
+            </ul>
+            <ul lang="react-native">
+                <li lang="react-native"><a href="{{ site.react_native_api }}result-status.html?lang=react_native"  class="otherLinkColour">EnumResultStatus</a></li>
+            </ul>
+        </li>
+    </ul>
+</li>
+
+<li lang="react-native" class="category">USEFUL RESOURCES</li>
+
+<li lang="react-native" ><a href="{{ site.react_native_release_notes }}" class="otherLinkColour">Release Notes</a>
+    <ul lang="react-native" >
+        <li lang="react-native" ><a href="{{ site.react_native_release_notes }}index.html" class="otherLinkColour">Version 3.x</a></li>
+    </ul>
+</li>
+
+<li lang="react-native" ><a href="{{ site.react_native }}user-guide/license-activation.html" class="otherLinkColour">License Initialization</a></li>
+
+<li lang="react-native" class="category">OTHERS</li>
+<li lang="react-native" ><a target="_blank" href="{{ site.ios }}" class="otherLinkColour refreshLink">Develop for iOS (Objective-C & Swift)</a></li>
+<li lang="react-native" ><a target="_blank" href="{{ site.android }}" class="otherLinkColour refreshLink">Develop for Android (Java & Kotlin)</a></li>
+<li lang="react-native" ><a target="_blank" href="{{ site.maui }}" class="otherLinkColour refreshLink">Develop for MAUI</a></li>
+<li lang="react-native" ><a target="_blank" href="{{ site.flutter }}" class="otherLinkColour refreshLink">Develop for Flutter</a></li>
+

programming/flutter/api-reference/document-type.md

@@ -0,0 +1,35 @@
+---
+layout: default-layout
+title: EnumDocumentType - Dynamsoft MRZ Scanner Flutter Edition
+description: EnumDocumentType of DynamsoftMRZScanner Flutter is an enumeration class that defines the result status of the MRZScanResult.
+keywords: document type, id cards, passports
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: EnumDocumentType
+---
+
+# EnumDocumentType
+
+`EnumDocumentType` is an enumeration class that defines the type of document to scan, such as ID cards or passports.
+
+## Definition
+
+*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
+
+```dart
+public enum EnumDocumentType
+{
+    all, // supports both ID cards (TD1 and TD2) and passports (TD3)
+    id, // only supports ID cards (TD1 and TD2)
+    passport // only supports passports (TD3)
+}
+```
+
+## Members
+
+| Member | Description |
+| ------ | ----------- |
+| `all` | Supports both ID cards (TD1 and TD2) and passports (TD3) |
+| `id` | Only supports ID cards (TD1 and TD2) |
+| `passport` | Only supports passports (TD3) |
+

programming/flutter/api-reference/index.md

@@ -0,0 +1,21 @@
+---
+layout: default-layout
+title: MRZScanner API reference - Dynamsoft MRZ Scanner Flutter Edition
+description: This is the main page of MRZScanner API Reference for Flutter Language.
+keywords: MRZScanner, api reference, Flutter
+---
+
+# MRZScanner API References
+
+`MRZScanner` is a ready-to-use component that enables developers to quickly set up an app for scanning MRZ codes on passports and ID cards. The `MRZScanner` simplifies the integration of MRZ scanning functionality into any application, making it easy to extract and process information from travel and identity documents.
+
+## Classes
+
+| Class | Description |
+| ----- | ----------- |
+| [`MRZScanner`](mrz-scanner.md) | The main class of `MRZScanner` component. It is an activity class that implements MRZ scanning features. |
+| [`MRZScannerConfig`](mrz-scanner-config.md) | The class that provides MRZ scanning configurations. |
+| [`MRZScanResult`](mrz-scan-result.md) | The MRZ scan result class. |
+| [`MRZData`](mrz-data.md) | The class that contains the parsed MRZ information. |
+| [`EnumResultStatus`](result-status.md) | A enumeration class that describes the result status. |
+| [`EnumDocumentType`](document-type.md) | A enumeration class that defines the type of document to scan, such as ID cards or passports. |

programming/flutter/api-reference/mrz-data.md

@@ -0,0 +1,125 @@
+---
+layout: default-layout
+title: MRZData Class - Dynamsoft MRZ Scanner Flutter Edition
+description: MRZData of DynamsoftMRZScanner Flutter is a result class that contains the parsed MRZ information.
+keywords: MRZ, scanner, scan result
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: MRZData
+---
+
+# MRZData
+
+`MRZData` is a result class that is used to represent the parsed MRZ information.
+
+## Definition
+
+*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
+
+```dart
+class MRZData
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`firstName`](#firstname) | *String* | The first name of the MRZ document holder. |
+| [`lastName`](#lastname) | *String* | The last name of the MRZ document holder. |
+| [`sex`](#sex) | *String* | The sex of the MRZ document holder. |
+| [`issuingState`](#issuingstate) | *String* | The issuing state (represented as the full name of the country/region) of the MRZ document. |
+| [`nationality`](#nationality) | *String* | The nationality (represented as the full name of the country/region) of the MRZ document holder. |
+| [`dateOfBirth`](#dateofbirth) | *String* | The date of birth of the MRZ document holder. |
+| [`dateOfExpire`](#dateofexpire) | *String* | The expiry date of the MRZ document. |
+| [`documentType`](#documenttype) | *String* | The type of MRTD that the MRZ document is. |
+| [`documentNumber`](#documentnumber) | *String* | The MRZ document number. |
+| [`age`](#age) | *int* | The age of the MRZ document holder. |
+| [`mrzText`](#mrztext) | *String* | The raw unparsed text of the MRZ. |
+
+### firstName
+
+Represents the first name of the MRZ document holder.
+
+```dart
+String firstName;
+```
+
+### lastName
+
+Represents the last name of the MRZ document holder.
+
+```dart
+String lastName;
+```
+
+### sex
+
+Represents the sex of the MRZ document holder.
+
+```dart
+String sex;
+```
+
+### issuingState
+
+Represents the issuing state of the MRZ document.
+
+```dart
+String issuingState;
+```
+
+### nationality
+
+Represents the nationality of the MRZ document holder.
+
+```dart
+String nationality;
+```
+
+### dateOfBirth
+
+Represents the date of birth of the MRZ document holder.
+
+```dart
+String dateOfBirth;
+```
+
+### dateOfExpire
+
+Represents the expiry date of the MRZ document.
+
+```dart
+String dateOfExpire;
+```
+
+### documentType
+
+Represents the type of MRZ document.
+
+```dart
+String documentType;
+```
+
+### documentNumber
+
+Represents the MRZ document number.
+
+```dart
+String documentNumber;
+```
+
+### age
+
+Represents the age of the MRZ document holder.
+
+```dart
+int age;
+```
+
+### mrzText
+
+Represents the raw text of the MRZ.
+
+```dart
+String mrzText;
+```

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

@@ -0,0 +1,70 @@
+---
+layout: default-layout
+title: MRZScanResult Class - Dynamsoft MRZ Scanner Flutter Edition
+description: MRZScanResult of DynamsoftMRZScanner Flutter is a result class that contains the parsed MRZ information from one scan and the additional information.
+keywords: MRZ, scanner, scan result
+needAutoGenerateSidebar: true
+needGenerateH3Content: true
+breadcrumbText: MRZScanResult
+---
+
+# MRZScanResult
+
+`MRZScanResult` is the most basic class to represent the full MRZ result object. It comes with a result status and the parsed MRZ info as a MRZData object.
+
+## Definition
+
+*Assembly:* dynamsoft_mrz_scanner_bundle_flutter
+
+```dart
+class MRZScanResult
+```
+
+## Properties
+
+| Property | Type | Description |
+| -------- | ---- | ----------- |
+| [`mrzData`](#mrzdata) | [*MRZData?*](mrz-data.md) | Represents the parsed MRZ data. |
+| [`status`](#status) | [*EnumResultStatus*](result-status.md) | Represents the status of the result, which can be finished, canceled or exception. |
+| [`errorCode`](#errorcode) | *int?* | Represents the error code should something go wrong during the MRZ scanning process. |
+| [`errorString`](#errorstring) | *String?* | Represents the error message associated with the error code should something go wrong during the MRZ scanning process. |
+
+### mrzData
+
+Represents the parsed MRZ information as a [`MRZData`](mrz-data.md) object.
+
+```dart
+MRZData? mrzData;
+```
+
+### status
+
+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).
+
+```dart
+EnumResultStatus status;
+```
+
+**Remarks**
+
+The result status can be one of three things:
+
+- `finished`: The MRZ scanning is finished.
+- `canceled`: The MRZ scanning activity is closed before the process is finished.
+- `exception`: Failed to start MRZ scanning or an error occurs when scanning the MRZ.
+
+### errorCode
+
+Returns the error code when an exception occurs. This value is only valid when resultStatus is `exception`.
+
+```dart
+int? errorCode;
+```
+
+### errorString
+
+Returns the error message associated with the error code when an exception occurs. This value is only valid when resultStatus is `exception`.
+
+```dart
+String? errorMessage;
+```