Evan AlmloffandJonathan Kelley
58c41f8561
* map signals mutably * boxed signals * remove mutable borrow type from boxed writable * improve map mut example * restore boxed_mut helper * make boxed readable/writable types copy * Move away from the ReadOnlySignal alias in examples * automatically convert Write * Fix some tests * ReadSignal and WriteSignal * move read only signal alias * make maps copy * store prototype * implement derive macro * Handle generics in the derive macro * Make Selector boxable * derive boxed conversion * Get rid of store type * Remove hardcoded type from derive macro * selector -> store * Refactor store implementation * more vec methods * todo mvc store example * Implement Storable for HashMap * fix write * restore sorting logic in todomvc * derive readable and writable * improve todomvc store example * Result store * Option store * collect dead subscribers * fix clippy and formatting * recognize some common foreign types automatically * fix foreign stores in props * slice and array selectors * clean up store example * writable is child owned * box selector * read and write to builtins * re-use the proc macro in the derive macro * Switch to a extension trait based approach * switch to extension traits in the derive macro * transposed method * derive enums * Expose Store::new * remove stores from the prelude * More consistent naming scheme for SelectorScope methods * document hashmap methods * document index extension * document option ext * document result ext * document slice extension * document the vec extension * make more methods borrow the store mutably * Move to impls to have higher priority over the builtin write extension traits * fix deadlock * finish stores documentation * Document the store macro * cleanup docs and organization * finish derive docs * fix typo * fix clippy * fix doc tests * fix derive macro with generics * fix clippy * test and fix empty structs * clean up todomvc store example * default to a boxed store writer to make it easier to type when providing to the context api * fix cargo doc * fix clippy in store example * relax generational box lifetime bounds * relax bounds * relax signal bounds * fix compilation * read store * relax bounds on default store impls * fix enum derive * Convert to readsignal and writesignal automatically * simplify type matching logic * add write store * unsized stores * shrink the path vec type * use more concrete types * remove opaque types * remove copy bounds * use lens as generic name everywhere * more consistent borrow semantics * use a concrete type for the signal metadata and mention references in the map docs * improve todomvc store docs * document store derive macro internals * refactor macro * improve selector node documentation * fix clippy * add btreemap * fix doc tests * more option methods * fix doc * fix clippy * add a bunch more result methods * add a bunch of bounds to the iterators * fix clippy * remove option from subscribers * add store macro to generate extension traits * fix store example * fix deadlock * fix docs * fix doc tests * fix clippy * add stores to public api * add store macro, and then update todomvc_store example --------- Co-authored-by: Jonathan Kelley <jkelleyrtp@gmail.com>
57 lines
2.0 KiB
Rust
57 lines
2.0 KiB
Rust
use dioxus_core::use_hook;
|
|
use dioxus_signals::{ReadSignal, SetCompare};
|
|
use std::hash::Hash;
|
|
|
|
/// 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" }
|
|
/// }
|
|
/// }
|
|
/// ```
|
|
#[doc = include_str!("../docs/rules_of_hooks.md")]
|
|
#[doc = include_str!("../docs/moving_state_around.md")]
|
|
#[must_use]
|
|
pub fn use_set_compare<R: Eq + Hash + 'static>(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.
|
|
#[doc = include_str!("../docs/rules_of_hooks.md")]
|
|
#[doc = include_str!("../docs/moving_state_around.md")]
|
|
#[must_use]
|
|
pub fn use_set_compare_equal<R: Eq + Hash + 'static>(
|
|
value: R,
|
|
mut compare: SetCompare<R>,
|
|
) -> ReadSignal<bool> {
|
|
use_hook(move || compare.equal(value))
|
|
}
|