yew_hooks/hooks/
use_local_storage.rs

1use std::ops::Deref;
2use std::rc::Rc;
3
4use gloo::storage::{LocalStorage, Storage};
5use serde::{Deserialize, Serialize};
6use web_sys::StorageEvent;
7use yew::prelude::*;
8
9use super::use_event_with_window;
10
11/// State handle for the [`use_local_storage`] hook.
12pub struct UseLocalStorageHandle<T> {
13    inner: UseStateHandle<Option<T>>,
14    key: Rc<String>,
15}
16
17impl<T> UseLocalStorageHandle<T> {
18    /// Set a `value` for the specified key.
19    pub fn set(&self, value: T)
20    where
21        T: Serialize + Clone,
22    {
23        if LocalStorage::set(&*self.key, value.clone()).is_ok() {
24            self.inner.set(Some(value));
25        }
26    }
27
28    /// Delete a key and it's stored value.
29    pub fn delete(&self) {
30        LocalStorage::delete(&*self.key);
31        self.inner.set(None);
32    }
33}
34
35impl<T> Deref for UseLocalStorageHandle<T> {
36    type Target = Option<T>;
37
38    fn deref(&self) -> &Self::Target {
39        &self.inner
40    }
41}
42
43impl<T> Clone for UseLocalStorageHandle<T> {
44    fn clone(&self) -> Self {
45        Self {
46            inner: self.inner.clone(),
47            key: self.key.clone(),
48        }
49    }
50}
51
52impl<T> PartialEq for UseLocalStorageHandle<T>
53where
54    T: PartialEq,
55{
56    fn eq(&self, other: &Self) -> bool {
57        *self.inner == *other.inner
58    }
59}
60
61/// A side-effect hook that manages a single localStorage key.
62///
63/// # Example
64///
65/// ```rust
66/// # use yew::prelude::*;
67/// #
68/// use yew_hooks::prelude::*;
69///
70/// #[function_component(LocalStorage)]
71/// fn local_storage() -> Html {
72///     let storage = use_local_storage::<String>("foo".to_string());
73///     
74///     let onclick = {
75///         let storage = storage.clone();
76///         Callback::from(move |_| storage.set("bar".to_string()))
77///     };
78///     let ondelete = {
79///         let storage = storage.clone();
80///         Callback::from(move |_| storage.delete())
81///     };
82///
83///     html! {
84///         <div>
85///             <button onclick={onclick}>{ "Set to bar" }</button>
86///             <button onclick={ondelete}>{ "Delete" }</button>
87///             <p>
88///                 <b>{ "Current value: " }</b>
89///                 {
90///                     if let Some(value) = &*storage {
91///                         html! { value }
92///                     } else {
93///                         html! {}
94///                     }
95///                 }
96///             </p>
97///         </div>
98///     }
99/// }
100/// ```
101#[hook]
102pub fn use_local_storage<T>(key: String) -> UseLocalStorageHandle<T>
103where
104    T: for<'de> Deserialize<'de> + 'static,
105{
106    let inner: UseStateHandle<Option<T>> =
107        use_state(|| LocalStorage::get(&key).unwrap_or_default());
108    let key = use_memo((), |_| key);
109
110    {
111        let key = key.clone();
112        let inner = inner.clone();
113        use_event_with_window("storage", move |e: StorageEvent| {
114            if let Some(k) = e.key() {
115                if k == *key {
116                    inner.set(LocalStorage::get(&*key).unwrap_or_default());
117                }
118            }
119        });
120    }
121
122    UseLocalStorageHandle { inner, key }
123}
yew_hooks/hooks/use_local_storage.rs

yew_hooks/hooks/
use_local_storage.rs
