Add storage hook

Cargo.toml

@@ -22,14 +22,16 @@ geolocation = ["dep:windows", "dep:futures-util", "dep:futures", "dep:web-sys",
 color_scheme = ["dep:web-sys", "dep:wasm-bindgen", "dep:wasm-bindgen-futures"]
 utils = ["dep:async-broadcast", "dep:uuid"]
 i18n = ["dep:serde", "dep:serde_json", "dep:unic-langid"]
-all = ["clipboard", "notifications", "geolocation", "color_scheme", "utils", "i18n"]
+storage = ["dep:dioxus-signals", "dep:serde", "dep:postcard", "dep:once_cell", "dep:web-sys", "web-sys/Document", "web-sys/Element", "web-sys/HtmlDocument", "web-sys/Storage", "dep:wasm-bindgen", "dep:wasm-bindgen-futures", "dep:directories", "dep:yazi", "dep:tokio"]
+all = ["clipboard", "notifications", "geolocation", "color_scheme", "utils", "i18n", "storage"]
+default = []
 
 # CI testing
 wasm-testing = ["geolocation", "color_scheme", "utils", "i18n"]
 desktop-testing = ["clipboard", "notifications", "geolocation", "utils", "i18n"]
 
 [dependencies]
-dioxus = { version = "0.4" }
+dioxus = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
 cfg-if = "1.0.0"
 
 # utils
@@ -46,12 +48,29 @@ futures-util = {version = "0.3.28", optional = true }
 serde = { version = "1.0.163", optional = true }
 serde_json = { version = "1.0.96", optional = true }
 unic-langid = { version = "0.9.1", features = ["serde"], optional = true }
+# storage
+rustc-hash = "1.1.0"
+postcard = { version = "1.0.2", features = ["use-std"], optional = true }
+once_cell = { version = "1.17.0", optional = true }
+dioxus-signals = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39", features = [
+    "serialize",
+], optional = true }
+tokio = { version = "1.33.0", features = ["sync"], optional = true }
+yazi = { version = "0.1.4", optional = true }
+log = "0.4.6"
+
+# WebAssembly Debug
+wasm-logger = "0.2.0"
+console_error_panic_hook = "0.1.7"
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+directories = { version = "4.0.1", optional = true }
 
 [target.'cfg(windows)'.dependencies]
 windows = { version = "0.48.0", features = ["Foundation", "Devices_Geolocation"], optional = true }
 
 [target.'cfg(target_family = "wasm")'.dependencies]
-web-sys = { version = "0.3.60", features = ["Window", "MediaQueryList", "Navigator", "Geolocation", "PositionOptions"], optional = true }
+web-sys = { version = "0.3.60", features = ["Window", "MediaQueryList", "Navigator", "Geolocation", "PositionOptions", "EventTarget", "EventListener", "StorageEvent"], optional = true }
 wasm-bindgen = { version = "0.2.87", optional = true }
 wasm-bindgen-futures = { version = "0.4.35", optional = true}
 js-sys = "0.3.62"

examples/storage_desktop/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "storage-desktop"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus-std = { path="../../", features = ["storage"] }
+dioxus = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
+dioxus-desktop = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
+dioxus-router = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
+log = "0.4.6"
+

examples/storage_desktop/README.md

@@ -0,0 +1,7 @@
+# use_persistant
+
+Learn how to use `use_persistant`.
+
+Run:
+
+```dioxus serve```

examples/storage_desktop/src/main.rs

