From 022c7702871bae5689f8b7cad651304aa7e9f28b Mon Sep 17 00:00:00 2001 From: Maccesch Date: Tue, 12 Sep 2023 23:53:43 +0100 Subject: [PATCH] added geolocation --- .idea/leptos-use.iml | 1 + CHANGELOG.md | 5 +- Cargo.toml | 7 +- docs/book/src/SUMMARY.md | 1 + docs/book/src/sensors/use_geolocation.md | 3 + examples/Cargo.toml | 1 + examples/use_geolocation/Cargo.toml | 16 + examples/use_geolocation/README.md | 23 ++ examples/use_geolocation/Trunk.toml | 2 + examples/use_geolocation/index.html | 7 + examples/use_geolocation/input.css | 3 + examples/use_geolocation/rust-toolchain.toml | 2 + examples/use_geolocation/src/main.rs | 47 +++ examples/use_geolocation/style/output.css | 289 +++++++++++++++++++ examples/use_geolocation/tailwind.config.js | 15 + src/lib.rs | 2 + src/use_geolocation.rs | 200 +++++++++++++ 17 files changed, 621 insertions(+), 3 deletions(-) create mode 100644 docs/book/src/sensors/use_geolocation.md create mode 100644 examples/use_geolocation/Cargo.toml create mode 100644 examples/use_geolocation/README.md create mode 100644 examples/use_geolocation/Trunk.toml create mode 100644 examples/use_geolocation/index.html create mode 100644 examples/use_geolocation/input.css create mode 100644 examples/use_geolocation/rust-toolchain.toml create mode 100644 examples/use_geolocation/src/main.rs create mode 100644 examples/use_geolocation/style/output.css create mode 100644 examples/use_geolocation/tailwind.config.js create mode 100644 src/use_geolocation.rs diff --git a/.idea/leptos-use.iml b/.idea/leptos-use.iml index a3dc1d2..4513a60 100644 --- a/.idea/leptos-use.iml +++ b/.idea/leptos-use.iml @@ -53,6 +53,7 @@ + diff --git a/CHANGELOG.md b/CHANGELOG.md index e89e53c..ecaaa65 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### New Functions 🚀 +- `use_geolocation` - `signal_debounced` - `signal_throttled` @@ -15,8 +16,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Leptos version is now 0.5 - No `cx: Scope` params are supported/needed anymore because of the changes in Leptos. Please check the release notes of Leptos 0.5 for how to upgrade. -- `watch` is now removed in favor of `leptos::watch` and will be removed in a future release. -`watch_with_options` will continue to exist. +- `watch` is now deprecated in favor of `leptos::watch` and will be removed in a future release. + `watch_with_options` will continue to exist. - `use_websocket`: - takes now a `&str` instead of a `String` as its `url` parameter. - The `ready_state` return type is now renamed to `ConnectionReadyState` instead of `UseWebSocketReadyState`. diff --git a/Cargo.toml b/Cargo.toml index 9903c71..f82138f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -29,8 +29,9 @@ version = "0.3" features = [ "AddEventListenerOptions", "BinaryType", - "CssStyleDeclaration", + "Coordinates", "CloseEvent", + "CssStyleDeclaration", "CustomEvent", "CustomEventInit", "DomRect", @@ -43,6 +44,7 @@ features = [ "EventTarget", "File", "FileList", + "Geolocation", "HtmlElement", "HtmlLinkElement", "HtmlStyleElement", @@ -57,6 +59,9 @@ features = [ "Navigator", "NodeList", "PointerEvent", + "Position", + "PositionError", + "PositionOptions", "ResizeObserver", "ResizeObserverBoxOptions", "ResizeObserverEntry", diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 49697a3..1a82b6e 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -41,6 +41,7 @@ - [on_click_outside](sensors/on_click_outside.md) - [use_element_hover](sensors/use_element_hover.md) +- [use_geolocation](sensors/use_geolocation.md) - [use_mouse](sensors/use_mouse.md) - [use_scroll](sensors/use_scroll.md) diff --git a/docs/book/src/sensors/use_geolocation.md b/docs/book/src/sensors/use_geolocation.md new file mode 100644 index 0000000..f27d246 --- /dev/null +++ b/docs/book/src/sensors/use_geolocation.md @@ -0,0 +1,3 @@ +# use_geolocation + + diff --git a/examples/Cargo.toml b/examples/Cargo.toml index 4c3dec2..ee3b98e 100644 --- a/examples/Cargo.toml +++ b/examples/Cargo.toml @@ -22,6 +22,7 @@ members = [ "use_event_listener", "use_favicon", "use_floor", + "use_geolocation", "use_intersection_observer", "use_interval", "use_interval_fn", diff --git a/examples/use_geolocation/Cargo.toml b/examples/use_geolocation/Cargo.toml new file mode 100644 index 0000000..d1e017f --- /dev/null +++ b/examples/use_geolocation/Cargo.toml @@ -0,0 +1,16 @@ +[package] +name = "use_geolocation" +version = "0.1.0" +edition = "2021" + +[dependencies] +leptos = { version = "0.5.0-rc1", features = ["nightly", "csr"] } +console_error_panic_hook = "0.1" +console_log = "1" +log = "0.4" +leptos-use = { path = "../..", features = ["docs"] } +web-sys = "0.3" + +[dev-dependencies] +wasm-bindgen = "0.2" +wasm-bindgen-test = "0.3.0" diff --git a/examples/use_geolocation/README.md b/examples/use_geolocation/README.md new file mode 100644 index 0000000..b2d630a --- /dev/null +++ b/examples/use_geolocation/README.md @@ -0,0 +1,23 @@ +A simple example for `use_geolocation`. + +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 +``` \ No newline at end of file diff --git a/examples/use_geolocation/Trunk.toml b/examples/use_geolocation/Trunk.toml new file mode 100644 index 0000000..3e4be08 --- /dev/null +++ b/examples/use_geolocation/Trunk.toml @@ -0,0 +1,2 @@ +[build] +public_url = "/demo/" \ No newline at end of file diff --git a/examples/use_geolocation/index.html b/examples/use_geolocation/index.html new file mode 100644 index 0000000..ae249a6 --- /dev/null +++ b/examples/use_geolocation/index.html @@ -0,0 +1,7 @@ + + + + + + + diff --git a/examples/use_geolocation/input.css b/examples/use_geolocation/input.css new file mode 100644 index 0000000..bd6213e --- /dev/null +++ b/examples/use_geolocation/input.css @@ -0,0 +1,3 @@ +@tailwind base; +@tailwind components; +@tailwind utilities; \ No newline at end of file diff --git a/examples/use_geolocation/rust-toolchain.toml b/examples/use_geolocation/rust-toolchain.toml new file mode 100644 index 0000000..271800c --- /dev/null +++ b/examples/use_geolocation/rust-toolchain.toml @@ -0,0 +1,2 @@ +[toolchain] +channel = "nightly" \ No newline at end of file diff --git a/examples/use_geolocation/src/main.rs b/examples/use_geolocation/src/main.rs new file mode 100644 index 0000000..c4e70f7 --- /dev/null +++ b/examples/use_geolocation/src/main.rs @@ -0,0 +1,47 @@ +use leptos::*; +use leptos_use::docs::demo_or_body; +use leptos_use::{use_geolocation, UseGeolocationReturn}; + +#[component] +fn Demo() -> impl IntoView { + let UseGeolocationReturn { + coords, + located_at, + error, + resume, + pause, + } = use_geolocation(); + + view! { + 
+    coords: {move || if let Some(coords) = coords() {
+                        format!(r#"{{
+        accuracy: {},
+        latitude: {},
+        longitude: {},
+        altitude: {:?},
+        altitude_accuracy: {:?},
+        heading: {:?},
+        speed: {:?},
+    }}"#, coords.accuracy(), coords.latitude(), coords.longitude(), coords.altitude(), coords.altitude_accuracy(), coords.heading(), coords.speed())
+                    } else {
+                        "None".to_string()
+                    }},
+    located_at: {located_at},
+    error: {move || if let Some(error) = error() {
+        error.message()
+    } else {"None".to_string()}},
+
+ + + } +} + +fn main() { + _ = console_log::init_with_level(log::Level::Debug); + console_error_panic_hook::set_once(); + + mount_to(demo_or_body(), || { + view! { } + }) +} diff --git a/examples/use_geolocation/style/output.css b/examples/use_geolocation/style/output.css new file mode 100644 index 0000000..ab5191f --- /dev/null +++ b/examples/use_geolocation/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)); + } +} \ No newline at end of file diff --git a/examples/use_geolocation/tailwind.config.js b/examples/use_geolocation/tailwind.config.js new file mode 100644 index 0000000..bc09f5e --- /dev/null +++ b/examples/use_geolocation/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'), + ], +} \ No newline at end of file diff --git a/src/lib.rs b/src/lib.rs index 52e54d7..aac6d68 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -25,6 +25,7 @@ mod is_none; mod is_ok; mod is_some; mod on_click_outside; +mod use_geolocation; mod signal_debounced; mod signal_throttled; mod use_active_element; @@ -68,6 +69,7 @@ pub use is_none::*; pub use is_ok::*; pub use is_some::*; pub use on_click_outside::*; +pub use use_geolocation::*; pub use signal_debounced::*; pub use signal_throttled::*; pub use use_active_element::*; diff --git a/src/use_geolocation.rs b/src/use_geolocation.rs new file mode 100644 index 0000000..8388f03 --- /dev/null +++ b/src/use_geolocation.rs @@ -0,0 +1,200 @@ +use default_struct_builder::DefaultBuilder; +use leptos::*; +use std::cell::Cell; +use std::rc::Rc; +use wasm_bindgen::prelude::*; + +/// Reactive [Geolocation API](https://developer.mozilla.org/en-US/docs/Web/API/Geolocation_API). +/// It allows the user to provide their location to web applications if they so desire. For privacy reasons, +/// the user is asked for permission to report location information. +/// +/// ## Demo +/// +/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_geolocation) +/// +/// ## Usage +/// +/// ``` +/// # use leptos::*; +/// # use leptos_use::{use_geolocation, UseGeolocationReturn}; +/// # +/// # #[component] +/// # fn Demo() -> impl IntoView { +/// let UseGeolocationReturn { +/// coords, +/// located_at, +/// error, +/// resume, +/// pause, +/// } = use_geolocation(); +/// # +/// # view! { } +/// # } +/// ``` +pub fn use_geolocation() -> UseGeolocationReturn { + use_geolocation_with_options(UseGeolocationOptions::default()) +} + +/// Version of [`use_geolocation`] that takes a `UseGeolocationOptions`. See [`use_geolocation`] for how to use. +pub fn use_geolocation_with_options( + options: UseGeolocationOptions, +) -> UseGeolocationReturn { + let (located_at, set_located_at) = create_signal(None::); + let (error, set_error) = create_signal(None::); + let (coords, set_coords) = create_signal(None::); + + let update_position = move |position: web_sys::Position| { + set_located_at.set(Some(position.timestamp())); + set_coords.set(Some(position.coords())); + set_error.set(None); + }; + + let on_error = move |err: web_sys::PositionError| { + set_error.set(Some(err)); + }; + + let watch_handle = Rc::new(Cell::new(None::)); + + let resume = { + let watch_handle = Rc::clone(&watch_handle); + let position_options = options.as_position_options(); + + move || { + let navigator = Some(window().navigator()); + if let Some(navigator) = navigator { + if let Ok(geolocation) = navigator.geolocation() { + let update_position = + Closure::wrap(Box::new(update_position) as Box); + let on_error = + Closure::wrap(Box::new(on_error) as Box); + + watch_handle.replace( + geolocation + .watch_position_with_error_callback_and_options( + update_position.as_ref().unchecked_ref(), + Some(on_error.as_ref().unchecked_ref()), + &position_options, + ) + .ok(), + ); + + update_position.forget(); + on_error.forget(); + } + } + } + }; + + if options.immediate { + resume(); + } + + let pause = { + let watch_handle = Rc::clone(&watch_handle); + + move || { + let navigator = Some(window().navigator()); + if let Some(navigator) = navigator { + if let Some(handle) = watch_handle.take() { + if let Ok(geolocation) = navigator.geolocation() { + geolocation.clear_watch(handle); + } + } + } + } + }; + + on_cleanup({ + let pause = pause.clone(); + + move || { + pause(); + } + }); + + UseGeolocationReturn { + coords: coords.into(), + located_at: located_at.into(), + error: error.into(), + resume, + pause, + } +} + +/// Options for [`use_geolocation_with_options`]. +#[derive(DefaultBuilder)] +pub struct UseGeolocationOptions { + /// If `true` the geolocation watch is started when this function is called. + /// If `false` you have to call `resume` manually to start it. Defaults to `true`. + immediate: bool, + + /// A boolean value that indicates the application would like to receive the best + /// possible results. If `true` and if the device is able to provide a more accurate + /// position, it will do so. Note that this can result in slower response times or + /// increased power consumption (with a GPS chip on a mobile device for example). + /// On the other hand, if `false`, the device can take the liberty to save + /// resources by responding more quickly and/or using less power. Default: `false`. + enable_high_accuracy: bool, + + /// A positive value indicating the maximum age in milliseconds of a possible cached position that is acceptable to return. + /// If set to `0`, it means that the device cannot use a cached position and must attempt to retrieve the real current position. + /// Default: 30000. + maximum_age: u32, + + /// A positive value representing the maximum length of time (in milliseconds) + /// the device is allowed to take in order to return a position. + /// The default value is 27000. + timeout: u32, +} + +impl Default for UseGeolocationOptions { + fn default() -> Self { + Self { + enable_high_accuracy: false, + maximum_age: 30000, + timeout: 27000, + immediate: true, + } + } +} + +impl UseGeolocationOptions { + fn as_position_options(&self) -> web_sys::PositionOptions { + let UseGeolocationOptions { + enable_high_accuracy, + maximum_age, + timeout, + .. + } = self; + + let mut options = web_sys::PositionOptions::new(); + options.enable_high_accuracy(*enable_high_accuracy); + options.maximum_age(*maximum_age); + options.timeout(*timeout); + + options + } +} + +/// Return type of [`use_geolocation`]. +pub struct UseGeolocationReturn +where + ResumeFn: Fn() + Clone, + PauseFn: Fn() + Clone, +{ + /// The coordinates of the current device like latitude and longitude. + /// See [`GeolocationCoordinates`](https://developer.mozilla.org/en-US/docs/Web/API/GeolocationCoordinates).. + pub coords: Signal>, + + /// The timestamp of the current coordinates. + pub located_at: Signal>, + + /// The last error received from `navigator.geolocation`. + pub error: Signal>, + + /// Resume the geolocation watch. + pub resume: ResumeFn, + + /// Pause the geolocation watch. + pub pause: PauseFn, +}