|
11 | 11 | //! [](https://good-labs.github.io/greater-good-affirmation)
|
12 | 12 | //! [](https://opencollective.com/tauri)
|
13 | 13 | //!
|
14 |
| -//! Wry is a Cross-platform WebView rendering library. |
| 14 | +//! Wry is a cross-platform WebView rendering library. |
15 | 15 | //!
|
16 | 16 | //! The webview requires a running event loop and a window type that implements [`HasWindowHandle`],
|
17 | 17 | //! or a gtk container widget if you need to support X11 and Wayland.
|
|
261 | 261 | //!
|
262 | 262 | //! ### Android
|
263 | 263 | //!
|
264 |
| -//! In order for `wry` to be able to create webviews on Android, there is a few requirements that your application needs to uphold: |
| 264 | +//! In order for `wry` to be able to create webviews on Android, there are a few requirements that your application needs to uphold: |
265 | 265 | //! 1. You need to set a few environment variables that will be used to generate the necessary kotlin
|
266 | 266 | //! files that you need to include in your Android application for wry to function properly.
|
267 | 267 | //! - `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`
|
268 |
| -//! - `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` |
| 268 | +//! - `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` |
269 | 269 | //! - `WRY_ANDROID_KOTLIN_FILES_OUT_DIR`: for example, `path/to/app/src/main/kotlin/com/wry/example`
|
270 | 270 | //! 2. Your main Android Activity needs to inherit `AppCompatActivity`, preferably it should use the generated `WryActivity` or inherit it.
|
271 | 271 | //! 3. Your Rust app needs to call `wry::android_setup` function to setup the necessary logic to be able to create webviews later on.
|
|
280 | 280 | //! com_example,
|
281 | 281 | //! wry_app,
|
282 | 282 | //! WryActivity,
|
283 |
| -//! wry::android_setup, // pass the wry::android_setup function to tao which will invoke when the event loop is created |
| 283 | +//! wry::android_setup, // pass the wry::android_setup function to tao which will be invoked when the event loop is created |
284 | 284 | //! _start_app
|
285 | 285 | //! );
|
286 | 286 | //! wry::android_binding!(com_example, ttt);
|
|
289 | 289 | //!
|
290 | 290 | //! If this feels overwhelming, you can just use the preconfigured template from [`cargo-mobile2`](https://github.com/tauri-apps/cargo-mobile2).
|
291 | 291 | //!
|
292 |
| -//! For more inforamtion, checkout [MOBILE.md](https://github.com/tauri-apps/wry/blob/dev/MOBILE.md). |
| 292 | +//! For more information, check out [MOBILE.md](https://github.com/tauri-apps/wry/blob/dev/MOBILE.md). |
293 | 293 | //!
|
294 | 294 | //! ## Feature flags
|
295 | 295 | //!
|
|
299 | 299 | //! for the crate to work. This feature was added in preparation of other ports like cef and servo.
|
300 | 300 | //! - `protocol` (default): Enables [`WebViewBuilder::with_custom_protocol`] to define custom URL scheme for handling tasks like
|
301 | 301 | //! loading assets.
|
302 |
| -//! - `drag-drop` (default): Enables [`WebViewBuilder::with_drag_drop_handler`] to control the behaviour when there are files |
| 302 | +//! - `drag-drop` (default): Enables [`WebViewBuilder::with_drag_drop_handler`] to control the behavior when there are files |
303 | 303 | //! interacting with the window.
|
304 | 304 | //! - `devtools`: Enables devtools on release builds. Devtools are always enabled in debug builds.
|
305 |
| -//! On **macOS**, enabling devtools, requires calling private apis so you should not enable this flag in release |
| 305 | +//! On **macOS**, enabling devtools, requires calling private APIs so you should not enable this flag in release |
306 | 306 | //! build if your app needs to publish to App Store.
|
307 | 307 | //! - `transparent`: Transparent background on **macOS** requires calling private functions.
|
308 | 308 | //! Avoid this in release build if your app needs to publish to App Store.
|
309 | 309 | //! - `fullscreen`: Fullscreen video and other media on **macOS** requires calling private functions.
|
310 | 310 | //! Avoid this in release build if your app needs to publish to App Store.
|
311 | 311 | //! - `linux-body`: Enables body support of custom protocol request on Linux. Requires
|
312 |
| -//! webkit2gtk v2.40 or above. |
313 |
| -//! - `tracing`: enables [`tracing`] for `evaluate_script`, `ipc_handler` and `custom_protocols. |
| 312 | +//! WebKit2GTK v2.40 or above. |
| 313 | +//! - `tracing`: enables [`tracing`] for `evaluate_script`, `ipc_handler`, and `custom_protocols`. |
314 | 314 | //!
|
315 | 315 | //! ## Partners
|
316 | 316 | //!
|
|
0 commit comments