mirror of
https://github.com/DioxusLabs/dioxus
synced 2024-11-26 06:00:21 +00:00
c2dd963d86
* doc: add counter example to readme * doc: fermi: revert use_read |
||
---|---|---|
.. | ||
src | ||
Cargo.toml | ||
README.md |
Fermi ⚛
Atom-based global state management solution for Dioxus
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
:
static NAME: Atom<&str> = |_| "Dioxus";
From anywhere in our app, we can read the value of our atom:
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:
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"
}
})
}
If needed, we can update the atom's value, based on itself:
static COUNT: Atom<i32> = |_| 0;
fn Counter(cx: Scope) -> Element {
let mut count = use_atom_state(cx, COUNT);
cx.render(rsx!{
p {
"{count}"
}
button {
onclick: move |_| count += 1,
"Increment counter"
}
})
}
It's that simple!
Installation
Fermi is currently under construction, so you have to use the master
branch to get started.
[dependencies]
fermi = { git = "https://github.com/dioxuslabs/dioxus" }
Running examples
The examples here use Dioxus Desktop to showcase their functionality. To run an example, use
$ cargo run --example fermi
Features
Broadly our feature set required to be released includes:
- Support for Atoms
- 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