adam/leptos-use
1
0
Fork 0
mirror of https://github.com/adoyle0/leptos-use.git synced 2025-01-22 16:49:22 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

added use_mouse

Browse source
This commit is contained in:
Maccesch 2023-06-02 13:38:01 +01:00
parent 849e7503ab
commit 469aa4b31e
22 changed files with 788 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.idea/leptos-use.iml generated
View file

@ -14,6 +14,7 @@
<sourceFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/examples/use_scroll/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/examples/use_resize_observer/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/examples/use_mouse/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" />
@ -24,6 +25,7 @@
<excludeFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/target" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_scroll/target" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_resize_observer/target" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_mouse/target" />
</content>
<orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" />

4
CHANGELOG.md
View file

@ -6,6 +6,10 @@
- `use_supported`
- `use_resize_observer`
- `watch`
- `use_mouse`
#### Other Changes
- Use the crate `default-struct-builder` to provide ergonimic function options.
## 0.1.3

24
Cargo.toml
View file

@ -1,6 +1,6 @@
[package]
name = "leptos-use"
version = "0.1.3"
version = "0.1.4"
edition = "2021"
authors = ["Marc-Stefan Cassola"]
categories = ["gui", "web-programming"]
@ -16,21 +16,25 @@ repository = "https://github.com/Synphonyte/leptos-use"
leptos = "0.3.0"
wasm-bindgen = "0.2.86"
js-sys = "0.3.63"
default-struct-builder = "0.1.0"
default-struct-builder = "0.2.0"
[dependencies.web-sys]
version = "0.3.63"
features = [
"ScrollToOptions",
"ScrollBehavior",
"CssStyleDeclaration",
"ResizeObserver",
"ResizeObserverOptions",
"ResizeObserverBoxOptions",
"ResizeObserverSize",
"ResizeObserverEntry",
"Navigator",
"DomRectReadOnly",
"MouseEvent",
"Navigator",
"ResizeObserver",
"ResizeObserverBoxOptions",
"ResizeObserverEntry",
"ResizeObserverOptions",
"ResizeObserverSize",
"ScrollBehavior",
"ScrollToOptions",
"Touch",
"TouchEvent",
"TouchList",
]
[features]

1
docs/book/src/SUMMARY.md
View file

@ -18,6 +18,7 @@
# Sensors
- [use_mouse](sensors/use_mouse.md)
- [use_scroll](sensors/use_scroll.md)
# Watch

8
docs/book/src/getting_started/get_started.md
View file

@ -15,15 +15,15 @@ cargo add leptos-use
Simply import the functions you need from `leptos-use`
```rust,noplayground
# use leptos::*;
use leptos_use::use_mouse::*;
use leptos::*;
use leptos_use::{use_mouse, UseMouseReturn};
#[component]
pub fn Demo(cx: Scope) -> into ImplView {
fn Demo(cx: Scope) -> impl IntoView {
let UseMouseReturn { x, y, .. } = use_mouse(cx);
view! { cx,
{x} "x" {y}
{x} " x " {y}
}
}
```

3
docs/book/src/sensors/use_mouse.md Normal file
View file

@ -0,0 +1,3 @@
# use_mouse
<!-- cmdrun python3 ../extract_doc_comment.py use_mouse -->

2
examples/use_event_listener/src/main.rs
View file

