No description
Find a file
Jonathan Kelley 04cd98fffa
add backport
2024-02-21 22:52:31 -08:00
.cargo Add openidconnect authentication demo (#1500) 2023-10-20 12:43:24 -05: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 add backport 2024-02-21 22:52:31 -08:00
.vscode Upgrade to axum 0.7, drop 3rd party adapters 2024-02-15 18:05:30 -08:00
examples fix: some simple formatting and version numbers 2024-02-21 14:32:19 -08:00
notes Remove outdated docs 2024-02-15 14:31:32 -08:00
packages wip: consolidate release 2024-02-21 19:36:33 -08:00
translations Merge branch 'master' into breaking 2024-01-30 16:20:19 -08:00
.gitignore update gitignore 2024-02-05 12:42:30 -08:00
.mailmap Add mailmap to unify name of Jonathan Kelley 2023-05-10 14:45:12 +02:00
Cargo.lock chore: move all packages onto workspace versions 2024-02-21 14:30:13 -08:00
Cargo.toml chore: move all packages onto workspace versions 2024-02-21 14:30:13 -08:00
codecov.yml ci: no more codecov failing 2022-02-13 12:44:17 -05:00
flake.lock Add a simple nix dev shell 2023-10-21 14:06:07 -04:00
flake.nix Add a simple nix dev shell 2023-10-21 14:06:07 -04: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 Exclude mobile from ci 2024-01-06 00:54:04 -08:00
README.md Update readme 2024-02-04 23:09:16 -08:00


Warning

Dioxus 0.5 (currently in master) contains massive breaking changes and is not compatible with Dioxus 0.4

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

fn app() -> Element {
    let mut count = use_signal(|| 0);

    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

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.