-
-
Notifications
You must be signed in to change notification settings - Fork 524
Apply Version Updates From Current Changes #1578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
This file was deleted.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ | |
| [](https://good-labs.github.io/greater-good-affirmation) | ||
| [](https://opencollective.com/tauri) | ||
|
|
||
| Wry is a cross-platform WebView rendering library. | ||
| Wry is a Cross-platform WebView rendering library. | ||
|
|
||
| The webview requires a running event loop and a window type that implements [`HasWindowHandle`], | ||
| or a gtk container widget if you need to support X11 and Wayland. | ||
|
|
@@ -233,19 +233,17 @@ If you are cross-compiling for macOS using [osxcross](https://github.com/tpoecht | |
| ```bash | ||
| RUSTFLAGS="-l framework=WebKit" cargo build --target=x86_64-apple-darwin --release | ||
| ``` | ||
|
|
||
| #### Windows | ||
|
|
||
| WebView2 provided by Microsoft Edge Chromium is used. So wry supports Windows 7, 8, 10 and 11. | ||
|
|
||
| #### Android | ||
|
|
||
| In order for `wry` to be able to create webviews on Android, there are a few requirements that your application needs to uphold: | ||
|
|
||
| In order for `wry` to be able to create webviews on Android, there is a few requirements that your application needs to uphold: | ||
| 1. You need to set a few environment variables that will be used to generate the necessary kotlin | ||
| files that you need to include in your Android application for wry to function properly. | ||
| - `WRY_ANDROID_PACKAGE`: which is the reversed domain name of your android project and the app name in snake_case, for example, `com.wry.example.wry_app` | ||
| - `WRY_ANDROID_LIBRARY`: for example, if your cargo project has a lib name `wry_app`, it will generate `libwry_app.so` so you set this env var to `wry_app` | ||
| - `WRY_ANDROID_LIBRARY`: for example, if your cargo project has a lib name `wry_app`, it will generate `libwry_app.so` so you se this env var to `wry_app` | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo |
||
| - `WRY_ANDROID_KOTLIN_FILES_OUT_DIR`: for example, `path/to/app/src/main/kotlin/com/wry/example` | ||
| 2. Your main Android Activity needs to inherit `AppCompatActivity`, preferably it should use the generated `WryActivity` or inherit it. | ||
| 3. Your Rust app needs to call `wry::android_setup` function to setup the necessary logic to be able to create webviews later on. | ||
|
|
@@ -260,7 +258,7 @@ It is recommended to use [`tao`](https://docs.rs/tao/latest/tao/) crate as it pr | |
| com_example, | ||
| wry_app, | ||
| WryActivity, | ||
| wry::android_setup, // pass the wry::android_setup function to tao which will be invoked when the event loop is created | ||
| wry::android_setup, // pass the wry::android_setup function to tao which will invoke when the event loop is created | ||
| _start_app | ||
| ); | ||
| wry::android_binding!(com_example, ttt); | ||
|
|
@@ -269,7 +267,7 @@ It is recommended to use [`tao`](https://docs.rs/tao/latest/tao/) crate as it pr | |
|
|
||
| If this feels overwhelming, you can just use the preconfigured template from [`cargo-mobile2`](https://github.com/tauri-apps/cargo-mobile2). | ||
|
|
||
| For more information, check out [MOBILE.md](https://github.com/tauri-apps/wry/blob/dev/MOBILE.md). | ||
| For more inforamtion, checkout [MOBILE.md](https://github.com/tauri-apps/wry/blob/dev/MOBILE.md). | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo |
||
|
|
||
| ### Feature flags | ||
|
|
||
|
|
@@ -279,18 +277,18 @@ Wry uses a set of feature flags to toggle several advanced features. | |
| for the crate to work. This feature was added in preparation of other ports like cef and servo. | ||
| - `protocol` (default): Enables [`WebViewBuilder::with_custom_protocol`] to define custom URL scheme for handling tasks like | ||
| loading assets. | ||
| - `drag-drop` (default): Enables [`WebViewBuilder::with_drag_drop_handler`] to control the behavior when there are files | ||
| - `drag-drop` (default): Enables [`WebViewBuilder::with_drag_drop_handler`] to control the behaviour when there are files | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo |
||
| interacting with the window. | ||
| - `devtools`: Enables devtools on release builds. Devtools are always enabled in debug builds. | ||
| On **macOS**, enabling devtools, requires calling private APIs so you should not enable this flag in release | ||
| On **macOS**, enabling devtools, requires calling private apis so you should not enable this flag in release | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. typo |
||
| build if your app needs to publish to App Store. | ||
| - `transparent`: Transparent background on **macOS** requires calling private functions. | ||
| Avoid this in release build if your app needs to publish to App Store. | ||
| - `fullscreen`: Fullscreen video and other media on **macOS** requires calling private functions. | ||
| Avoid this in release build if your app needs to publish to App Store. | ||
| - `linux-body`: Enables body support of custom protocol request on Linux. Requires | ||
| WebKit2GTK v2.40 or above. | ||
| - `tracing`: enables [`tracing`] for `evaluate_script`, `ipc_handler`, and `custom_protocols`. | ||
| webkit2gtk v2.40 or above. | ||
| - `tracing`: enables [`tracing`] for `evaluate_script`, `ipc_handler` and `custom_protocols. | ||
|
|
||
| ### Partners | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
typo