dioxus/packages/desktop/src
zhangzhonglai c8a9a7b1d5
docs(desktop): fix wrong example code (#1678)
* docs(desktop): fix wrong example code

* stop ignoring doctests in dioxus desktop

---------

Co-authored-by: ealmloff <evanalmloff@gmail.com>
2023-12-01 07:52:20 -06:00
..
assets fix: Update logos and custom assets example (#960) 2023-04-15 08:02:04 -05:00
cfg.rs add functionality 2023-07-04 14:47:45 +02:00
desktop_context.rs switch to tracing for logging 2023-09-06 17:47:33 -05:00
element.rs Convert use_eval to use send/recv system (#1080) 2023-07-21 17:36:25 -05:00
escape.rs Renderers are now packages, not features. (#387) 2022-07-09 15:15:20 -04:00
eval.rs Convert use_eval to use send/recv system (#1080) 2023-07-21 17:36:25 -05:00
events.rs feat: return window 2022-12-31 12:19:21 -05:00
file_upload.rs Move filedialog code into cfg-ed out folder 2023-07-19 13:52:27 -07:00
index.html feat: allow customizing the index and head 2022-04-16 16:53:47 -04:00
lib.rs docs(desktop): fix wrong example code (#1678) 2023-12-01 07:52:20 -06:00
mobile_shortcut.rs Stub out files and RFD on ios 2023-06-30 13:59:48 -07:00
protocol.rs fix clippy 2023-10-17 13:02:51 -05:00
query.rs switch to tracing for logging 2023-09-06 17:47:33 -05:00
readme.md fix: Update doc links from v3 to v4 2023-09-16 19:03:27 +02:00
shortcut.rs FIx desktop for android 2023-07-05 12:49:41 -07:00
waker.rs feat: multiwindow support 2022-12-30 22:05:15 -05:00
webview.rs Make window invisible until the first render (#1588) 2023-10-29 13:09:07 -05:00

Dioxus Desktop Renderer

Render the Dioxus VirtualDom using the platform's native WebView implementation.

Desktop

One of Dioxus' flagship features is the ability to quickly build a native desktop app that looks and feels the same across platforms. Apps built with Dioxus are typically <5mb in size and use existing system resources, so they won't hog extreme amounts of RAM or memory.

Dioxus Desktop is built off Tauri. Right now there aren't any Dioxus abstractions over the menubar, handling, etc, so you'll want to leverage Tauri - mostly Wry and Tao directly. An upcoming release of Dioxus-Desktop will include components and hooks for notifications, global shortcuts, menubar, etc.

Getting Set up

Getting Set up with Dioxus-Desktop is quite easy. Make sure you have Rust and Cargo installed, and then create a new project:

$ cargo new --bin demo
$ cd app

Add Dioxus and the desktop renderer feature:

$ cargo add dioxus
$ cargo add dioxus-desktop

Edit your main.rs:

// main.rs
use dioxus::prelude::*;

fn main() {
    dioxus_desktop::launch(app);
}

fn app(cx: Scope) -> Element {
    cx.render(rsx!{
        div {
            "hello world!"
        }
    })
}

To configure the webview, menubar, and other important desktop-specific features, checkout out some of the launch configuration in the API reference.

Future Steps

Make sure to read the Dioxus Guide if you already haven't!