dioxus/README.md

91 lines
4 KiB
Markdown
Raw Normal View History

2021-01-16 15:31:17 +00:00
<div align="center">
<h1>🌗🚀 Dioxus</h1>
<p>
2021-03-02 06:47:27 +00:00
<strong>Frontend that scales.</strong>
2021-01-16 15:31:17 +00:00
</p>
</div>
Dioxus is a portable, performant, and ergonomic framework for building cross-platform user experiences in Rust.
```rust
2021-06-08 18:00:29 +00:00
fn Example(ctx: Context<()>) -> VNodes {
2021-06-03 16:02:46 +00:00
let (selection, set_selection) = use_state(&ctx, move || "..?");
2021-02-25 23:44:00 +00:00
2021-03-01 05:16:48 +00:00
ctx.render(rsx! {
2021-06-08 18:00:29 +00:00
h1 { "Hello, {selection}" }
button { "?", onclick: move |_| set_selection("world!")}
button { "?", onclick: move |_| set_selection("Dioxus 🎉")}
2021-03-01 02:21:17 +00:00
})
};
```
Dioxus can be used to deliver webapps, desktop apps, static pages, liveview apps, Android apps, iOS Apps, and more. At its core, Dioxus is entirely renderer agnostic and has great documentation for creating new renderers for any platform.
If you know React, then you already know Dioxus.
2021-03-01 05:16:48 +00:00
### **Things you'll love ❤️:**
2021-03-02 06:47:27 +00:00
- Ergonomic design
2021-03-01 05:16:48 +00:00
- Minimal boilerplate
- Familiar design and semantics
- Simple build, test, and deploy
2021-03-02 06:47:27 +00:00
- Support for html! and rsx! templating
2021-03-01 05:16:48 +00:00
- SSR, WASM, desktop, and mobile support
2021-04-02 01:44:18 +00:00
- Powerful and simple integrated state management
2021-03-02 06:47:27 +00:00
- Rust! (enums, static types, modules, efficiency)
2021-03-01 05:18:05 +00:00
2021-03-01 05:16:48 +00:00
## Get Started with...
2021-02-08 22:09:21 +00:00
<table style="width:100%" align="center">
<tr >
2021-03-29 16:31:47 +00:00
<th><a href="http://github.com/jkelleyrtp/dioxus">Web</a></th>
2021-02-08 22:08:26 +00:00
<th><a href="http://github.com/jkelleyrtp/dioxus">Desktop</a></th>
<th><a href="http://github.com/jkelleyrtp/dioxus">Mobile</a></th>
<th><a href="http://github.com/jkelleyrtp/dioxus">State Management</a></th>
<th><a href="http://github.com/jkelleyrtp/dioxus">Docs</a></th>
2021-02-08 22:09:21 +00:00
<th><a href="http://github.com/jkelleyrtp/dioxus">Tools</a></th>
2021-02-08 22:05:58 +00:00
<tr>
</table>
2021-02-08 22:07:27 +00:00
2021-02-16 06:41:41 +00:00
## Explore
2021-03-01 05:16:48 +00:00
- [**HTML Templates**: Drop in existing HTML5 templates with html! macro](docs/guides/00-index.md)
- [**RSX Templates**: Clean component design with rsx! macro](docs/guides/00-index.md)
2021-02-16 06:43:50 +00:00
- [**Running the examples**: Explore the vast collection of samples, tutorials, and demos](docs/guides/00-index.md)
- [**Building applications**: Use the Dioxus CLI to build and bundle apps for various platforms](docs/guides/01-ssr.md)
- [**Liveview**: Build custom liveview components that simplify datafetching on all platforms](docs/guides/01-ssr.md)
- [**State management**: Easily add powerful state management that comes integrated with Dioxus Core](docs/guides/01-ssr.md)
- [**Concurrency**: Drop in async where it fits and suspend components until new data is ready](docs/guides/01-ssr.md)
2021-03-01 05:16:48 +00:00
- [**1st party hooks**: Cross-platform router hook](docs/guides/01-ssr.md)
2021-02-16 06:43:50 +00:00
- [**Community hooks**: 3D renderers](docs/guides/01-ssr.md)
2021-01-29 16:57:52 +00:00
2021-05-20 00:57:19 +00:00
## Blog Posts
2021-05-20 00:57:19 +00:00
- [Why we need a stronger typed web]()
- [Isomorphic webapps in 10 minutes]()
- [Rust is high level too]()
- [Eliminating crashes with Rust webapps]()
- [Tailwind for Dioxus]()
- [The monoglot startup]()
2021-06-03 16:02:46 +00:00
## Why?
---
TypeScript is a great addition to JavaScript, but comes with a lot of tweaking flags, a slight performance hit, and an uneven ecosystem where some of the most important packages are not properly typed. TypeScript provides a lot of great benefits to JS projects, but comes with its own "tax" that can slow down dev teams. Rust can be seen as a step up from TypeScript, supporting:
- static types for _all_ libraries
- advanced pattern matching
- immutability by default
- clean, composable iterators
- a good module system
- integrated documentation
- inline built-in unit/integration testing
- best-in-class error handling
- simple and fast build system
2021-06-03 17:57:41 +00:00
- powerful standard library (no need for lodash or underscore)
- include_str! for integrating html/css/svg templates directly
2021-06-03 16:02:46 +00:00
- various macros (`html!`, `rsx!`) for fast template iteration
And much more. Dioxus makes Rust apps just as fast to write as React apps, but affords more robustness, giving your frontend team greater confidence in making big changes in shorter time. Dioxus also works on the server, on the web, on mobile, on desktop - and it runs completely natively so performance is never an issue.