dioxus/packages/desktop
Evan Almloff 0127501dbf
Improve inline docs (#2460)
Improve inline docs

* improve incorrect event handler return error message

* Improve event handler docs

* document the eval functions

* document spawn and common spawn errors

* fix event handler docs

* add notes about how you use attributes and elements in rsx

* add doc aliases for attributes and events we rename

* add some more aliases for common search terms

* don't doc ignore any public examples in core

* don't ignore public doc examples in ssr

* don't ignore examples in the dioxus package readme

* add a warning when you launch without a renderer enabled

* fix some outdated element docs

* add a bunch of examples to resource

* add notes about desktop events

* add more docs for use_resource

* add on_unimplemented hint to Dependency

* fix some unresolved links

* add examples to each of the router traits

* add not implemented errors for router traits

* add an example to the routable trait

* expand rsx macro docs

* improve memo docs

* update the dioxus readme

* mention dioxus crate features in the docs

* fix a bunch of doc tests

* fix html doc tests

* fix router doc tests

* fix dioxus signals doc tests

* fix dioxus ssr doc tests

* fix use_future example in the hooks cheat sheet

* add a javascript alias for eval

* fix hook explanation values

* remove unused embed-doc-image dependency
2024-06-06 18:15:17 -07:00
..
architecure Improve inline docs (#2460) 2024-06-06 18:15:17 -07:00
examples Make use_future take an impl FnMut + 'static, don't include router prelude when we don't need to 2024-01-31 16:33:53 -08:00
headless_tests Improve the base_path story (#2381) 2024-05-03 13:38:07 -05:00
src Add access to the Element attributes related to scrolling (#2338) 2024-05-21 12:56:49 -05:00
build.rs remove minified js from build scripts 2024-02-01 10:07:03 -06:00
Cargo.toml set up example scaping for docs.rs (#2450) 2024-05-28 13:05:55 -07:00
CHANGELOG.md feat: add changelogs 2022-01-29 10:17:14 -05:00
README.md update 0.4 doc links to 0.5 2024-03-27 20:42:07 -05:00

Dioxus Desktop (webview)

Crates.io MIT licensed Build Status Discord chat

Website | Guides | API Docs | Chat

Overview

dioxus-desktop provides a webview-based desktop renderer for the Dioxus VirtualDom.

This requires that webview is installed on the target system. WebView is installed by default on macOS and iOS devices, but might not come preinstalled on Windows or Linux devices. To fix these issues, follow the instructions in the guide.

Features

  • Simple, one-line launch for desktop apps
  • Dioxus VirtualDom running on a native thread
  • Full HTML/CSS support via wry and tao
  • Exposed window and Proxy types from tao for direct window manipulation
  • Helpful hooks for accessing the window, WebView, and running javascript.

Contributing

  • Report issues on our issue tracker.
  • Join the discord and ask questions!

License

This project is licensed under the MIT license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Dioxus by you shall be licensed as MIT without any additional terms or conditions.