Restore set compare hook (#2287)

* restore set compare hook

* fix use_set_compare doc example

* add a hook to compare a value with a set

* implement partialeq for SetCompare

* export the new hook

* fix the use_set_compare hook
This commit is contained in:
Evan Almloff authored and GitHub committed 2024-04-26 11:55:11 -04:00
1 parent fc2b441ee1
commit 1d72ef16c4
6 files changed
+158 -147

No files matched your search

+3
View File
@@ -92,3 +92,6 @@ pub use use_hook_did_run::*;
mod use_signal;
pub use use_signal::*;
mod use_set_compare;
pub use use_set_compare::*;
+1 -2
View File
@@ -1,8 +1,7 @@
#![allow(missing_docs)]
use crate::{use_callback, use_hook_did_run, use_signal, UseCallback};
use dioxus_core::{prelude::*, Task};
use dioxus_core::prelude::*;
use dioxus_signals::*;
use dioxus_signals::{Readable, Writable};
use std::future::Future;
use std::ops::Deref;
+53
View File
@@ -0,0 +1,53 @@
use std::hash::Hash;
use dioxus_core::prelude::*;
use dioxus_signals::{ReadOnlySignal, SetCompare};
/// Creates a new SetCompare which efficiently tracks when a value changes to check if it is equal to a set of values.
///
/// Generally, you shouldn't need to use this hook. Instead you can use [`crate::use_memo`]. If you have many values that you need to compare to a single value, this hook will change updates from O(n) to O(1) where n is the number of values you are comparing to.
///
/// ```rust
/// use dioxus::prelude::*;
///
/// fn App() -> Element {
/// let mut count = use_signal(|| 0);
/// let compare = use_set_compare(move || count());
///
/// rsx! {
/// for i in 0..10 {
/// // Child will only re-render when i == count
/// Child { compare, i }
/// }
/// button {
/// // This will only rerender the child with the old and new value of i == count
/// // Because we are using a set compare, this will be O(1) instead of the O(n) performance of a selector
/// onclick: move |_| count += 1,
/// "Increment"
/// }
/// }
/// }
///
/// #[component]
/// fn Child(i: usize, compare: SetCompare<usize>) -> Element {
/// let active = use_set_compare_equal(i, compare);
/// if active() {
/// rsx! { "Active" }
/// } else {
/// rsx! { "Inactive" }
/// }
/// }
/// ```
#[must_use]
pub fn use_set_compare<R: Eq + Hash>(f: impl FnMut() -> R + 'static) -> SetCompare<R> {
use_hook(move || SetCompare::new(f))
}
/// A hook that returns true if the value is equal to the value in the set compare.
#[must_use]
pub fn use_set_compare_equal<R: Eq + Hash>(
value: R,
mut compare: SetCompare<R>,
) -> ReadOnlySignal<bool> {
use_hook(move || compare.equal(value))
}