mirror of
https://github.com/DioxusLabs/dioxus
synced 2024-11-27 14:40:44 +00:00
93 lines
2.3 KiB
Markdown
93 lines
2.3 KiB
Markdown
|
|
||
|
|
<div align="center">
|
||
|
|
<h1>Fermi ⚛</h1>
|
||
|
|
<p>
|
||
|
|
<strong>Atom-based global state management solution for Dioxus</strong>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<div align="center">
|
||
|
|
<!-- Crates version -->
|
||
|
|
<a href="https://crates.io/crates/dioxus">
|
||
|
|
<img src="https://img.shields.io/crates/v/dioxus.svg?style=flat-square"
|
||
|
|
alt="Crates.io version" />
|
||
|
|
</a>
|
||
|
|
<!-- Downloads -->
|
||
|
|
<a href="https://crates.io/crates/dioxus">
|
||
|
|
<img src="https://img.shields.io/crates/d/dioxus.svg?style=flat-square"
|
||
|
|
alt="Download" />
|
||
|
|
</a>
|
||
|
|
<!-- docs -->
|
||
|
|
<a href="https://docs.rs/dioxus">
|
||
|
|
<img src="https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square"
|
||
|
|
alt="docs.rs docs" />
|
||
|
|
</a>
|
||
|
|
<!-- CI -->
|
||
|
|
<a href="https://github.com/jkelleyrtp/dioxus/actions">
|
||
|
|
<img src="https://github.com/dioxuslabs/dioxus/actions/workflows/main.yml/badge.svg"
|
||
|
|
alt="CI status" />
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
-----
|
||
|
|
|
||
|
|
Fermi is a global state management solution for Dioxus that's as easy as `use_state`.
|
||
|
|
|
||
|
|
Inspired by atom-based state management solutions, all state in Fermi starts as an `atom`:
|
||
|
|
|
||
|
|
```rust
|
||
|
|
static NAME: Atom<&str> = |_| "Dioxus";
|
||
|
|
```
|
||
|
|
|
||
|
|
From anywhere in our app, we can read our the value of our atom:
|
||
|
|
|
||
|
|
```rust
|
||
|
|
fn NameCard(cx: Scope) -> Element {
|
||
|
|
let name = use_read(&cx, NAME);
|
||
|
|
cx.render(rsx!{ h1 { "Hello, {name}"} })
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
We can also set the value of our atom, also from anywhere in our app:
|
||
|
|
|
||
|
|
```rust
|
||
|
|
fn NameCard(cx: Scope) -> Element {
|
||
|
|
let set_name = use_set(&cx, NAME);
|
||
|
|
cx.render(rsx!{
|
||
|
|
button {
|
||
|
|
onclick: move |_| set_name("Fermi"),
|
||
|
|
"Set name to fermi"
|
||
|
|
}
|
||
|
|
})
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
It's that simple!
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
Fermi is currently under construction, so you have to use the `master` branch to get started.
|
||
|
|
|
||
|
|
```rust
|
||
|
|
[depdencies]
|
||
|
|
fermi = { git = "https://github.com/dioxuslabs/fermi" }
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Running examples
|
||
|
|
|
||
|
|
The examples here use Dioxus Desktop to showcase their functionality. To run an example, use
|
||
|
|
```
|
||
|
|
$ cargo run --example EXAMPLE
|
||
|
|
```
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
Broadly our feature set to required to be released includes:
|
||
|
|
- [x] Support for Atoms
|
||
|
|
- [x] Support for AtomRef (for values that aren't clone)
|
||
|
|
- [ ] Support for Atom Families
|
||
|
|
- [ ] Support for memoized Selectors
|
||
|
|
- [ ] Support for memoized SelectorFamilies
|
||
|
|
- [ ] Support for UseFermiCallback for access to fermi from async
|