added use_web_lock

Synphonyte · Sep 1, 2024 · c60d32b · c60d32b
1 parent 851d209
commit c60d32b
Show file tree

Hide file tree

Showing 17 changed files with 605 additions and 3 deletions.
diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,11 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] - 
+## [0.13.1] - 2024-09-01 
 
-### New Function 🚀
+### New Functions 🚀
 
+- `use_web_lock`
 - `use_window_size`
 
 ### Change 🔥

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "leptos-use"
-version = "0.13.0"
+version = "0.13.1"
 edition = "2021"
 authors = ["Marc-Stefan Cassola"]
 categories = ["gui", "web-programming"]
@@ -48,6 +48,7 @@ unic-langid = { version = "0.9", features = ["macros"] }
 
 [features]
 default = [
+    "use_web_lock",
     "use_window_size",
     "is_err",
     "is_none",
@@ -121,6 +122,14 @@ default = [
     "watch_with_options",
     "whenever"
 ]
+use_web_lock = [
+    "web-sys/AbortSignal",
+    "web-sys/Lock",
+    "web-sys/LockManager",
+    "web-sys/LockMode",
+    "web-sys/LockOptions",
+    "web-sys/Navigator",
+]
 use_window_size = ["use_media_query"]
 actix = ["dep:actix-web", "dep:leptos_actix", "dep:http0_2"]
 axum = ["dep:leptos_axum", "dep:http1"]

diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -52,6 +52,7 @@
 - [use_prefers_reduced_motion](browser/use_prefers_reduced_motion.md)
 - [use_service_worker](browser/use_service_worker.md)
 - [use_user_media](browser/use_user_media.md)
+- [use_web_lock](browser/use_web_lock.md)
 - [use_web_notification](browser/use_web_notification.md)
 
 # Sensors

diff --git a/docs/book/src/browser/use_web_lock.md b/docs/book/src/browser/use_web_lock.md
@@ -0,0 +1,3 @@
+# use_web_lock
+
+<!-- cmdrun python3 ../extract_doc_comment.py use_web_lock use_web_lock -->
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -60,6 +60,7 @@ members = [
     "use_timestamp",
     "use_toggle",
     "use_user_media",
+    "use_web_lock",
     "use_web_notification",
     "use_websocket",
     "use_webtransport",

diff --git a/examples/use_web_lock/Cargo.toml b/examples/use_web_lock/Cargo.toml
@@ -0,0 +1,17 @@
+[package]
+name = "use_web_lock"
+version = "0.1.0"
+edition = "2021"
+
+[dependencies]
+gloo-timers = { version = "0.3", features = ["futures"] }
+leptos = { version = "0.6", features = ["nightly", "csr"] }
+console_error_panic_hook = "0.1"
+console_log = "1"
+log = "0.4"
+leptos-use = { path = "../..", features = ["use_web_lock", "docs"] }
+web-sys = { version = "0.3", features = ["Lock"] }
+
+[dev-dependencies]
+wasm-bindgen = "0.2"
+wasm-bindgen-test = "0.3.0"
diff --git a/examples/use_web_lock/README.md b/examples/use_web_lock/README.md
@@ -0,0 +1,23 @@
+A simple example for `use_web_lock`.
+
+If you don't have it installed already, install [Trunk](https://trunkrs.dev/) and [Tailwind](https://tailwindcss.com/docs/installation)
+as well as the nightly toolchain for Rust and the wasm32-unknown-unknown target:
+
+```bash
+cargo install trunk
+npm install -D tailwindcss @tailwindcss/forms
+rustup toolchain install nightly
+rustup target add wasm32-unknown-unknown
+```
+
+Then, open two terminals. In the first one, run:
+
+```
+npx tailwindcss -i ./input.css -o ./style/output.css --watch
+```
+
+In the second one, run:
+
+```bash
+trunk serve --open
+```
diff --git a/examples/use_web_lock/Trunk.toml b/examples/use_web_lock/Trunk.toml
@@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
diff --git a/examples/use_web_lock/index.html b/examples/use_web_lock/index.html
@@ -0,0 +1,7 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <link data-trunk rel="css" href="style/output.css">
+  </head>
+  <body></body>
+</html>
diff --git a/examples/use_web_lock/input.css b/examples/use_web_lock/input.css
@@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
diff --git a/examples/use_web_lock/rust-toolchain.toml b/examples/use_web_lock/rust-toolchain.toml
@@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
diff --git a/examples/use_web_lock/src/main.rs b/examples/use_web_lock/src/main.rs
@@ -0,0 +1,47 @@
+use gloo_timers::future::sleep;
+use leptos::*;
+use leptos_use::docs::demo_or_body;
+use leptos_use::use_web_lock;
+use std::time::Duration;
+
+async fn my_process(_lock: web_sys::Lock) -> i32 {
+    sleep(Duration::from_millis(2000)).await;
+
+    42
+}
+
+#[component]
+fn Demo() -> impl IntoView {
+    let (res, set_res) = create_signal("Not started yet".to_string());
+
+    let on_click = move |_| {
+        set_res.set("Running...".to_string());
+
+        spawn_local(async move {
+            let res = use_web_lock("my_lock", my_process).await;
+
+            match res {
+                Ok(res) => {
+                    set_res.set(format!("Result: {}", res));
+                }
+                Err(e) => {
+                    set_res.set(format!("Error: {:?}", e));
+                }
+            }
+        });
+    };
+
+    view! {
+        <button on:click=on_click>Run locked task</button>
+        <p>{res}</p>
+    }
+}
+
+fn main() {
+    _ = console_log::init_with_level(log::Level::Debug);
+    console_error_panic_hook::set_once();
+
+    mount_to(demo_or_body(), || {
+        view! { <Demo/> }
+    })
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# use_web_lock

		<!-- cmdrun python3 ../extract_doc_comment.py use_web_lock use_web_lock -->