Skip to content

Commit 39ea8e8

Browse files
authored
Update README.md
1 parent 037de56 commit 39ea8e8

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,46 @@
11
# ComposeNativeWebView 🌐
22

3-
**A lightweight Compose Multiplatform WebView** with a
4-
**KevinnZou/compose-webview-multiplatform-inspired API**, backed by **native OS webviews** on every platform.
3+
**ComposeNativeWebView** is a **Compose Multiplatform WebView** whose **API design and mobile implementations (Android & iOS) are intentionally derived almost verbatim from
4+
[KevinnZou/compose-webview-multiplatform](https://github.com/KevinnZou/compose-webview-multiplatform)**.
5+
6+
This project exists **first and foremost to bring that same API to Desktop**, backed by **native OS webviews instead of a bundled Chromium runtime**.
57

68
```text
79
io.github.kdroidfilter.webview.*
810
```
911

10-
✅ Android: `android.webkit.WebView`
11-
✅ iOS: `WKWebView`
12-
✅ Desktop: **Wry (Rust)** via **UniFFI** → WebView2 / WKWebView / WebKitGTK
12+
### What is reused vs what is new
13+
14+
🟢 **Reused on purpose**
15+
16+
* API surface (`WebViewState`, `WebViewNavigator`, settings, callbacks, mental model)
17+
* Android implementation (`android.webkit.WebView`)
18+
* iOS implementation (`WKWebView`)
19+
* Overall behavior and semantics
20+
21+
👉 If you already know **compose-webview-multiplatform**, you already know how to use this.
22+
23+
🆕 **What ComposeNativeWebView adds**
24+
25+
* **Desktop support with native engines**
26+
* A **Rust + UniFFI (Wry)** backend instead of KCEF / embedded Chromium
27+
* A **tiny desktop footprint** with system-provided webviews
1328

1429
---
1530

31+
## Platform backends
32+
33+
**Android**: `android.webkit.WebView`
34+
**iOS**: `WKWebView`
35+
**Desktop**: **Wry (Rust)** via **UniFFI**
36+
37+
Desktop engines:
38+
39+
* **Windows**: WebView2
40+
* **macOS**: WKWebView
41+
* **Linux**: WebKitGTK
42+
43+
---
1644
## Why ComposeNativeWebView? ⚡
1745

1846
### Native engines. No bundled Chromium.

0 commit comments

Comments
 (0)