more-yew-hooks

Additional hooks for the yew ecosystem, including bugfixes for yew-hooks.

Motivation

I created this crate to augment some of the hooks in the yew_hooks, such as use_online and use_btree_set.

• use_local_storage_default: returns T::default() on absence or deserialization failure and listens to storage events.
• use_session_storage_with_listen: listens for storage events and filters by sessionStorage in case keys conflict with localStorage.
• use_btree_set: ordered set state with operations (insert, replace, retain, etc.).
• use_online: minimal wrapper around navigator.onLine with event listeners.

Note: Breaking Change

I was wrong about use_debounce and use_debounce_state in yew-hooks. They do accept FnOnce() and this is correct (least restrictive). De-confusion: FnOnce() can be called at least once, NOT at MOST once. The bug I experienced was likely somewhere else in my project. Thus they have been removed from this crate.

Installation

Add to your Cargo.toml:

[dependencies]
more-yew-hooks = "0.1"

Optional feature flags:

If you disable default features and only want non-storage hooks:

more-yew-hooks = { version = "0.1", default-features = false }

MSRV (Minimum Supported Rust Version)

Uses Rust edition 2024. Practically, you likely need Rust 1.81+ (exact MSRV still provisional until CI enforces). If you rely on an older toolchain, please file an issue.

Quick start example

use std::collections::BTreeSet;
use yew::prelude::*;
use more_yew_hooks::prelude::*; // (Consider adding a prelude re-export if desired)

#[function_component(App)]
fn app() -> Html {
    let planets = more_yew_hooks::use_btree_set(BTreeSet::from([
        "Mercury", "Venus", "Earth"
    ]));

    let online = more_yew_hooks::use_online();

    html! {
        <div>
            <p>{ format!("Online: {}", *online) }</p>
            <p>{ format!("Planets: {:?}", planets.current().iter().collect::<Vec<_>>()) }</p>
        </div>
    }
}

Hook Catalogue

use_btree_set

Tracks a BTreeSet<T> with convenient mutation helpers that automatically trigger rerenders. Order is preserved (in‑order traversal). Inspired by yew_hooks::use_set but using an ordered structure and exposing additional operations.

Signature:

fn use_btree_set<T: 'static + Eq + Ord + Hash>(initial: BTreeSet<T>) -> UseBTreeSetHandle<T>

Handle methods:

• current() -> Ref<BTreeSet<T>> (borrow view)
• set(BTreeSet<T>)
• insert(T) -> bool
• replace(T) -> Option<T> (returns replaced value)
• remove(&T) -> bool
• retain(F)
• clear()

Example: See in-source docs for a full interactive example.

Edge cases:

• Panics if you call current() while holding an outstanding mutable borrow (rare in normal hook usage).
• Equality for the handle is based on inner set content, not pointer identity.

use_local_storage_default (feature = storage)

Wrapper around localStorage that returns T::default() if the key is missing or deserialization fails. Listens to storage events.

Signature:

fn use_local_storage_default<T: DeserializeOwned + Default + 'static>(key: String) -> UseLocalStorageDefaultHandle<T>

Handle:

• Derefs to T
• set(T) — serializes (JSON) & updates state
• delete() — removes key and resets to T::default()

Notes:

• Serialization uses serde_json.
• Logs (via log) storage updates for debugging.

Edge cases:

• If JSON is corrupted, returns T::default() instead of erroring.
• Storage quota errors currently ignored (PRs welcome for better surfacing).

use_session_storage_with_listen (feature = storage)

Session storage variant that listens for storage events and updates only when the event references the same storage area and key.

Signature:

fn use_session_storage_with_listen<T: DeserializeOwned + 'static>(key: String) -> UseSessionStorageWithListenerHandle<T>

Handle:

• Derefs to Option<T> (None when no value present)
• set(T)
• delete()

Notes:

• Only updates when the event comes from the same sessionStorage area (validated).
• Gracefully ignores events from other storage types.

use_online

Hook returning a UseStateHandle<bool> that reflects navigator.onLine and updates on online / offline events.

Signature:

fn use_online() -> UseStateHandle<bool>

Usage:

let online = use_online();
html! { <p>{ if *online { "Online" } else { "Offline" } }</p> };

Caveat: Browser navigator.onLine semantics vary (e.g., may report true behind captive portals). Treat as a hint, not a guarantee.

Contributing

Contributions welcome! Suggested flow:

1. Open an issue describing the hook/fix.
2. Keep APIs small and composable.
3. Include docs + an example block in the hook source.
4. Follow existing style and deny warnings.
5. Add feature flags for optional dependencies.

Run cargo fmt + cargo clippy --all-targets --all-features -- -D warnings before submitting.

Testing & Dev Tips

Because hooks depend on wasm32-unknown-unknown + a browser environment:

rustup target add wasm32-unknown-unknown
# Example bundler commands go here (Trunk, Leptos CLI, etc.)

Consider writing integration tests in a harness crate with wasm-bindgen-test (future work for this repo).

License

MIT

Acknowledgements

• Inspired by the design & breadth of yew-hooks.
• gloo utilities for browser interop.