yew-hooks 0.6.3

Hooks for the Yew web framework, inspired by react hook libs like streamich/react-use and alibaba/hooks.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
use std::rc::Rc;

use gloo::timers::callback::Timeout;
use yew::prelude::*;

use super::{use_event, use_event_with_window, use_mut_latest};

/// Options for long press.
#[derive(Default)]
pub struct UseLongPressOptions {
    /// Callback for when long press starts.
    pub onstart: Option<Box<dyn FnMut(MouseEvent)>>,
    /// Callback for when long press ends.
    pub onend: Option<Box<dyn FnMut(MouseEvent)>>,
    /// Callback for when long press is completed (after threshold).
    pub onlongpress: Option<Box<dyn FnMut(MouseEvent)>>,
    /// Duration in milliseconds before long press is triggered.
    pub threshold: Option<u32>,
    /// Maximum movement in pixels allowed during press. If exceeded, long press won't trigger.
    pub move_threshold: Option<f64>,
    /// Whether to prevent default behavior on mouse/touch events.
    pub prevent_default: Option<bool>,
}

/// State handle for the [`use_long_press`] hook.
pub struct UseLongPressHandle {
    /// Whether the element is currently being pressed.
    pub pressing: UseStateHandle<bool>,
    /// Whether the long press threshold has been reached.
    pub long_pressed: UseStateHandle<bool>,
    /// Cancel the current long press timeout.
    cancel: Rc<dyn Fn()>,
}

impl UseLongPressHandle {
    /// Cancel the current long press timeout.
    pub fn cancel(&self) {
        (self.cancel)();
    }
}

impl Clone for UseLongPressHandle {
    fn clone(&self) -> Self {
        Self {
            pressing: self.pressing.clone(),
            long_pressed: self.long_pressed.clone(),
            cancel: self.cancel.clone(),
        }
    }
}

/// A hook that detects when a user presses and holds an element for a specified duration.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// # use log::debug;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(UseLongPress)]
/// fn long_press() -> Html {
///     let button = use_node_ref();
///
///     let long_press = use_long_press(button.clone(), 1000, move |e: MouseEvent| {
///         debug!("Long pressed for 1 second!");
///     });
///
///     let onmouseup = {
///         let long_press = long_press.clone();
///         Callback::from(move |_| {
///             long_press.cancel();
///         })
///     };
///
///     html! {
///         <>
///             <button
///                 ref={button}
///                 onmouseup={onmouseup}
///             >
///                 { "Press and hold me for 1 second" }
///             </button>
///             <p>
///                 { if *long_press.pressing { "Pressing..." } else { "Not pressing" } }
///             </p>
///             <p>
///                 { if *long_press.long_pressed { "Long pressed!" } else { "Not long pressed yet" } }
///             </p>
///         </>
///     }
/// }
/// ```
#[hook]
pub fn use_long_press<F>(node: NodeRef, threshold: u32, onlongpress: F) -> UseLongPressHandle
where
    F: FnMut(MouseEvent) + 'static,
{
    let options = UseLongPressOptions {
        threshold: Some(threshold),
        onlongpress: Some(Box::new(onlongpress)),
        ..Default::default()
    };

    use_long_press_with_options(node, options)
}

