Skip to content

Commit 4e94cbb

Browse files
dynamsoft-hdynamsoft-h
committed
Squashed commit of the following:
commit ae93323 Author: dynamsoft-h <[email protected]> Date: Thu Sep 4 17:50:07 2025 -0700 docs: fix formatting commit 13b548a Author: dynamsoft-h <[email protected]> Date: Thu Sep 4 17:14:29 2025 -0700 docs: add v1.3.0 release notes commit ca757fe Author: dynamsoft-h <[email protected]> Date: Thu Sep 4 17:14:17 2025 -0700 docs: update CDN package version to v1.3.0 commit 4568f23 Author: dynamsoft-h <[email protected]> Date: Thu Sep 4 17:13:41 2025 -0700 docs: formatting commit 0eacdec Author: dynamsoft-h <[email protected]> Date: Wed Sep 3 15:59:07 2025 -0700 docs: add framework guide links and side tree commit e882a00 Author: dynamsoft-h <[email protected]> Date: Wed Sep 3 13:02:50 2025 -0700 docs: fix MDS guide commit 6a91ab9 Author: dynamsoft-h <[email protected]> Date: Tue Sep 2 16:36:57 2025 -0700 docs: fix MDS framework guides commit a41bdf6 Author: dynamsoft-h <[email protected]> Date: Sun Aug 31 00:18:55 2025 -0700 docs: fix guide heading commit 8eb1ea3 Author: dynamsoft-h <[email protected]> Date: Sun Aug 31 00:18:06 2025 -0700 docs: update angular and react guide content commit 2e27515 Author: dynamsoft-h <[email protected]> Date: Fri Aug 29 20:39:00 2025 -0700 docs: add framework guides commit e5bdf7e Author: dynamsoft-h <[email protected]> Date: Fri Aug 29 11:10:20 2025 -0700 docs: minor MWC content fix commit 50a099c Author: dynamsoft-h <[email protected]> Date: Fri Aug 29 11:09:38 2025 -0700 docs: fix broken link commit 4d93606 Author: dynamsoft-h <[email protected]> Date: Fri Aug 29 10:58:52 2025 -0700 docs: minor fixes to MDS developer guide content commit 5a1ad73 Author: dynamsoft-h <[email protected]> Date: Thu Aug 28 18:26:16 2025 -0700 docs: update MDS developer guide content commit 28567c8 Author: dynamsoft-h <[email protected]> Date: Fri Aug 1 17:43:14 2025 -0700 fix: use correct JSDelivr page link commit 7bdac00 Author: dynamsoft-h <[email protected]> Date: Fri Aug 1 17:40:22 2025 -0700 fix: use X.y.z versioning commit 5a24986 Author: dynamsoft-h <[email protected]> Date: Fri Aug 1 17:37:14 2025 -0700 feat: add note about MWC rewrite in release notes commit f7b5324 Author: dynamsoft-h <[email protected]> Date: Tue Jul 22 16:07:51 2025 -0700 fix: add more descriptions and links for self hosting commit e244278 Author: dynamsoft-h <[email protected]> Date: Tue Jul 22 15:45:46 2025 -0700 fix: use different link due to section loading order
1 parent 23f859f commit 4e94cbb

File tree

9 files changed

+380
-147
lines changed

9 files changed

+380
-147
lines changed

‎_includes/sidelist-guide.html‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,7 @@
11
<li><a href="{{ site.guide }}index.html" class="otherLinkColour">Developer Guide</a>
2+
<ul>
3+
<li><a href="{{ site.guide }}angular.html" class="otherLinkColour">Angular Guide</a></li>
4+
<li><a href="{{ site.guide }}angular.html" class="otherLinkColour">React Guide</a></li>
5+
<li><a href="{{ site.guide }}angular.html" class="otherLinkColour">Vue Guide</a></li>
6+
</ul>
27
</li>

