Go to file
Jonathan Kelley d56fabfe9a Merge branch 'master' into feat/window_close_behaviour 2023-07-06 10:50:27 -07:00
.devcontainer WIP - remove comment in Dockerfile 2023-05-01 14:54:21 -04:00
.docker try fix 2022-02-06 23:27:24 +01:00
.github fix: add playwright tests to CI workflow 2023-07-05 12:55:18 -04:00
.vscode chore: make clippy happy and limit workspace checks 2022-12-29 00:46:02 -05:00
docs fix: doc typos - trigger CI 2023-07-05 12:50:01 -04:00
examples Merge branch 'master' into feat/window_close_behaviour 2023-07-06 10:50:27 -07:00
notes Add notes to `CONTRIBUTING.md`. 2023-05-29 13:13:55 +12:00
packages Merge branch 'master' into feat/window_close_behaviour 2023-07-06 10:50:27 -07:00
playwrite-tests fix: clippy 2023-07-04 16:56:38 -04:00
translations/pt-br update doc links 2023-01-15 15:18:12 -06:00
.gitignore create end to end tests using playwright 2023-06-05 13:48:58 -05:00
.mailmap Add mailmap to unify name of Jonathan Kelley 2023-05-10 14:45:12 +02:00
CHANGELOG.md feat: add changelogs 2022-01-29 10:17:14 -05:00
Cargo.toml leave hotreload 2023-07-05 15:20:54 -07:00
LICENSE-APACHE Add actual copies of the relevant licenses 2022-01-30 11:50:57 -06:00
LICENSE-MIT Add actual copies of the relevant licenses 2022-01-30 11:50:57 -06:00
Makefile.toml include desktop tests in test with browser 2023-05-06 09:15:09 -05:00
README.md fixed typo in README (#1098) 2023-06-19 08:46:52 -05:00
codecov.yml ci: no more codecov failing 2022-02-13 12:44:17 -05:00
package-lock.json create end to end tests using playwright 2023-06-05 13:48:58 -05:00
package.json create end to end tests using playwright 2023-06-05 13:48:58 -05:00
playwright.config.js increase timeout 2023-06-05 14:23:40 -05:00

README.md


Dioxus is a portable, performant, and ergonomic framework for building cross-platform user interfaces in Rust.

fn app(cx: Scope) -> Element {
    let mut count = use_state(cx, || 0);

    cx.render(rsx! {
        h1 { "High-Five counter: {count}" }
        button { onclick: move |_| count += 1, "Up high!" }
        button { onclick: move |_| count -= 1, "Down low!" }
    })
}

Dioxus can be used to deliver webapps, desktop apps, static sites, mobile apps, TUI apps, liveview apps, and more. Dioxus is entirely renderer agnostic and can be used as a platform for any renderer.

If you know React, then you already know Dioxus.

Unique features:

  • Desktop apps running natively (no Electron!) in less than 10 lines of code.
  • Incredibly ergonomic and powerful state management.
  • Comprehensive inline documentation - hover and guides for all HTML elements, listeners, and events.
  • Blazingly fast 🔥🔥 and extremely memory efficient
  • Integrated hot reloading for fast iteration
  • First-class async support with coroutines and suspense
  • And more! Read the full release post.

Supported Platforms

Web
  • Render directly to the DOM using WebAssembly
  • Pre-render with SSR and rehydrate on the client
  • Simple "hello world" at about 65kb, comparable to React
  • Built-in dev server and hot reloading for quick iteration
Desktop
  • Render using Webview or - experimentally - with WGPU or Skia
  • Zero-config setup. Simply cargo-run to build your app
  • Full support for native system access without electron-esque IPC
  • Supports macOS, Linux, and Windows. Portable <3mb binaries
Mobile
  • Render using Webview or - experimentally - with WGPU or Skia
  • Support for iOS and Android
  • Significantly more performant than React Native
Liveview
  • Render apps - or just a single component - entirely on the server
  • Integrations with popular Rust frameworks like Axum and Warp
  • Extremely low-latency and ability to support 10,000+ simultaneous apps
Terminal
  • Render apps directly into your terminal, similar to ink.js
  • Powered by the familiar flexbox and CSS model of the browser
  • Built-in widgets like text input, buttons, and focus system

Why Dioxus?

There's tons of options for building apps, so why would you choose Dioxus?

Well, first and foremost, Dioxus prioritizes developer experience. This is reflected in a variety of features unique to Dioxus:

  • Autoformatting of our meta language (RSX) and accompanying VSCode extension
  • Hotreloading using an interpreter of RSX for both desktop and web
  • Emphasis on good docs - our guide is complete and our HTML elements are documented
  • Significant research in simplifying

Dioxus is also a very extensible platform.

  • Easily build new renderers by implementing a very simple optimized stack-machine
  • Build and share components and even custom elements

So... Dioxus is great, but why won't it work for me?

  • It's not fully mature yet. APIs are still shifting, things might break (though we try to avoid it)
  • You need to run in a no-std environment.
  • You don't like the React-hooks model of building UIs

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.