Skip to content

Commit d9309d1

Browse files
authored
Revise README for NetWebView2Lib v1.4.0 update
Updated README.md to include new features, installation instructions, and migration notes for NetWebView2Lib v1.4.0.
1 parent 2d110a0 commit d9309d1

1 file changed

Lines changed: 46 additions & 54 deletions

File tree

README.md

Lines changed: 46 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1+
## AutoIt WebView2 Component (COM Interop)
2+
3+
A powerful bridge that allows **AutoIt** to use the modern **Microsoft Edge WebView2** (Chromium) engine via a C# COM wrapper. This project enables you to render modern HTML5, CSS3, and JavaScript directly inside your AutoIt applications with a 100% event-driven architecture.
4+
5+
---
6+
### 🚀 Key Features
7+
8+
* **Chromium Engine**: Leverage the speed and security of modern Microsoft Edge.
9+
* **Bi-directional Communication**: Send messages from JS to AutoIt (`postMessage`) and execute JS from AutoIt (`ExecuteScript`).
10+
* **Event-Driven**: No more `While/Sleep` loops to check for updates. Uses COM Sinks for instant notifications.
11+
* **Advanced JSON Handling**: Includes a built-in `JsonParser` for deep-path data access (e.g., `user.items\[0].name`).
12+
* **Content Control**: Built-in Ad-blocker, CSS injection, and Zoom control.
13+
* **Dual Architecture**: Fully supports both **x86** and **x64** environments.
14+
- **Extension Support**: Load and use Chromium extensions (unpacked).
15+
- **Advanced Cookie & CDP Control**: Full cookie manipulation and raw access to Chrome DevTools Protocol.
16+
- **Kiosk & Security Mode**: Enhanced methods to restrict user interaction for production environments.
17+
18+
---
19+
20+
### 🛠 Prerequisites
21+
22+
1. **.NET Framework 4.8** or higher.
23+
2. **Microsoft Edge WebView2 Runtime**.
24+
25+
* *The registration script will check for this and provide a download link if missing.*
26+
27+
---
28+
### 📦 Deployment \& Installation
29+
30+
1. **Extract** NetWebView2Lib folder to a permanent location.
31+
2. **Run**:
32+
`\NetWebView2Lib\bin\Register_web2.au3` to Register
33+
* Verifies the WebView2 Runtime presence.
34+
* Registers `NetWebView2Lib.dll` for COM Interop on both 32-bit and 64-bit.
35+
36+
or `\NetWebView2Lib\bin\Unregister.au3` to Unregister
37+
38+
1. **Run `\Example\*`** to see the bridge in action.
39+
40+
<p align="center">
41+
<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" width="100%">
42+
</p>
143

244
## NetWebView2Lib v1.4.0 - Major Update
345

@@ -18,12 +60,10 @@ This version introduces significant architectural improvements, focusing on deep
1860

1961
Due to changes in the COM Dispatch IDs (DispIds) for better organization, it is **highly recommended** to run the included `RegCleaner.au3` before registering the new version. This ensures that any stale registry entries from previous builds are purged, preventing "Object action failed" errors.
2062

21-
2263
<p align="center">
2364
<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" width="100%">
2465
</p>
2566

26-
2767
### 📖 Understanding the WebDemo (v1.4)
2868

2969
The **`WebDemo_v1.4.au3`** is not just a browser,
@@ -63,10 +103,9 @@ The demo intercepts the native context menu and replaces it with a dynamic AutoI
63103

64104
- **⚡ Persistent Bridge**: Notice that even if you navigate to a new website or refresh, the "Table Export" and "Form Mapping" still work. This is thanks to the new `AddInitializationScript` which ensures our `bridge.js` is part of every page's DNA.
65105

66-
67106
---
68107

69-
### ⚙️ How it Works: The "Context-JSON" Bridge
108+
#### ⚙️ How it Works: The "Context-JSON" Bridge
70109

71110
The secret behind this intelligent menu is the seamless communication between the Browser's DOM and AutoIt's COM interface.
72111

@@ -92,62 +131,15 @@ The secret behind this intelligent menu is the seamless communication between th
92131

93132
---
94133

95-
### 💡 Pro Tip for Developers:
134+
#### 💡 Pro Tip for Developers:
96135

97136
> "You can extend this! If you want to detect specifically if a user clicked on a **Video** or a **PDF link**, just update the `bridge.js` to include those tags.
98137
99-
100138
<p align="center">
101139
<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" width="100%">
102140
</p>
103-
104141

105-
# AutoIt WebView2 Component (COM Interop)
106-
107-
A powerful bridge that allows **AutoIt** to use the modern **Microsoft Edge WebView2** (Chromium) engine via a C# COM wrapper. This project enables you to render modern HTML5, CSS3, and JavaScript directly inside your AutoIt applications with a 100% event-driven architecture.
108-
109-
---
110-
111-
## 🚀 Key Features
112-
113-
* **Chromium Engine**: Leverage the speed and security of modern Microsoft Edge.
114-
* **Bi-directional Communication**: Send messages from JS to AutoIt (`postMessage`) and execute JS from AutoIt (`ExecuteScript`).
115-
* **Event-Driven**: No more `While/Sleep` loops to check for updates. Uses COM Sinks for instant notifications.
116-
* **Advanced JSON Handling**: Includes a built-in `JsonParser` for deep-path data access (e.g., `user.items\[0].name`).
117-
* **Content Control**: Built-in Ad-blocker, CSS injection, and Zoom control.
118-
* **Dual Architecture**: Fully supports both **x86** and **x64** environments.
119-
- **Extension Support**: Load and use Chromium extensions (unpacked).
120-
- **Advanced Cookie & CDP Control**: Full cookie manipulation and raw access to Chrome DevTools Protocol.
121-
- **Kiosk & Security Mode**: Enhanced methods to restrict user interaction for production environments.
122-
123-
124-
---
125-
126-
## 🛠 Prerequisites
127-
128-
1. **.NET Framework 4.8** or higher.
129-
2. **Microsoft Edge WebView2 Runtime**.
130-
131-
* *The registration script will check for this and provide a download link if missing.*
132-
133-
134-
---
135-
## 📦 Deployment \& Installation
136-
137-
1. **Extract** NetWebView2Lib folder to a permanent location.
138-
2. **Run**:
139-
`\NetWebView2Lib\bin\Register_web2.au3` to Register
140-
* Verifies the WebView2 Runtime presence.
141-
* Registers `NetWebView2Lib.dll` for COM Interop on both 32-bit and 64-bit.
142-
143-
or `\NetWebView2Lib\bin\Unregister.au3` to Unregister
144-
145-
1. **Run `\Example\*`** to see the bridge in action.
146-
147-
148-
---
149-
150-
## 📖 NetWebView2Lib Version 1.4.0 - Reference (Quick View)
142+
## 📖 NetWebView2Lib Version 1.4.0 (Quick Reference)
151143

152144
### Properties
153145

@@ -469,7 +461,7 @@ Fired when the browser loses focus.
469461

470462
---
471463

472-
# JsonParser (ProgId: NetJson.Parser)
464+
### JsonParser (ProgId: NetJson.Parser)
473465

474466
## Methods
475467

0 commit comments

Comments
 (0)