9 unstable releases (4 breaking)
0.5.1 | Jun 23, 2024 |
---|---|
0.5.0 | Jun 22, 2024 |
0.4.0 | Dec 16, 2023 |
0.3.2 | Sep 10, 2023 |
0.1.1 | Aug 5, 2023 |
#509 in GUI
287 downloads per month
37KB
632 lines
dioxus-query 🦀⚡
Fully-typed, async, reusable cached state management for Dioxus 🧬. Inspired by TanStack Query
.
See the Docs or join the Discord.
⚠️ Work in progress ⚠️
Support
Installation
Install the latest release:
cargo add dioxus-query
Example
cargo run --example simple
Usage
#[derive(Clone, PartialEq, Eq, Hash)]
enum QueryKey {
User(usize),
}
#[derive(Debug)]
enum QueryError {
UserNotFound(usize),
Unknown
}
#[derive(PartialEq, Debug)]
enum QueryValue {
UserName(String),
}
async fn fetch_user(keys: Vec<QueryKey>) -> QueryResult<QueryValue, QueryError> {
if let Some(QueryKey::User(id)) = keys.first() {
println!("Fetching user {id}");
sleep(Duration::from_millis(1000)).await;
match id {
0 => Ok(QueryValue::UserName("Marc".to_string())),
_ => Err(QueryError::UserNotFound(*id)),
}
.into()
} else {
QueryResult::Err(QueryError::Unknown)
}
}
#[allow(non_snake_case)]
#[component]
fn User(id: usize) -> Element {
let value = use_get_query([QueryKey::User(id)], fetch_user);
rsx!( p { "{value.result().value():?}" } )
}
fn app() -> Element {
use_init_query_client::<QueryValue, QueryError, QueryKey>();
let client = use_query_client::<QueryValue, QueryError, QueryKey>();
let onclick = move |_| {
client.invalidate_query(QueryKey::User(0));
};
rsx!(
User { id: 0 }
button { onclick, label { "Refresh" } }
)
}
Features
- Renderer-agnostic
- Queries and mutations
- Typed Mutations, Query keys, Errors and Values
- Invalidate queries manually
- Invalidate queries when keys change
- Concurrent and batching of queries
- Concurrent mutations
To Do
- Tests
- Documentation
- Real-world examples
MIT License
Dependencies
~4–11MB
~124K SLoC