‎api/index.md‎

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ async launch(file?: File): Promise<DocumentResult>
7272
- A `Promise` resolving to a [`DocumentResult`](#documentresult) object.
7373

7474
#### Example
75-
```typescript
75+
```javascript
7676
const result = await documentScanner.launch();
7777

7878
if (result?.correctedImageResult) {
@@ -94,7 +94,7 @@ dispose(): void
9494
```
9595
9696
#### Example
97-
```typescript
97+
```javascript
9898
documentScanner.dispose();
9999
console.log("Scanner resources released.");
100100
```
@@ -131,7 +131,7 @@ interface DocumentScannerConfig {
131131
| `engineResourcePaths` | [`EngineResourcePaths`](#engineresourcepaths) | Paths to the necessary resources for the scanning engine. You may set custom paths to self-host resources, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details. |
132132
133133
#### Example
134-
```typescript
134+
```javascript
135135
const config = {
136136
license: "YOUR_LICENSE_KEY_HERE",
137137
scannerViewConfig: {
@@ -175,7 +175,7 @@ interface DocumentScannerViewConfig {
175175
| `templateFilePath` | `string` | Path to a Capture Vision template for scanning configuration. |
176176
| `cameraEnhancerUIPath` | `string` | Path to the UI (`.html` template file) for the scanner view. You may set custom paths to self-host or customize the template, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details. |
177177
| `container` | `HTMLElement` | The container element for the scanner view. |
178-
| `utilizedTemplateNames` | `[`UtilizedTemplateNames`](#utilizedtemplatenames)` | Capture Vision template names for detection and correction. |
178+
| `utilizedTemplateNames` | [`UtilizedTemplateNames`](#utilizedtemplatenames) | Capture Vision template names for detection and correction. |
179179
| `enableAutoCropMode` | `boolean` | The default auto-crop mode state. |
180180
| `enableSmartCaptureMode` | `boolean` | The default smart capture mode state. |
181181
| `scanRegion` | [`ScanRegion`](#scanregion) | Defines the region within the viewport to detect documents. |
@@ -184,7 +184,6 @@ interface DocumentScannerViewConfig {
184184
| `showPoweredByDynamsoft` | `boolean` | Visibility of the Dynamsoft branding message. |
185185
186186
#### Example
187-
188187
```javascript
189188
const documentScanner = new Dynamsoft.DocumentScanner({
190189
license: "YOUR_LICENSE_KEY_HERE", // Replace with your actual license key
@@ -216,7 +215,6 @@ interface DocumentCorrectionViewConfig {
216215
| `onFinish` | `(result: DocumentResult) => void` | Callback function triggered when correction is finished. |
217216
218217
#### Example
219-
220218
```javascript
221219
const documentScanner = new Dynamsoft.DocumentScanner({
222220
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
@@ -298,7 +296,6 @@ Describes the scan region within the viewfinder for document scanning:
298296
3. Create a visual border for the scanning region boundary on the viewfinder with a given stroke width in pixels, and a stroke color.
299297
300298
#### Syntax
301-
302299
```typescript
303300
interface ScanRegion {
304301
ratio: {
@@ -321,9 +318,9 @@ interface ScanRegion {
321318
| »`height` | `number` | The height of the rectangular scan region. |
322319
| »`width` | `number` | The width of the rectangular scan region. |
323320
| `regionBottomMargin` | `number` | Bottom margin below the scan region measured in pixels. |
321+
| `style` | `object` | The styling for the scan region outline in the viewfinder. |
324322
| »`strokeWidth` | `number` | The pixel width of the outline of the scan region. |
325323
| »`strokeColor` | `string` | The color of the outline of the scan region. |
326-
| `style` | `object` | The styling for the scan region outline in the viewfinder. |
327324
328325
#### Example
329326
@@ -363,7 +360,7 @@ export type ToolbarButtonConfig = Pick<"icon" | "label" | "isHidden">;
363360
| `isHidden` | `boolean` (optional) | Determines if the button is hidden. |
364361
365362
#### Example
366-
```typescript
363+
```javascript
367364
const documentScanner = new Dynamsoft.DocumentScanner({
368365
license: "YOUR_LICENSE_KEY_HERE", // Replace this with your actual license key
369366
correctionViewConfig: {
@@ -385,7 +382,6 @@ const documentScanner = new Dynamsoft.DocumentScanner({
385382
#### DocumentCorrectionViewToolbarButtonsConfig
386383
387384
##### Syntax
388-
389385
```typescript
390386
interface DocumentCorrectionViewToolbarButtonsConfig {
391387
fullImage?: ToolbarButtonConfig;
@@ -397,7 +393,6 @@ interface DocumentCorrectionViewToolbarButtonsConfig {
397393
#### DocumentResultViewToolbarButtonsConfig
398394
399395
##### Syntax
400-
401396
```typescript
402397
interface DocumentResultViewToolbarButtonsConfig {
403398
retake?: ToolbarButtonConfig;
@@ -415,7 +410,6 @@ interface DocumentResultViewToolbarButtonsConfig {
415410
[Dynamsoft Capture Vision template](https://www.dynamsoft.com/capture-vision/docs/core/parameters/file/capture-vision-template.html?lang=javascript) names for detection and correction. This typically does not need to be set, as DDS uses the default template.
416411
417412
#### Syntax
418-
419413
```typescript
420414
interface UtilizedTemplateNames {
421415
detect: string;
@@ -428,7 +422,6 @@ interface UtilizedTemplateNames {
428422
Paths to extra resources such as `.wasm` engine files. The default paths point to CDNs and so may be left unset. You may set custom paths to self-host resources, or host MDS fully offline - see [self-hosting resources]({{ site.guide }}index.html#self-host-resources) for details.
429423
430424
#### Syntax
431-
432425
```typescript
433426
interface EngineResourcePaths {
434427
"rootDirectory"?: string;

‎code-gallery/mobile-web-capture/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: Mobile Document Scanner JS Edition User Guide
1313
> [!TIP]
1414
> Prerequisites: read the [Introduction]({{ site.introduction }}index.html) before proceeding.
1515
16-
**Mobile Web Capture (MWC)** is an advanced sample designed to extend the features of MDS for managing and scanning multi-page documents. It integrates **Mobile Document Scanner (MDS)** functionality while offering additional features such as multi-document management, annotation, and uploading, making it a comprehensive solution for managing complex document workflows.
16+
**Mobile Web Capture (MWC)** is an advanced sample designed to extend the features of MDS for managing and scanning multi-page documents. It integrates **Mobile Document Scanner (MDS)** functionality while offering additional features such as multi-document management, annotation, and uploading by integrating **Dynamsoft Document Viewer (DDV)**, making it a comprehensive solution for managing complex document workflows.
1717

1818
> [!TIP]
1919
> See it in action with the [Mobile Web Capture Demo](https://demo.dynamsoft.com/mobile-web-capture/).

‎guide/angular.md‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
---
2+
layout: default-layout
3+
needAutoGenerateSidebar: true
4+
needGenerateH3Content: true
5+
noTitleIndex: false
6+
breadcrumbText: Angular Guide
7+
title: Mobile Document Scanner JS Edition - Angular
8+
keywords: Documentation, Mobile Document Scanner, Web, JS Edition, Dynamsoft Document Scanner, Angular
9+
description: Mobile Document Scanner JS Edition Angular User Guide
10+
---
11+
12+
# Mobile Document Scanner - Angular
13+
14+
> [!IMPORTANT]
15+
> This article builds on the prerequisite [MDS developer guide]({{ site.guide }}index.html) for plain JavaScript; please read it before proceeding.
16+
17+
Mobile Document Scanner integrates easily with Angular applications. Just as in plain JavaScript, you can add document scanning in your **Angular application** in just a few lines of code, and achieve most customizations through the same accessible configuration object.
18+
19+
## Features
20+
21+
- Easy integration with pre-built UI
22+
- Render MDS inside an Angular component
23+
- **Standalone components** (modern Angular architecture)
24+
- Capture and process documents from video stream
25+
- Automatic document detection and cropping
26+
- Mobile-optimized scanning interface
27+
- TypeScript support with type definitions
28+
29+
## Requirements
30+
31+
- **Node.js 20.19.0 or later**
32+
- [Base requirements]({{ site.introduction }}index.html#system-requirements)
33+
34+
## License
35+
36+
### Get a Trial License
37+
38+
Try **MDS** by requesting a trial license through our [customer portal](https://www.dynamsoft.com/customer/license/trialLicense?product=mwc&utm_source=github_angular_readme). You can renew the license twice for up to a total of two months of free access.
39+
40+
### Get a Full License
41+
42+
[Contact us](https://www.dynamsoft.com/company/contact?product=mwc&utm_source=github_angular_readme) to purchase a full license.
43+
44+
## Quick Start
45+
46+
We publish **MDS** library files on [npm](https://www.npmjs.com/package/dynamsoft-document-scanner) to make them simple to reference from a CDN. We reference the library files in our _ready-made_ Hello World sample for Angular included in our GitHub source repository:
47+
48+
1. Download **MDS** from [GitHub](https://github.com/Dynamsoft/document-scanner-javascript) as a compressed folder.
49+
50+
2. Extract the contents of the archive, and open the extracted directory in a code editor.
51+
52+
3. Set your [license key](#get-a-trial-license) in the **Angular framework sample**:
53+
1. Open the sample at [`/samples/frameworks/angular/src/app/app.component.ts`](https://github.com/Dynamsoft/document-scanner-javascript/blob/main/document-scanner-javascript-dev/samples/frameworks/angular/src/app/app.component.ts).
54+
2. Search for `"YOUR_LICENSE_KEY_HERE"`, then replace it with your actual license key.
55+
56+
### Install Dependencies
57+
58+
```bash
59+
npm install
60+
```
61+
62+
### Start the App
63+
64+
```bash
65+
ng serve
66+
```
67+
68+
> [!TIP]
69+
> If you installed Angular locally, you can call the local version with
70+
> ```shell
71+
> npx ng serve
72+
> ```
73+
74+
Open `http://localhost:4200/` to view the sample app.
75+
76+
> [!NOTE]
77+
> Secure context requires HTTPS to provide camera access, but Angular CLI serves over HTTP by default. For mobile testing, you may need to configure HTTPS or use a reverse proxy.
78+
79+
## Customization
80+
81+
Please check the official [documentation]({{ site.guide }}index.html).
82+
83+
## Support
84+
85+
If you have any questions, feel free to contact [Dynamsoft support](https://www.dynamsoft.com/company/contact?product=mwc&utm_source=github_angular_readme).

0 commit comments

Comments
 (0)