dioxus/packages/desktop/src
Jon Kelley d9546d9504
Renderers are now packages, not features. (#387)
* feat: use synchronous router design

* feat: function to get router out of dom

* chore: restructure workspace to use renderers as packages, not features
2022-07-09 15:15:20 -04:00
..
assets feat: move default_icon to assets 2022-02-14 16:53:35 +08:00
cfg.rs fmt 2022-04-16 17:02:57 -04:00
controller.rs fix web imports and extract hot reload handlers into seperate files (#484) 2022-07-04 13:18:11 -05:00
desktop_context.rs Renderers are now packages, not features. (#387) 2022-07-09 15:15:20 -04:00
escape.rs Renderers are now packages, not features. (#387) 2022-07-09 15:15:20 -04:00
events.rs dioxus-desktop(Update-dep): tauri 0.19.x (#489) 2022-07-06 12:05:31 -04:00
hot_reload.rs fix web imports and extract hot reload handlers into seperate files (#484) 2022-07-04 13:18:11 -05:00
index.html feat: allow customizing the index and head 2022-04-16 16:53:47 -04:00
lib.rs Renderers are now packages, not features. (#387) 2022-07-09 15:15:20 -04:00
protocol.rs feat: allow customizing the index and head 2022-04-16 16:53:47 -04:00
readme.md Renderers are now packages, not features. (#387) 2022-07-09 15:15:20 -04: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 keyboard shortcuts, 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 with the desktop feature:

$ cargo add dioxus --features 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!