Function use_local_storage

pub fn use_local_storage<'hook, T>(
    key: String,
) -> impl 'hook + Hook<Output = UseLocalStorageHandle<T>>
where
    T: for<'de> Deserialize<'de> + 'static + 'hook,

A side-effect hook that manages a single localStorage key.

Example

use yew_hooks::prelude::*;

#[function_component(LocalStorage)]
fn local_storage() -> Html {
    let storage = use_local_storage::<String>("foo".to_string());
    
    let onclick = {
        let storage = storage.clone();
        Callback::from(move |_| storage.set("bar".to_string()))
    };
    let ondelete = {
        let storage = storage.clone();
        Callback::from(move |_| storage.delete())
    };

    html! {
        <div>
            <button onclick={onclick}>{ "Set to bar" }</button>
            <button onclick={ondelete}>{ "Delete" }</button>
            <p>
                <b>{ "Current value: " }</b>
                {
                    if let Some(value) = &*storage {
                        html! { value }
                    } else {
                        html! {}
                    }
                }
            </p>
        </div>
    }
}

Note

When used in function components and hooks, this hook is equivalent to:

pub fn use_local_storage<T>(key: String) -> UseLocalStorageHandle<T>
where
    T: for<'de> Deserialize<'de> + 'static,
{
    /* implementation omitted */
}