Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions _includes/sidelist-api-v2.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<li><a class="otherLinkColour">API Reference</a>
<ul>
<li><a href="{{ site.api }}mrz-scanner-v2.0.html" class="otherLinkColour">MRZ Scanner API</a></li>
</ul>
<ul>
<li><a href="{{ site.api }}enums-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Enumerations</a></li>
</ul>
</li>
8 changes: 8 additions & 0 deletions _includes/sidelist-api-v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<li><a class="otherLinkColour">API Reference</a>
<ul>
<li><a href="{{ site.api }}mrz-scanner-v2.1.html" class="otherLinkColour">MRZ Scanner API</a></li>
</ul>
<ul>
<li><a href="{{ site.api }}enums-mrz-scanner.html" class="otherLinkColour">MRZ Scanner Enumerations</a></li>
</ul>
</li>
11 changes: 11 additions & 0 deletions _includes/sidelist-codegallery-v2.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<li><a href="{{ site.codegallery }}index.html" class="otherLinkColour">Code Gallery</a>
<ul>
<li><a href="{{ site.codegallery }}helloworld/index.html" class="otherLinkColour">Hello World</a></li>
</ul>
<ul>
<li><a href="{{ site.codegallery }}index.html#frameworks" class="otherLinkColour">Frameworks</a></li>
</ul>
<ul>
<li><a href="{{ site.codegallery }}demo/index.html" class="otherLinkColour">Demo</a></li>
</ul>
</li>
11 changes: 11 additions & 0 deletions _includes/sidelist-codegallery-v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<li><a href="{{ site.codegallery }}index.html" class="otherLinkColour">Code Gallery</a>
<ul>
<li><a href="{{ site.codegallery }}helloworld/index.html" class="otherLinkColour">Hello World</a></li>
</ul>
<ul>
<li><a href="{{ site.codegallery }}index.html#frameworks" class="otherLinkColour">Frameworks</a></li>
</ul>
<ul>
<li><a href="{{ site.codegallery }}demo/index.html" class="otherLinkColour">Demo</a></li>
</ul>
</li>
6 changes: 6 additions & 0 deletions _includes/sidelist-full-tree-v2.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction-v2.0.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides-v2.0.html" -%}
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%} -->
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery-v2.0.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api-v2.0.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes-v2.0.html" -%}
6 changes: 6 additions & 0 deletions _includes/sidelist-full-tree-v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-introduction-v2.1.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-guides-v2.1.html" -%}
<!-- {%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-gettingstarted.html" -%} -->
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-codegallery-v2.1.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-api-v2.1.html" -%}
{%- include liquid_searchVersionTreeFile.html ver=include.ver curPath=include.curPath targetRelativePath="sidelist-releasenotes-v2.1.html" -%}
6 changes: 6 additions & 0 deletions _includes/sidelist-guides-v2.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<li><a class="otherLinkColour">Developer Guides</a>
<ul>
<li><a href="{{ site.guides }}mrz-scanner-v2.0.html" class="otherLinkColour">MRZ Scanner User Guide</a></li>
<li><a href="{{ site.guides }}mrz-scanner-customization-v2.0.html" class="otherLinkColour">MRZ Scanner Customization Guide</a></li>
</ul>
</li>
7 changes: 7 additions & 0 deletions _includes/sidelist-guides-v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
<li><a class="otherLinkColour">Developer Guides</a>
<ul>
<li><a href="{{ site.guides }}mrz-scanner-v2.1.html" class="otherLinkColour">MRZ Scanner User Guide</a></li>
<li><a href="{{ site.guides }}mrz-scanner-customization-v2.1.html" class="otherLinkColour">MRZ Scanner Customization Guide</a></li>
<li><a href="{{ site.guides }}mrz-scanner-static-image.html" class="otherLinkColour">MRZ Scanner - Reading Static Images</a></li>
</ul>
</li>
1 change: 1 addition & 0 deletions _includes/sidelist-introduction-v2.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<li><a href="{{ site.introduction }}index.html" class="otherLinkColour">Introduction</a></li>
1 change: 1 addition & 0 deletions _includes/sidelist-introduction-v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<li><a href="{{ site.introduction }}index.html" class="otherLinkColour">Introduction</a></li>
1 change: 1 addition & 0 deletions _includes/sidelist-releasenotes-v2.0.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<li><a href="{{ site.releasenotes }}index.html" class="otherLinkColour">Release Notes</a></li>
1 change: 1 addition & 0 deletions _includes/sidelist-releasenotes-v2.1.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<li><a href="{{ site.releasenotes }}index.html" class="otherLinkColour">Release Notes</a></li>
6 changes: 4 additions & 2 deletions api/mrz-scanner-v2.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -235,6 +235,7 @@ interface MRZResultViewConfig {
| `container` | `HTMLElement \ string` | The container element or selector for the `MRZResultView` UI. |
| `toolbarButtonsConfig` | `MRZResultViewToolbarButtonsConfig` | Configures the main bottom toolbar of the result view. |
| `showOriginalImage` | `boolean` | Determines whether the cropped image of the MRZ document will be displayed in the result view or not. |
| `showMRZText` | `boolean` | Displays/hides the raw MRZ text as one of the result fields in the result view. |
| `allowResultEditing` | `boolean` | Enables/disables the ability to edit the MRZ info after it is scanned. |
| `onDone` | `Promise<void>` | Defines the action(s) to take once the user clicks the "Done" button in the result view. |

Expand All @@ -243,6 +244,7 @@ interface MRZResultViewConfig {
```ts
const mrzResultViewConfig = {
showOriginalImage: false, // Hides the cropped image of the MRZ document in the result view; true by default
showMRZText: false, // Hides the raw MRZ text as a result field.
toolbarButtonsConfig: {
retake: {
label: "Re-scan", // Changes the text label of the retake button to "Re-scan"; string is "Re-take" by default
Expand Down Expand Up @@ -403,8 +405,8 @@ export interface MRZData {
| `lastName` | `string` | The last name of the MRZ document holder. |
| `age` | `string` | The age of the MRZ document holder. |
| `sex` | `string` | The sex of the MRZ document holder. |
| `issuingState` | `string` | The issuing state (represented as the full name of the country/region) of the MRZ document. |
| `nationality` | `string` | The nationality (represented as the full name of the country/region) of the MRZ document holder. |
| `issuingState` | `string` | The issuing state of the MRZ document. |
| `nationality` | `string` | The nationality of the MRZ document holder. |
| `dateOfBirth` | `MRZDate` | The date of birth of the MRZ document holder. |
| `dateOfExpiry` | `MRZDate` | The date of expiry of the MRZ document. |

Expand Down
Loading