@@ -0,0 +1,113 @@
+use dioxus::prelude::*;
+use dioxus_router::prelude::*;
+use dioxus_std::storage::*;
+
+fn main() {
+    match log::set_boxed_logger(Box::new(simple_logger::SimpleLogger)) {
+        Ok(_) => log::set_max_level(log::LevelFilter::Info),
+        Err(e) => panic!("Failed to initialize logger: {}", e),
+    }
+    dioxus_std::storage::set_dir!();
+    dioxus_desktop::launch(App);
+}
+
+#[component]
+fn App(cx: Scope) -> Element {
+    render! {
+        Router::<Route> {}
+    }
+}
+
+#[derive(Routable, Clone)]
+#[rustfmt::skip]
+enum Route {
+    #[layout(Footer)]
+        #[route("/")]
+        Page1 {},
+        #[route("/page2")]
+        Page2 {},
+}
+
+#[component]
+fn Footer(cx: Scope) -> Element {
+    let window = dioxus_desktop::use_window(cx);
+
+    render! {
+        div {
+            Outlet::<Route> { }
+
+            p {
+                "----"
+            }
+
+            div {
+                button {
+                    onclick: move |_| {
+                        let dom = VirtualDom::new(App);
+                        window.new_window(dom, Default::default());
+                    },
+                    "New Window"
+                }
+            }
+
+            nav {
+                ul {
+                    li { Link { to: Route::Page1 {}, "Page1" } }
+                    li { Link { to: Route::Page2 {}, "Page2" } }
+                }
+            }
+        }
+    }
+}
+
+#[component]
+fn Page1(cx: Scope) -> Element {
+    render!("Home")
+}
+
+#[component]
+fn Page2(cx: Scope) -> Element {
+    let count_session = use_singleton_persistent(cx, || 0);
+    let count_local = use_synced_storage::<LocalStorage, i32>(cx, "synced".to_string(), || 0);
+
+    render!(
+        div {
+            button {
+                onclick: move |_| {
+                    *count_session.write() += 1;
+                },
+                "Click me!"
+            },
+            "I persist for the current session. Clicked {count_session} times"
+        }
+        div {
+            button {
+                onclick: move |_| {
+                    *count_local.write() += 1;
+                },
+                "Click me!"
+            },
+            "I persist across all sessions. Clicked {count_local} times"
+        }
+    )
+}
+
+mod simple_logger {
+    use log::{Metadata, Record};
+
+    pub struct SimpleLogger;
+
+    impl log::Log for SimpleLogger {
+        fn enabled(&self, metadata: &Metadata) -> bool {
+            metadata.level() <= log::max_level()
+        }
+
+        fn log(&self, record: &Record) {
+            if self.enabled(record.metadata()) {
+                println!("{} - {}", record.level(), record.args());
+            }
+        }
+
+        fn flush(&self) {}
+    }
+}

examples/storage_web/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "storage-web"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+dioxus-std = { path="../../", features = ["storage"] }
+dioxus = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
+dioxus-web = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
+dioxus-router = { git = "https://github.com/DioxusLabs/dioxus.git", rev = "647815fa6f6db2304cda5bd36c78b4f8b0379f39" }
+log = "0.4.6"
+
+# WebAssembly Debug
+wasm-logger = "0.2.0"
+console_error_panic_hook = "0.1.7"

examples/storage_web/README.md

@@ -0,0 +1,7 @@
+# use_persistant
+
+Learn how to use `use_persistant`.
+
+Run:
+
+```dioxus serve```

examples/storage_web/src/main.rs

@@ -0,0 +1,79 @@
+use dioxus::prelude::*;
+use dioxus_router::prelude::*;
+use dioxus_std::storage::*;
+
+fn main() {
+    // init debug tool for WebAssembly
+    wasm_logger::init(wasm_logger::Config::default());
+    console_error_panic_hook::set_once();
+    dioxus_web::launch(App);
+}
+
+#[component]
+fn App(cx: Scope) -> Element {
+    render! {
+        Router::<Route> {}
+    }
+}
+
+#[derive(Routable, Clone)]
+#[rustfmt::skip]
+enum Route {
+    #[layout(Footer)]
+        #[route("/")]
+        Page1 {},
+        #[route("/page2")]
+        Page2 {},
+}
+
+#[component]
+fn Footer(cx: Scope) -> Element {
+    render! {
+        div {
+            Outlet::<Route> { }
+
+            p {
+                "----"
+            }
+
+            nav {
+                ul {
+                    li { Link { to: Route::Page1 {}, "Page1" } }
+                    li { Link { to: Route::Page2 {}, "Page2" } }
+                }
+            }
+        }
+    }
+}
+
+#[component]
+fn Page1(cx: Scope) -> Element {
+    render!("Home")
+}
+
+#[component]
+fn Page2(cx: Scope) -> Element {
+    let count_session = use_singleton_persistent(cx, || 0);
+    let count_local = use_synced_storage::<LocalStorage, i32>(cx, "synced".to_string(), || 0);
+
+    render!(
+        div {
+            button {
+                onclick: move |_| {
+                    *count_session.write() += 1;
+                },
+                "Click me!"
+            },
+            "I persist for the current session. Clicked {count_session} times"
+        }
+        div {
+            button {
+                onclick: move |_| {
+                    *count_local.write() += 1;
+                },
+                "Click me!"
+            },
+            "I persist across all sessions. Clicked {count_local} times"
+        }
+    )
+}

src/lib.rs

@@ -29,3 +29,9 @@ cfg_if::cfg_if! {
         pub mod clipboard;
     }
 }
+
+cfg_if::cfg_if! {
+    if #[cfg(feature = "storage")] {
+        pub mod storage;
+    }
+}