feat(docs): Improved shared state, use_effect and use_memo docs

This commit is contained in:
marc2332 committed 2023-06-28 00:15:00 +02:00
1 parent dfa4d8d989
commit 8a2f9f3fcb
7 files changed
+158 -19

No files matched your search

+19 -6
View File
@@ -9,17 +9,30 @@ use crate::UseFutureDep;
/// If a future is pending when the dependencies change, the previous future
/// will be allowed to continue
///
/// - dependencies: a tuple of references to values that are PartialEq + Clone
/// - dependencies: a tuple of references to values that are `PartialEq` + `Clone`
///
/// ## Examples
///
/// ```rust, ignore
/// ```rust, no_run
///
/// #[inline_props]
/// fn app(cx: Scope, name: &str) -> Element {
/// use_effect(cx, (name,), |(name,)| async move {
/// set_title(name);
/// }))
/// fn Profile(cx: Scope, id: &str) -> Element {
/// let name = use_state(cx, || "Default name");
///
/// use_effect(cx, (id,), |(id,)| async move {
/// let user = fetch_user(id).await;
/// name.set(user.name);
/// });
///
/// render!(
/// p { "{name}" }
/// )
/// }
///
/// fn app(cx: Scope) -> Element {
/// render!(
/// Profile { id: "dioxusLabs" }
/// )
/// }
/// ```
pub fn use_effect<T, F, D>(cx: &ScopeState, dependencies: D, future: impl FnOnce(D::Out) -> F)