/// A hook that detects when a user presses and holds an element for a specified duration with options.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// # use log::debug;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(UseLongPressWithOptions)]
/// fn long_press_with_options() -> Html {
///     let button = use_node_ref();
///
///     let long_press = use_long_press_with_options(
///         button.clone(),
///         UseLongPressOptions {
///             threshold: Some(1000),
///             move_threshold: None,
///             onstart: Some(Box::new(|e: MouseEvent| {
///                 debug!("Press started");
///             })),
///             onend: Some(Box::new(|e: MouseEvent| {
///                 debug!("Press ended");
///             })),
///             onlongpress: Some(Box::new(|e: MouseEvent| {
///                 debug!("Long pressed!");
///             })),
///             prevent_default: Some(true),
///         }
///     );
///
///     html! {
///         <>
///             <button ref={button}>
///                 { "Press and hold me" }
///             </button>
///             <p>
///                 { if *long_press.pressing { "Pressing..." } else { "Not pressing" } }
///             </p>
///         </>
///     }
/// }
/// ```
#[hook]
pub fn use_long_press_with_options(
    node: NodeRef,
    options: UseLongPressOptions,
) -> UseLongPressHandle {
    let pressing = use_state(|| false);
    let long_pressed = use_state(|| false);
    let timeout_ref = use_mut_ref(|| None::<Timeout>);

    let onstart_ref = use_mut_latest(options.onstart);
    let onend_ref = use_mut_latest(options.onend);
    let onlongpress_ref = use_mut_latest(options.onlongpress);
    let threshold = options.threshold.unwrap_or(500);
    let move_threshold = options.move_threshold;
    let prevent_default = options.prevent_default.unwrap_or(true);

    let start_coords = use_mut_ref(|| (0.0, 0.0));

    let cancel = {
        let timeout_ref = timeout_ref.clone();
        let pressing = pressing.clone();
        let long_pressed = long_pressed.clone();
        // onend_ref is used in the closure below

        Rc::new(move || {
            // Clear any existing timeout
            *timeout_ref.borrow_mut() = None;

            // Reset states
            if *pressing {
                pressing.set(false);
            }
            if *long_pressed {
                long_pressed.set(false);
            }
        })
    };

    // Handle mousedown/touchstart
    {
        let pressing = pressing.clone();
        let long_pressed = long_pressed.clone();
        let timeout_ref = timeout_ref.clone();
        let onstart_ref = onstart_ref.clone();
        let onlongpress_ref = onlongpress_ref.clone();
        // cancel is used in the closure below

        let start_coords_clone = start_coords.clone();
        use_event(node.clone(), "mousedown", move |e: MouseEvent| {
            if prevent_default {
                e.prevent_default();
            }

            // Reset states
            pressing.set(true);
            long_pressed.set(false);

            // Store starting coordinates for move threshold check
            #[allow(clippy::unnecessary_cast)]
            {
                *start_coords_clone.borrow_mut() = (e.client_x() as f64, e.client_y() as f64);
            }

            // Call onstart callback
            let onstart_ref = onstart_ref.current();
            let onstart = &mut *onstart_ref.borrow_mut();
            if let Some(onstart) = onstart {
                onstart(e.clone());
            }

            // Clear any existing timeout
            *timeout_ref.borrow_mut() = None;

            // Set new timeout for long press
            let e_clone = e.clone();
            let long_pressed_clone = long_pressed.clone();
            let onlongpress_ref_clone = onlongpress_ref.clone();
            let start_coords_clone2 = start_coords_clone.clone();
            let move_threshold = move_threshold;
            let timeout = Timeout::new(threshold, move || {
                // Check if movement exceeded threshold
                if let Some(move_threshold) = move_threshold {
                    let (start_x, start_y) = *start_coords_clone2.borrow();
                    #[allow(clippy::unnecessary_cast)]
                    let current_x = e_clone.client_x() as f64;
                    #[allow(clippy::unnecessary_cast)]
                    let current_y = e_clone.client_y() as f64;
                    let distance =
                        ((current_x - start_x).powi(2) + (current_y - start_y).powi(2)).sqrt();

                    if distance > move_threshold {
                        return; // Don't trigger long press if moved too far
                    }
                }

                long_pressed_clone.set(true);

                // Call onlongpress callback
                let onlongpress_ref = onlongpress_ref_clone.current();
                let onlongpress = &mut *onlongpress_ref.borrow_mut();
                if let Some(onlongpress) = onlongpress {
                    onlongpress(e_clone);
                }
            });

            *timeout_ref.borrow_mut() = Some(timeout);
        });
    }

    // Handle touchstart for mobile
    {
        let pressing = pressing.clone();
        let long_pressed = long_pressed.clone();
        let timeout_ref = timeout_ref.clone();
        let onstart_ref = onstart_ref.clone();
        let onlongpress_ref = onlongpress_ref.clone();
        // cancel is used in the closure below

        let start_coords_clone3 = start_coords.clone();
        use_event(node.clone(), "touchstart", move |e: TouchEvent| {
            if prevent_default {
                e.prevent_default();
            }

            // Convert TouchEvent to MouseEvent for consistency
            let mouse_event = MouseEvent::new("mousedown").unwrap();

            // Reset states
            pressing.set(true);
            long_pressed.set(false);

            // Store starting coordinates for move threshold check
            if let Some(touch) = e.touches().get(0) {
                *start_coords_clone3.borrow_mut() =
                    (touch.client_x() as f64, touch.client_y() as f64);
            }

            // Call onstart callback
            let onstart_ref = onstart_ref.current();
            let onstart = &mut *onstart_ref.borrow_mut();
            if let Some(onstart) = onstart {
                onstart(mouse_event.clone());
            }

            // Clear any existing timeout
            *timeout_ref.borrow_mut() = None;

            // Set new timeout for long press
            let mouse_event_clone = mouse_event.clone();
            let long_pressed_clone = long_pressed.clone();
            let onlongpress_ref_clone = onlongpress_ref.clone();
            let start_coords_clone4 = start_coords_clone3.clone();
            let move_threshold = move_threshold;
            let timeout = Timeout::new(threshold, move || {
                // Check if movement exceeded threshold
                if let Some(move_threshold) = move_threshold {
                    let (start_x, start_y) = *start_coords_clone4.borrow();
                    // Get current touch position
                    let current_x = e
                        .changed_touches()
                        .get(0)
                        .map_or(start_x, |t| t.client_x() as f64);
                    let current_y = e
                        .changed_touches()
                        .get(0)
                        .map_or(start_y, |t| t.client_y() as f64);
                    let distance =
                        ((current_x - start_x).powi(2) + (current_y - start_y).powi(2)).sqrt();

                    if distance > move_threshold {
                        return; // Don't trigger long press if moved too far
                    }
                }

                long_pressed_clone.set(true);

                // Call onlongpress callback
                let onlongpress_ref = onlongpress_ref_clone.current();
                let onlongpress = &mut *onlongpress_ref.borrow_mut();
                if let Some(onlongpress) = onlongpress {
                    onlongpress(mouse_event_clone);
                }
            });

            *timeout_ref.borrow_mut() = Some(timeout);
        });
    }

    // Handle mouseup/touchend
    {
        let pressing = pressing.clone();
        let long_pressed = long_pressed.clone();
        let timeout_ref = timeout_ref.clone();
        let onend_ref = onend_ref.clone();
        // cancel is used in the closure below

        let pressing_clone = pressing.clone();
        let timeout_ref_clone = timeout_ref.clone();
        let long_pressed_clone = long_pressed.clone();
        let start_coords_clone5 = start_coords.clone();
        use_event_with_window("mousemove", move |e: MouseEvent| {
            if *pressing_clone && move_threshold.is_some() {
                let (start_x, start_y) = *start_coords_clone5.borrow();
                #[allow(clippy::unnecessary_cast)]
                let current_x = e.client_x() as f64;
                #[allow(clippy::unnecessary_cast)]
                let current_y = e.client_y() as f64;
                let distance =
                    ((current_x - start_x).powi(2) + (current_y - start_y).powi(2)).sqrt();

                if let Some(move_threshold) = move_threshold {
                    if distance > move_threshold {
                        // Cancel the long press if movement exceeds threshold
                        *timeout_ref_clone.borrow_mut() = None;
                        pressing_clone.set(false);
                        long_pressed_clone.set(false);
                    }
                }
            }
        });

        let pressing_clone2 = pressing.clone();
        let long_pressed_clone2 = long_pressed.clone();
        let timeout_ref_clone2 = timeout_ref.clone();
        let onend_ref_clone = onend_ref.clone();
        use_event_with_window("mouseup", move |e: MouseEvent| {
            if *pressing_clone2 {
                // Clear timeout
                *timeout_ref_clone2.borrow_mut() = None;

                // Update states
                pressing_clone2.set(false);

                // Call onend callback if not long pressed
                if !*long_pressed_clone2 {
                    let onend_ref = onend_ref_clone.current();
                    let onend = &mut *onend_ref.borrow_mut();
                    if let Some(onend) = onend {
                        onend(e);
                    }
                }

                // Reset long pressed state
                long_pressed_clone2.set(false);
            }
        });
    }

    // Handle touchend for mobile
    {
        let pressing = pressing.clone();
        let long_pressed = long_pressed.clone();
        let timeout_ref = timeout_ref.clone();
        let onend_ref = onend_ref.clone();
        // cancel is used in the closure below

        let pressing_clone3 = pressing.clone();
        let timeout_ref_clone3 = timeout_ref.clone();
        let long_pressed_clone3 = long_pressed.clone();
        let start_coords_clone6 = start_coords.clone();
        use_event_with_window("touchmove", move |e: TouchEvent| {
            if *pressing_clone3 && move_threshold.is_some() {
                let (start_x, start_y) = *start_coords_clone6.borrow();
                if let Some(touch) = e.touches().get(0) {
                    let current_x = touch.client_x() as f64;
                    let current_y = touch.client_y() as f64;
                    let distance =
                        ((current_x - start_x).powi(2) + (current_y - start_y).powi(2)).sqrt();

                    if let Some(move_threshold) = move_threshold {
                        if distance > move_threshold {
                            // Cancel the long press if movement exceeds threshold
                            *timeout_ref_clone3.borrow_mut() = None;
                            pressing_clone3.set(false);
                            long_pressed_clone3.set(false);
                        }
                    }
                }
            }
        });

        let pressing_clone4 = pressing.clone();
        let long_pressed_clone4 = long_pressed.clone();
        let timeout_ref_clone4 = timeout_ref.clone();
        let onend_ref_clone2 = onend_ref.clone();
        use_event_with_window("touchend", move |_e: TouchEvent| {
            if *pressing_clone4 {
                // Convert TouchEvent to MouseEvent for consistency
                let mouse_event = MouseEvent::new("mouseup").unwrap();

                // Clear timeout
                *timeout_ref_clone4.borrow_mut() = None;

                // Update states
                pressing_clone4.set(false);

                // Call onend callback if not long pressed
                if !*long_pressed_clone4 {
                    let onend_ref = onend_ref_clone2.current();
                    let onend = &mut *onend_ref.borrow_mut();
                    if let Some(onend) = onend {
                        onend(mouse_event);
                    }
                }

                // Reset long pressed state
                long_pressed_clone4.set(false);
            }
        });
    }

    // Handle mouseleave/touchcancel
    {
        let cancel = cancel.clone();

        use_event(node.clone(), "mouseleave", move |_: MouseEvent| {
            cancel();
        });
    }

    {
        let cancel = cancel.clone();

        use_event(node.clone(), "touchcancel", move |_: TouchEvent| {
            cancel();
        });
    }

    // Cleanup on unmount
    {
        let cancel = cancel.clone();
        use_effect_with((), move |_| {
            move || {
                cancel();
            }
        });
    }

    UseLongPressHandle {
        pressing,
        long_pressed,
        cancel,
    }
}