added use_web_lock

2025-01-22 16:49:22 -05:00 · 2024-09-01 20:26:47 +01:00 · 2024-09-01 20:26:47 +01:00 · c60d32bf5a
commit c60d32bf5a
parent 851d209e2a
17 changed files with 605 additions and 3 deletions
--- a/.idea/leptos-use.iml
+++ b/.idea/leptos-use.iml
@ -80,6 +80,10 @@
      <sourceFolder url="file://$MODULE_DIR$/examples/use_user_media/src" isTestSource="false" />
      <sourceFolder url="file://$MODULE_DIR$/examples/use_locale/src" isTestSource="false" />
      <sourceFolder url="file://$MODULE_DIR$/examples/use_locales/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/use_prefers_reduced_motion/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/use_toggle/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/use_web_lock/src" isTestSource="false" />
+      <sourceFolder url="file://$MODULE_DIR$/examples/use_window_size/src" isTestSource="false" />
      <excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" />
      <excludeFolder url="file://$MODULE_DIR$/target" />
      <excludeFolder url="file://$MODULE_DIR$/docs/book/book" />
--- 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 🔥
--- 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"]
--- 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
--- 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 -->
--- 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",
--- 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"
--- 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
+```
--- a/examples/use_web_lock/Trunk.toml
+++ b/examples/use_web_lock/Trunk.toml
@ -0,0 +1,2 @@
+[build]
+public_url = "/demo/"
--- 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>
--- a/examples/use_web_lock/input.css
+++ b/examples/use_web_lock/input.css
@ -0,0 +1,3 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
--- a/examples/use_web_lock/rust-toolchain.toml
+++ b/examples/use_web_lock/rust-toolchain.toml
@ -0,0 +1,2 @@
+[toolchain]
+channel = "nightly"
--- 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/> }
+    })
+}
--- a/examples/use_web_lock/style/output.css
+++ b/examples/use_web_lock/style/output.css
@ -0,0 +1,289 @@
+[type='text'],[type='email'],[type='url'],[type='password'],[type='number'],[type='date'],[type='datetime-local'],[type='month'],[type='search'],[type='tel'],[type='time'],[type='week'],[multiple],textarea,select {
+  -webkit-appearance: none;
+     -moz-appearance: none;
+          appearance: none;
+  background-color: #fff;
+  border-color: #6b7280;
+  border-width: 1px;
+  border-radius: 0px;
+  padding-top: 0.5rem;
+  padding-right: 0.75rem;
+  padding-bottom: 0.5rem;
+  padding-left: 0.75rem;
+  font-size: 1rem;
+  line-height: 1.5rem;
+  --tw-shadow: 0 0 #0000;
+}
+
+[type='text']:focus, [type='email']:focus, [type='url']:focus, [type='password']:focus, [type='number']:focus, [type='date']:focus, [type='datetime-local']:focus, [type='month']:focus, [type='search']:focus, [type='tel']:focus, [type='time']:focus, [type='week']:focus, [multiple]:focus, textarea:focus, select:focus {
+  outline: 2px solid transparent;
+  outline-offset: 2px;
+  --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
+  --tw-ring-offset-width: 0px;
+  --tw-ring-offset-color: #fff;
+  --tw-ring-color: #2563eb;
+  --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
+  --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(1px + var(--tw-ring-offset-width)) var(--tw-ring-color);
+  box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
+  border-color: #2563eb;
+}
+
+input::-moz-placeholder, textarea::-moz-placeholder {
+  color: #6b7280;
+  opacity: 1;
+}
+
+input::placeholder,textarea::placeholder {
+  color: #6b7280;
+  opacity: 1;
+}
+
+::-webkit-datetime-edit-fields-wrapper {
+  padding: 0;
+}
+
+::-webkit-date-and-time-value {
+  min-height: 1.5em;
+}
+
+::-webkit-datetime-edit,::-webkit-datetime-edit-year-field,::-webkit-datetime-edit-month-field,::-webkit-datetime-edit-day-field,::-webkit-datetime-edit-hour-field,::-webkit-datetime-edit-minute-field,::-webkit-datetime-edit-second-field,::-webkit-datetime-edit-millisecond-field,::-webkit-datetime-edit-meridiem-field {
+  padding-top: 0;
+  padding-bottom: 0;
+}
+
+select {
+  background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 20 20'%3e%3cpath stroke='%236b7280' stroke-linecap='round' stroke-linejoin='round' stroke-width='1.5' d='M6 8l4 4 4-4'/%3e%3c/svg%3e");
+  background-position: right 0.5rem center;
+  background-repeat: no-repeat;
+  background-size: 1.5em 1.5em;
+  padding-right: 2.5rem;
+  -webkit-print-color-adjust: exact;
+          print-color-adjust: exact;
+}
+
+[multiple] {
+  background-image: initial;
+  background-position: initial;
+  background-repeat: unset;
+  background-size: initial;
+  padding-right: 0.75rem;
+  -webkit-print-color-adjust: unset;
+          print-color-adjust: unset;
+}
+
+[type='checkbox'],[type='radio'] {
+  -webkit-appearance: none;
+     -moz-appearance: none;
+          appearance: none;
+  padding: 0;
+  -webkit-print-color-adjust: exact;
+          print-color-adjust: exact;
+  display: inline-block;
+  vertical-align: middle;
+  background-origin: border-box;
+  -webkit-user-select: none;
+     -moz-user-select: none;
+          user-select: none;
+  flex-shrink: 0;
+  height: 1rem;
+  width: 1rem;
+  color: #2563eb;
+  background-color: #fff;
+  border-color: #6b7280;
+  border-width: 1px;
+  --tw-shadow: 0 0 #0000;
+}
+
+[type='checkbox'] {
+  border-radius: 0px;
+}
+
+[type='radio'] {
+  border-radius: 100%;
+}
+
+[type='checkbox']:focus,[type='radio']:focus {
+  outline: 2px solid transparent;
+  outline-offset: 2px;
+  --tw-ring-inset: var(--tw-empty,/*!*/ /*!*/);
+  --tw-ring-offset-width: 2px;
+  --tw-ring-offset-color: #fff;
+  --tw-ring-color: #2563eb;
+  --tw-ring-offset-shadow: var(--tw-ring-inset) 0 0 0 var(--tw-ring-offset-width) var(--tw-ring-offset-color);
+  --tw-ring-shadow: var(--tw-ring-inset) 0 0 0 calc(2px + var(--tw-ring-offset-width)) var(--tw-ring-color);
+  box-shadow: var(--tw-ring-offset-shadow), var(--tw-ring-shadow), var(--tw-shadow);
+}
+
+[type='checkbox']:checked,[type='radio']:checked {
+  border-color: transparent;
+  background-color: currentColor;
+  background-size: 100% 100%;
+  background-position: center;
+  background-repeat: no-repeat;
+}
+
+[type='checkbox']:checked {
+  background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3cpath d='M12.207 4.793a1 1 0 010 1.414l-5 5a1 1 0 01-1.414 0l-2-2a1 1 0 011.414-1.414L6.5 9.086l4.293-4.293a1 1 0 011.414 0z'/%3e%3c/svg%3e");
+}
+
+[type='radio']:checked {
+  background-image: url("data:image/svg+xml,%3csvg viewBox='0 0 16 16' fill='white' xmlns='http://www.w3.org/2000/svg'%3e%3ccircle cx='8' cy='8' r='3'/%3e%3c/svg%3e");
+}
+
+[type='checkbox']:checked:hover,[type='checkbox']:checked:focus,[type='radio']:checked:hover,[type='radio']:checked:focus {
+  border-color: transparent;
+  background-color: currentColor;
+}
+
+[type='checkbox']:indeterminate {
+  background-image: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' fill='none' viewBox='0 0 16 16'%3e%3cpath stroke='white' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M4 8h8'/%3e%3c/svg%3e");
+  border-color: transparent;
+  background-color: currentColor;
+  background-size: 100% 100%;
+  background-position: center;
+  background-repeat: no-repeat;
+}
+
+[type='checkbox']:indeterminate:hover,[type='checkbox']:indeterminate:focus {
+  border-color: transparent;
+  background-color: currentColor;
+}
+
+[type='file'] {
+  background: unset;
+  border-color: inherit;
+  border-width: 0;
+  border-radius: 0;
+  padding: 0;
+  font-size: unset;
+  line-height: inherit;
+}
+
+[type='file']:focus {
+  outline: 1px solid ButtonText;
+  outline: 1px auto -webkit-focus-ring-color;
+}
+
+*, ::before, ::after {
+  --tw-border-spacing-x: 0;
+  --tw-border-spacing-y: 0;
+  --tw-translate-x: 0;
+  --tw-translate-y: 0;
+  --tw-rotate: 0;
+  --tw-skew-x: 0;
+  --tw-skew-y: 0;
+  --tw-scale-x: 1;
+  --tw-scale-y: 1;
+  --tw-pan-x:  ;
+  --tw-pan-y:  ;
+  --tw-pinch-zoom:  ;
+  --tw-scroll-snap-strictness: proximity;
+  --tw-gradient-from-position:  ;
+  --tw-gradient-via-position:  ;
+  --tw-gradient-to-position:  ;
+  --tw-ordinal:  ;
+  --tw-slashed-zero:  ;
+  --tw-numeric-figure:  ;
+  --tw-numeric-spacing:  ;
+  --tw-numeric-fraction:  ;
+  --tw-ring-inset:  ;
+  --tw-ring-offset-width: 0px;
+  --tw-ring-offset-color: #fff;
+  --tw-ring-color: rgb(59 130 246 / 0.5);
+  --tw-ring-offset-shadow: 0 0 #0000;
+  --tw-ring-shadow: 0 0 #0000;
+  --tw-shadow: 0 0 #0000;
+  --tw-shadow-colored: 0 0 #0000;
+  --tw-blur:  ;
+  --tw-brightness:  ;
+  --tw-contrast:  ;
+  --tw-grayscale:  ;
+  --tw-hue-rotate:  ;
+  --tw-invert:  ;
+  --tw-saturate:  ;
+  --tw-sepia:  ;
+  --tw-drop-shadow:  ;
+  --tw-backdrop-blur:  ;
+  --tw-backdrop-brightness:  ;
+  --tw-backdrop-contrast:  ;
+  --tw-backdrop-grayscale:  ;
+  --tw-backdrop-hue-rotate:  ;
+  --tw-backdrop-invert:  ;
+  --tw-backdrop-opacity:  ;
+  --tw-backdrop-saturate:  ;
+  --tw-backdrop-sepia:  ;
+}
+
+::backdrop {
+  --tw-border-spacing-x: 0;
+  --tw-border-spacing-y: 0;
+  --tw-translate-x: 0;
+  --tw-translate-y: 0;
+  --tw-rotate: 0;
+  --tw-skew-x: 0;
+  --tw-skew-y: 0;
+  --tw-scale-x: 1;
+  --tw-scale-y: 1;
+  --tw-pan-x:  ;
+  --tw-pan-y:  ;
+  --tw-pinch-zoom:  ;
+  --tw-scroll-snap-strictness: proximity;
+  --tw-gradient-from-position:  ;
+  --tw-gradient-via-position:  ;
+  --tw-gradient-to-position:  ;
+  --tw-ordinal:  ;
+  --tw-slashed-zero:  ;
+  --tw-numeric-figure:  ;
+  --tw-numeric-spacing:  ;
+  --tw-numeric-fraction:  ;
+  --tw-ring-inset:  ;
+  --tw-ring-offset-width: 0px;
+  --tw-ring-offset-color: #fff;
+  --tw-ring-color: rgb(59 130 246 / 0.5);
+  --tw-ring-offset-shadow: 0 0 #0000;
+  --tw-ring-shadow: 0 0 #0000;
+  --tw-shadow: 0 0 #0000;
+  --tw-shadow-colored: 0 0 #0000;
+  --tw-blur:  ;
+  --tw-brightness:  ;
+  --tw-contrast:  ;
+  --tw-grayscale:  ;
+  --tw-hue-rotate:  ;
+  --tw-invert:  ;
+  --tw-saturate:  ;
+  --tw-sepia:  ;
+  --tw-drop-shadow:  ;
+  --tw-backdrop-blur:  ;
+  --tw-backdrop-brightness:  ;
+  --tw-backdrop-contrast:  ;
+  --tw-backdrop-grayscale:  ;
+  --tw-backdrop-hue-rotate:  ;
+  --tw-backdrop-invert:  ;
+  --tw-backdrop-opacity:  ;
+  --tw-backdrop-saturate:  ;
+  --tw-backdrop-sepia:  ;
+}
+
+.block {
+  display: block;
+}
+
+.text-\[--brand-color\] {
+  color: var(--brand-color);
+}
+
+.text-green-600 {
+  --tw-text-opacity: 1;
+  color: rgb(22 163 74 / var(--tw-text-opacity));
+}
+
+.opacity-75 {
+  opacity: 0.75;
+}
+
+@media (prefers-color-scheme: dark) {
+  .dark\:text-green-500 {
+    --tw-text-opacity: 1;
+    color: rgb(34 197 94 / var(--tw-text-opacity));
+  }
+}
--- a/examples/use_web_lock/tailwind.config.js
+++ b/examples/use_web_lock/tailwind.config.js
@ -0,0 +1,15 @@
+/** @type {import('tailwindcss').Config} */
+module.exports = {
+    content: {
+        files: ["*.html", "./src/**/*.rs", "../../src/docs/**/*.rs"],
+    },
+    theme: {
+        extend: {},
+    },
+    corePlugins: {
+        preflight: false,
+    },
+    plugins: [
+        require('@tailwindcss/forms'),
+    ],
+}
--- a/src/lib.rs
+++ b/src/lib.rs
@ -28,6 +28,8 @@ mod is_ok;
 mod is_some;
 #[cfg(feature = "on_click_outside")]
 mod on_click_outside;
+#[cfg(feature = "use_web_lock")]
+mod use_web_lock;
 #[cfg(feature = "use_window_size")]
 mod use_window_size;
 #[cfg(feature = "signal_debounced")]
@ -171,6 +173,8 @@ pub use is_ok::*;
 pub use is_some::*;
 #[cfg(feature = "on_click_outside")]
 pub use on_click_outside::*;
+#[cfg(feature = "use_web_lock")]
+pub use use_web_lock::*;
 #[cfg(feature = "use_window_size")]
 pub use use_window_size::*;
 #[cfg(feature = "signal_debounced")]
--- a/src/use_web_lock.rs
+++ b/src/use_web_lock.rs
@ -0,0 +1,174 @@
+use default_struct_builder::DefaultBuilder;
+use std::future::Future;
+use thiserror::Error;
+use wasm_bindgen::JsValue;
+pub use web_sys::LockMode;
+
+/// Rustified [Web Locks API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Locks_API).   
+///
+/// The **Web Locks API** allows scripts running in one tab or worker to asynchronously acquire a 
+/// lock, hold it while work is performed, then release it. While held, no other script executing 
+/// in the same origin can acquire the same lock, which allows a web app running in multiple tabs or 
+/// workers to coordinate work and the use of resources.
+/// 
+/// > This function requires `--cfg=web_sys_unstable_apis` to be activated as
+/// [described in the wasm-bindgen guide](https://rustwasm.github.io/docs/wasm-bindgen/web-sys/unstable-apis.html).
+///
+/// ## Demo
+///
+/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_web_lock)
+///
+/// ## Usage
+///
+/// ```
+/// # use leptos::*;
+/// # use leptos_use::use_web_lock;
+/// #
+/// async fn my_process(_lock: web_sys::Lock) -> i32 {
+///     // do sth
+///     42
+/// }
+///
+/// # #[component]
+/// # fn Demo() -> impl IntoView {
+/// spawn_local(async {
+///     let res = use_web_lock("my_lock", my_process).await;
+///     assert!(matches!(res, Ok(42)));
+/// });
+/// #
+/// # view! { }
+/// # }
+/// ```
+///
+/// ## Server-Side Rendering
+///
+/// On the server this returns `Err(UseWebLockError::Server)` and the task is not executed.
+// #[doc(cfg(feature = "use_web_lock"))]
+
+pub async fn use_web_lock<C, F, R>(name: &str, callback: C) -> Result<R, UseWebLockError>
+where
+    C: FnOnce(web_sys::Lock) -> F + 'static,
+    F: Future<Output = R>,
+    R: 'static,
+{
+    use_web_lock_with_options(name, callback, UseWebLockOptions::default()).await
+}
+
+/// Version of [`fn@crate::use_web_lock`] that takes a `UseWebLockOptions`. See [`fn@crate::use_web_lock`] for how to use.
+// #[doc(cfg(feature = "use_web_lock"))]
+pub async fn use_web_lock_with_options<C, F, R>(
+    name: &str,
+    callback: C,
+    options: UseWebLockOptions,
+) -> Result<R, UseWebLockError>
+where
+    C: FnOnce(web_sys::Lock) -> F + 'static,
+    F: Future<Output = R>,
+    R: 'static,
+{
+    #[cfg(feature = "ssr")]
+    {
+        let _ = name;
+        let _ = callback;
+        let _ = options;
+
+        Err(UseWebLockError::Server)
+    }
+
+    #[cfg(not(feature = "ssr"))]
+    {
+        use crate::js_fut;
+        use leptos::window;
+        use std::sync::{Arc, Mutex};
+        use wasm_bindgen::closure::Closure;
+        use wasm_bindgen::JsCast;
+        use wasm_bindgen_futures::future_to_promise;
+
+        let ret_value = Arc::new(Mutex::new(None));
+
+        let handler = Closure::once(Box::new({
+            let ret_value = Arc::clone(&ret_value);
+
+            move |lock| {
+                future_to_promise(async move {
+                    let ret = callback(lock).await;
+                    ret_value.lock().expect("Lock failed").replace(ret);
+                    Ok(JsValue::null())
+                })
+            }
+        }) as Box<dyn FnOnce(web_sys::Lock) -> _>)
+        .into_js_value();
+
+        let lock_promise = window()
+            .navigator()
+            .locks()
+            .request_with_options_and_callback(
+                name,
+                &options.to_web_sys(),
+                handler.unchecked_ref(),
+            );
+
+        js_fut!(lock_promise)
+            .await
+            .map(move |_| {
+                Arc::into_inner(ret_value)
+                    .expect("Arc has more than one reference still")
+                    .into_inner()
+                    .expect("Lock failed")
+                    .expect("Return value was None")
+            })
+            .map_err(UseWebLockError::Failed)
+    }
+}
+
+#[derive(Error, Debug)]
+pub enum UseWebLockError {
+    #[error("Lock cannot be acquired on the server")]
+    Server,
+
+    #[error("Lock failed")]
+    Failed(JsValue),
+}
+
+/// Options for [`fn@crate::use_web_lock_with_options`].
+// #[doc(cfg(feature = "use_web_lock"))]
+#[allow(dead_code)]
+#[derive(DefaultBuilder)]
+pub struct UseWebLockOptions {
+    /// The default mode is `LockMode::Exclusive`, but `LockMode::Shared` can be specified.
+    /// There can be only one `Exclusive` holder of a lock, but multiple `Shared` requests can be
+    /// granted at the same time. This can be used to implement the
+    /// [readers-writer pattern](https://en.wikipedia.org/wiki/Readers%E2%80%93writer_lock).
+    mode: LockMode,
+
+    /// If `true`, the lock request will fail if the lock cannot be granted immediately without
+    /// waiting. The callback is invoked with `null`. Defaults to `false`.
+    if_available: bool,
+
+    /// If `true`, then any held locks with the same name will be released, and the request will
+    /// be granted, preempting any queued requests for it. Defaults to `false`.
+    steal: bool,
+    // TODO : add abort signal (this also requires to create a wrapper for AbortSignal similar to UseWindow)
+}
+
+#[cfg(not(feature = "ssr"))]
+impl UseWebLockOptions {
+    fn to_web_sys(&self) -> web_sys::LockOptions {
+        let options = web_sys::LockOptions::new();
+        options.set_mode(self.mode);
+        options.set_if_available(self.if_available);
+        options.set_steal(self.steal);
+
+        options
+    }
+}
+
+impl Default for UseWebLockOptions {
+    fn default() -> Self {
+        Self {
+            mode: LockMode::Exclusive,
+            if_available: false,
+            steal: false,
+        }
+    }
+}