@ -1,8 +1,6 @@
use leptos::ev::{click, keydown};
use leptos::html::AnyElement;
use leptos::*;
use leptos_use::use_event_listener;
use web_sys::HtmlDivElement;
#[component]
fn Demo(cx: Scope) -> impl IntoView {

16
examples/use_mouse/Cargo.toml Normal file
View file

@ -0,0 +1,16 @@
[package]
name = "use_mouse"
version = "0.1.0"
edition = "2021"
[dependencies]
leptos = "0.3"
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"

23
examples/use_mouse/README.md Normal file
View file

@ -0,0 +1,23 @@
A simple example for `use_mouse`.
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
```

2
examples/use_mouse/Trunk.toml Normal file
View file

@ -0,0 +1,2 @@
[build]
public_url = "/demo/"

7
examples/use_mouse/index.html Normal file
View file

@ -0,0 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<link data-trunk rel="css" href="style/output.css">
</head>
<body></body>
</html>

3
examples/use_mouse/input.css Normal file
View file

@ -0,0 +1,3 @@
@tailwind base;
@tailwind components;
@tailwind utilities;

2
examples/use_mouse/rust-toolchain.toml Normal file
View file

@ -0,0 +1,2 @@
[toolchain]
channel = "nightly"

64
examples/use_mouse/src/main.rs Normal file
View file

@ -0,0 +1,64 @@
use leptos::*;
use leptos_use::docs::{demo_or_body, Note};
use leptos_use::{
use_mouse, use_mouse_with_options, UseMouseCoordType, UseMouseEventExtractor, UseMouseOptions,
};
use web_sys::{MouseEvent, Touch};
#[derive(Clone)]
struct Extractor;
impl UseMouseEventExtractor for Extractor {
fn extract_mouse_coords(&self, event: &MouseEvent) -> Option<(f64, f64)> {
Some((event.offset_x() as f64, event.offset_y() as f64))
}
// this is not necessary as it's the same as the default implementation of the trait.
fn extract_touch_coords(&self, _touch: &Touch) -> Option<(f64, f64)> {
// ignore touch events
None
}
}
#[component]
fn Demo(cx: Scope) -> impl IntoView {
let el = create_node_ref(cx);
let mouse_default = use_mouse(cx);
let mouse_with_extractor = use_mouse_with_options(
cx,
UseMouseOptions::default()
.target(el)
.coord_type(UseMouseCoordType::Custom(Extractor)),
);
view! { cx,
<div node_ref=el>
<p class="font-semibold">"Basic Usage"</p>
<pre lang="yaml">
{ move || format!(r#" x: {}
y: {}
source_type: {:?}
"#, mouse_default.x.get(), mouse_default.y.get(), mouse_default.source_type.get()) }
</pre>
<p class="font-semibold">"Extractor Usage"</p>
<Note>"Only works when the mouse is over the demo element"</Note>
<pre lang="yaml">
{ move || format!(r#" x: {}
y: {}
source_type: {:?}
"#, mouse_with_extractor.x.get(), mouse_with_extractor.y.get(), mouse_with_extractor.source_type.get()) }
</pre>
</div>
}
}
fn main() {
_ = console_log::init_with_level(log::Level::Debug);
console_error_panic_hook::set_once();
mount_to(demo_or_body(), |cx| {
view! { cx, <Demo /> }
})
}

289
examples/use_mouse/style/output.css Normal file
View file

@ -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: ;
}
.font-semibold {
font-weight: 600;
}
.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));
}
}

15
examples/use_mouse/tailwind.config.js Normal file
View file

@ -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'),
],
}

6
examples/use_resize_observer/src/main.rs
View file

@ -1,13 +1,13 @@
use leptos::*;
use leptos_use::docs::{demo_or_body, BooleanDisplay, Note};
use leptos_use::{use_resize_observer, UseResizeReturn};
use leptos_use::docs::{demo_or_body, Note};
use leptos_use::use_resize_observer;
#[component]
fn Demo(cx: Scope) -> impl IntoView {
let el = create_node_ref(cx);
let (text, set_text) = create_signal(cx, "".to_string());
use_resize_observer(cx, el, move |entries, observer| {
use_resize_observer(cx, el, move |entries, _| {
let rect = entries[0].content_rect();
set_text(format!(
"width: {:.0}\nheight: {:.0}",

2
src/core/mod.rs
View file

@ -1,3 +1,5 @@
mod event_target_maybe_signal;
mod position;
pub use event_target_maybe_signal::*;
pub use position::*;

5
src/core/position.rs Normal file
View file

@ -0,0 +1,5 @@
#[derive(Copy, Clone)]
pub struct Position {
pub x: f64,
pub y: f64,
}

2
src/lib.rs
View file

@ -5,6 +5,7 @@ pub mod core;
pub mod docs;
mod use_debounce_fn;
mod use_event_listener;
mod use_mouse;
#[cfg(web_sys_unstable_apis)]
mod use_resize_observer;
mod use_scroll;
@ -15,6 +16,7 @@ mod watch;
pub use use_debounce_fn::*;
pub use use_event_listener::*;
pub use use_mouse::*;
#[cfg(web_sys_unstable_apis)]
pub use use_resize_observer::*;
pub use use_scroll::*;

322
src/use_mouse.rs Normal file
View file

@ -0,0 +1,322 @@
use crate::core::{ElementMaybeSignal, Position};
use crate::use_event_listener_with_options;
use default_struct_builder::DefaultBuilder;
use leptos::ev::{dragover, mousemove, touchend, touchmove, touchstart};
use leptos::*;
use std::marker::PhantomData;
use wasm_bindgen::{JsCast, JsValue};
use web_sys::AddEventListenerOptions;
/// Reactive mouse position
///
/// ## Demo
///
/// [Link to Demo](https://github.com/Synphonyte/leptos-use/tree/main/examples/use_mouse)
///
/// ## Basic Usage
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_mouse, UseMouseReturn};
/// #
/// # #[component]
/// # fn Demo(cx: Scope) -> impl IntoView {
/// let UseMouseReturn {
/// x, y, source_type, ..
/// } = use_mouse(cx);
/// # view! { cx, }
/// # }
/// ```
///
/// Touch is enabled by default. To only detect mouse changes, set `touch` to `false`.
/// The `dragover` event is used to track mouse position while dragging.
///
/// ```
/// # use leptos::*;
/// # use leptos_use::{use_mouse_with_options, UseMouseOptions, UseMouseReturn};
/// #
/// # #[component]
/// # fn Demo(cx: Scope) -> impl IntoView {
/// let UseMouseReturn {
/// x, y, ..
/// } = use_mouse_with_options(
/// cx,
/// UseMouseOptions::default().touch(false)
/// );
/// # view! { cx, }
/// # }
/// ```
///
/// ## Custom Extractor
///
/// It's also possible to provide a custom extractor to get the position from the events.
///
/// ```
/// # use leptos::*;
/// use web_sys::MouseEvent;
/// use leptos_use::{use_mouse_with_options, UseMouseOptions, UseMouseReturn, UseMouseEventExtractor, UseMouseCoordType};
///
/// #[derive(Clone)]
/// struct MyExtractor;
///
/// impl UseMouseEventExtractor for MyExtractor {
/// fn extract_mouse_coords(&self, event: &MouseEvent) -> Option<(f64, f64)> {
/// Some((event.offset_x() as f64, event.offset_y() as f64))
/// }
///
/// // don't implement fn extract_touch_coords to ignore touch events
/// }
///
/// #[component]
/// fn Demo(cx: Scope) -> impl IntoView {
/// let element = create_node_ref(cx);
///
/// let UseMouseReturn {
/// x, y, source_type, ..
/// } = use_mouse_with_options(
/// cx,
/// UseMouseOptions::default()
/// .target(element)
/// .coord_type(UseMouseCoordType::Custom(MyExtractor))
/// );
/// view! { cx, <div node_ref=element></div> }
/// }
/// ```
pub fn use_mouse(cx: Scope) -> UseMouseReturn {
use_mouse_with_options(cx, Default::default())
}
/// Variant of [`use_mouse`] that accepts options. Please see [`use_mouse`] for how to use.
pub fn use_mouse_with_options<El, T, Ex>(
cx: Scope,
options: UseMouseOptions<El, T, Ex>,
) -> UseMouseReturn
where
El: Clone,
(Scope, El): Into<ElementMaybeSignal<T, web_sys::EventTarget>>,
T: Into<web_sys::EventTarget> + Clone + 'static,
Ex: UseMouseEventExtractor + Clone + 'static,
{
let (x, set_x) = create_signal(cx, options.initial_value.x);
let (y, set_y) = create_signal(cx, options.initial_value.y);
let (source_type, set_source_type) = create_signal(cx, UseMouseSourceType::Unset);
let coord_type = options.coord_type.clone();
let mouse_handler = move |event: web_sys::MouseEvent| {
let result = coord_type.extract_mouse_coords(&event);
if let Some((x, y)) = result {
set_x(x);
set_y(y);
set_source_type(UseMouseSourceType::Mouse);
}
};
let handler = mouse_handler.clone();
let drag_handler = move |event: web_sys::DragEvent| {
let js_value: &JsValue = event.as_ref();
handler(js_value.clone().unchecked_into::<web_sys::MouseEvent>());
};
let coord_type = options.coord_type.clone();
let touch_handler = move |event: web_sys::TouchEvent| {
let touches = event.touches();
if touches.length() > 0 {
let result = coord_type.extract_touch_coords(
&touches
.get(0)
.expect("Just checked that there's at least on touch"),
);
if let Some((x, y)) = result {
set_x(x);
set_y(y);
set_source_type(UseMouseSourceType::Touch);
}
}
};
let initial_value = options.initial_value;
let reset = move || {
set_x(initial_value.x);
set_y(initial_value.y);
};
// TODO : event filters?
let target = options.target;
let mut event_listener_options = AddEventListenerOptions::new();
event_listener_options.passive(true);
let _ = use_event_listener_with_options(
cx,
target.clone(),
mousemove,
mouse_handler,
event_listener_options.clone(),
);
let _ = use_event_listener_with_options(
cx,
target.clone(),
dragover,
drag_handler,
event_listener_options.clone(),
);
if options.touch && !matches!(options.coord_type, UseMouseCoordType::Movement) {
let _ = use_event_listener_with_options(
cx,
target.clone(),
touchstart,
touch_handler.clone(),
event_listener_options.clone(),
);
let _ = use_event_listener_with_options(
cx,
target.clone(),
touchmove,
touch_handler.clone(),
event_listener_options.clone(),
);
if options.reset_on_touch_ends {
let _ = use_event_listener_with_options(
cx,
target,
touchend,
move |_| reset(),
event_listener_options.clone(),
);
}
}
UseMouseReturn {
x,
y,
set_x,
set_y,
source_type,
}
}
#[derive(DefaultBuilder)]
pub struct UseMouseOptions<El, T, Ex>
where
El: Clone,
(Scope, El): Into<ElementMaybeSignal<T, web_sys::EventTarget>>,
T: Into<web_sys::EventTarget> + Clone + 'static,
Ex: UseMouseEventExtractor + Clone,
{
/// How to extract the x, y coordinates from mouse events or touches
coord_type: UseMouseCoordType<Ex>,
/// Listen events on `target` element. Defaults to `window`
target: El,
/// Listen to `touchmove` events. Defaults to `true`.
touch: bool,
/// Reset to initial value when `touchend` event fired. Defaults to `false`
reset_on_touch_ends: bool,
/// Initial values. Defaults to `{x: 0.0, y: 0.0}`.
initial_value: Position,
#[builder(skip)]
_marker: PhantomData<T>,
}
impl Default for UseMouseOptions<web_sys::Window, web_sys::Window, UseMouseEventExtractorDefault> {
fn default() -> Self {
Self {
coord_type: UseMouseCoordType::<UseMouseEventExtractorDefault>::default(),
target: window(),
touch: true,
reset_on_touch_ends: false,
initial_value: Position { x: 0.0, y: 0.0 },
_marker: Default::default(),
}
}
}
/// Defines how to get the coordinates from the event.
#[derive(Clone)]
pub enum UseMouseCoordType<E: UseMouseEventExtractor + Clone> {
Page,
Client,
Screen,
Movement,
Custom(E),
}
impl Default for UseMouseCoordType<UseMouseEventExtractorDefault> {
fn default() -> Self {
Self::Page
}
}
/// Trait to implement if you want to specify a custom extractor
#[allow(unused_variables)]
pub trait UseMouseEventExtractor {
/// Return the coordinates from mouse events (`Some(x, y)`) or `None`
fn extract_mouse_coords(&self, event: &web_sys::MouseEvent) -> Option<(f64, f64)> {
None
}
/// Return the coordinates from touches (`Some(x, y)`) or `None`
fn extract_touch_coords(&self, touch: &web_sys::Touch) -> Option<(f64, f64)> {
None
}
}
impl<E: UseMouseEventExtractor + Clone> UseMouseEventExtractor for UseMouseCoordType<E> {
fn extract_mouse_coords(&self, event: &web_sys::MouseEvent) -> Option<(f64, f64)> {
match self {
UseMouseCoordType::Page => Some((event.page_x() as f64, event.page_y() as f64)),
UseMouseCoordType::Client => Some((event.client_x() as f64, event.client_y() as f64)),
UseMouseCoordType::Screen => Some((event.screen_x() as f64, event.client_y() as f64)),
UseMouseCoordType::Movement => {
Some((event.movement_x() as f64, event.movement_y() as f64))
}
UseMouseCoordType::Custom(ref extractor) => extractor.extract_mouse_coords(event),
}
}
fn extract_touch_coords(&self, touch: &web_sys::Touch) -> Option<(f64, f64)> {
match self {
UseMouseCoordType::Page => Some((touch.page_x() as f64, touch.page_y() as f64)),
UseMouseCoordType::Client => Some((touch.client_x() as f64, touch.client_y() as f64)),
UseMouseCoordType::Screen => Some((touch.screen_x() as f64, touch.client_y() as f64)),
UseMouseCoordType::Movement => None,
UseMouseCoordType::Custom(ref extractor) => extractor.extract_touch_coords(touch),
}
}
}
#[derive(Clone)]
pub struct UseMouseEventExtractorDefault;
impl UseMouseEventExtractor for UseMouseEventExtractorDefault {}
/// Return type of [`use_mouse`].
pub struct UseMouseReturn {
/// X coordinate of the mouse pointer / touch
pub x: ReadSignal<f64>,
/// Y coordinate of the mouse pointer / touch
pub y: ReadSignal<f64>,
/// Sets the value of `x`. This does not actually move the mouse cursor.
pub set_x: WriteSignal<f64>,
/// Sets the value of `y`. This does not actually move the mouse cursor.
pub set_y: WriteSignal<f64>,
/// Identifies the source of the reported coordinates
pub source_type: ReadSignal<UseMouseSourceType>,
}
/// Identifies the source of the reported coordinates
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum UseMouseSourceType {
/// coordinates come from mouse movement
Mouse,
/// coordinates come from touch
Touch,
/// Initially before any event has been recorded the source type is unset
Unset,
}

10
src/use_resize_observer.rs
View file

@ -42,7 +42,7 @@ pub fn use_resize_observer<El, T, F>(
cx: Scope,
target: El, // TODO : multiple elements?
callback: F,
) -> UseResizeReturn
) -> UseResizeObserverReturn
where
(Scope, El): Into<ElementMaybeSignal<T, web_sys::Element>>,
T: Into<web_sys::Element> + Clone + 'static,
@ -57,7 +57,7 @@ pub fn use_resize_observer_with_options<El, T, F>(
target: El, // TODO : multiple elements?
callback: F,
options: web_sys::ResizeObserverOptions,
) -> UseResizeReturn
) -> UseResizeObserverReturn
where
(Scope, El): Into<ElementMaybeSignal<T, web_sys::Element>>,
T: Into<web_sys::Element> + Clone + 'static,
@ -122,14 +122,14 @@ where
on_cleanup(cx, stop.clone());
return UseResizeReturn {
UseResizeObserverReturn {
is_supported,
stop: Box::new(stop),
};
}
}
/// The return value of [`use_resize_observer`].
pub struct UseResizeReturn {
pub struct UseResizeObserverReturn {
/// Whether the browser supports the ResizeObserver API
pub is_supported: Signal<bool>,
/// A function to stop and detach the ResizeObserver