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
use std::cmp::max;
use std::rc::Rc;
use yew::prelude::*;
use super::{use_event, use_mut_latest};
/// Swipe direction.
#[derive(PartialEq, Eq, Clone, Debug)]
pub enum UseSwipeDirection {
Up,
Right,
Down,
Left,
None,
}
/// Options for swipe.
#[derive(Default)]
pub struct UseSwipeOptions {
pub threshold: Option<u32>,
pub onswipestart: Option<Box<dyn FnMut(TouchEvent)>>,
pub onswipe: Option<Box<dyn FnMut(TouchEvent)>>,
pub onswipeend: Option<Box<dyn FnMut(TouchEvent, UseSwipeDirection)>>,
}
/// State handle for the [`use_swipe`] hook.
pub struct UseSwipeHandle {
pub swiping: UseStateHandle<bool>,
pub direction: UseStateHandle<UseSwipeDirection>,
pub coords_start: UseStateHandle<(i32, i32)>,
pub coords_end: UseStateHandle<(i32, i32)>,
pub length_x: UseStateHandle<i32>,
pub length_y: UseStateHandle<i32>,
}
impl Clone for UseSwipeHandle {
fn clone(&self) -> Self {
Self {
swiping: self.swiping.clone(),
direction: self.direction.clone(),
coords_start: self.coords_start.clone(),
coords_end: self.coords_end.clone(),
length_x: self.length_x.clone(),
length_y: self.length_y.clone(),
}
}
}
/// A sensor hook that detects swipe based on TouchEvent.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(UseSwipe)]
/// fn swipe() -> Html {
/// let node = use_node_ref();
/// let state = use_swipe(node.clone());
///
/// // You can depend on direction/swiping etc.
/// {
/// let state = state.clone();
/// use_effect_with_deps(move |direction| {
/// // Do something based on direction.
/// match **direction {
/// UseSwipeDirection::Left => (),
/// UseSwipeDirection::Right => (),
/// UseSwipeDirection::Up => (),
/// UseSwipeDirection::Down => (),
/// _ => (),
/// }
/// || ()
/// }, state.direction);
/// }
///
/// html! {
/// <div ref={node}>
/// <b>{ " swiping: " }</b>
/// { *state.swiping }
/// <b>{ " direction: " }</b>
/// { format!("{:?}", *state.direction) }
/// <b>{ " coords_start: " }</b>
/// { format!("{:?}", *state.coords_start) }
/// <b>{ " coords_end: " }</b>
/// { format!("{:?}", *state.coords_end) }
/// <b>{ " length_x: " }</b>
/// { *state.length_x }
/// <b>{ " length_y: " }</b>
/// { *state.length_y }
/// </div>
/// }
/// }
/// ```
#[hook]
pub fn use_swipe(node: NodeRef) -> UseSwipeHandle {
use_swipe_with_options(node, UseSwipeOptions::default())
}
/// A sensor hook that detects swipe based on TouchEvent for window.
/// See [`use_swipe`].
#[hook]
pub fn use_swipe_with_window() -> UseSwipeHandle {
use_swipe_with_options(NodeRef::default(), UseSwipeOptions::default())
}
/// A sensor hook that detects swipe based on TouchEvent with options.
/// If you want to detect for window, pass `NodeRef::default()` to param `node`.
///
/// # Example
///
/// ```rust
/// # use yew::prelude::*;
/// #
/// use yew_hooks::prelude::*;
///
/// #[function_component(UseSwipe)]
/// fn swipe() -> Html {
/// let node = use_node_ref();
/// let state = use_swipe_with_options(node.clone(), UseSwipeOptions {
/// onswipeend: Some(Box::new(move |_e, direction| {
/// // Deal with TouchEvent.
/// log::debug!("Swipe direction: {:?}", direction);
/// })),
/// ..Default::default()
/// });
///
/// html! {
/// <div ref={node}>
/// <b>{ " swiping: " }</b>
/// { *state.swiping }
/// <b>{ " direction: " }</b>
/// { format!("{:?}", *state.direction) }
/// <b>{ " coords_start: " }</b>
/// { format!("{:?}", *state.coords_start) }
/// <b>{ " coords_end: " }</b>
/// { format!("{:?}", *state.coords_end) }
/// <b>{ " length_x: " }</b>
/// { *state.length_x }
/// <b>{ " length_y: " }</b>
/// { *state.length_y }
/// </div>
/// }
/// }
/// ```
#[hook]
pub fn use_swipe_with_options(node: NodeRef, options: UseSwipeOptions) -> UseSwipeHandle {
let swiping = use_state_eq(|| false);
let direction = use_state_eq(|| UseSwipeDirection::None);
let coords_start = use_state(|| (0, 0));
let coords_end = use_state(|| (0, 0));
let length_x = use_state(|| 0);
let length_y = use_state(|| 0);
let threshold = options.threshold.unwrap_or(50);
let onswipestart = use_mut_latest(options.onswipestart);
let onswipe = use_mut_latest(options.onswipe);
let onswipeend = use_mut_latest(options.onswipeend);
let diff_x = {
let coords_start = coords_start.clone();
let coords_end = coords_end.clone();
#[allow(clippy::unnecessary_cast)]
Rc::new(move || (coords_start.0 - coords_end.0) as i32)
};
let diff_y = {
let coords_start = coords_start.clone();
let coords_end = coords_end.clone();
#[allow(clippy::unnecessary_cast)]
Rc::new(move || (coords_start.1 - coords_end.1) as i32)
};
let ontouchend = {
let swiping = swiping.clone();
let direction = direction.clone();
Rc::new(move |e: TouchEvent| {
if *swiping {
let onswipeend = onswipeend.current();
let onswipeend = &mut *onswipeend.borrow_mut();
if let Some(onswipeend) = onswipeend {
onswipeend(e, (*direction).clone());
}
}
swiping.set(false);
direction.set(UseSwipeDirection::None);
})
};
let threshold_exceeded = {
let diff_x = diff_x.clone();
let diff_y = diff_y.clone();
Rc::new(move || max(diff_x().abs(), diff_y().abs()) >= (threshold as i32))
};
{
let node = node.clone();
let coords_start = coords_start.clone();
let coords_end = coords_end.clone();
use_event(node, "touchstart", move |e: TouchEvent| {
let x = e.touches().get(0).map_or(0, |t| t.client_x());
let y = e.touches().get(0).map_or(0, |t| t.client_y());
coords_start.set((x, y));
coords_end.set((x, y));
let onswipestart = onswipestart.current();
let onswipestart = &mut *onswipestart.borrow_mut();
if let Some(onswipestart) = onswipestart {
onswipestart(e);
}
});
}
{
let node = node.clone();
let coords_end = coords_end.clone();
let swiping = swiping.clone();
let length_x = length_x.clone();
let length_y = length_y.clone();
let direction = direction.clone();
use_event(node, "touchmove", move |e: TouchEvent| {
let x = e.touches().get(0).map_or(0, |t| t.client_x());
let y = e.touches().get(0).map_or(0, |t| t.client_y());
coords_end.set((x, y));
length_x.set(diff_x());
length_y.set(diff_y());
if !*swiping && threshold_exceeded() {
swiping.set(true);
}
if !threshold_exceeded() {
direction.set(UseSwipeDirection::None);
} else if diff_x().abs() > diff_y().abs() {
if diff_x() > 0 {
direction.set(UseSwipeDirection::Left);
} else {
direction.set(UseSwipeDirection::Right);
}
} else if diff_y() > 0 {
direction.set(UseSwipeDirection::Up);
} else {
direction.set(UseSwipeDirection::Down);
}
if *swiping {
let onswipe = onswipe.current();
let onswipe = &mut *onswipe.borrow_mut();
if let Some(onswipe) = onswipe {
onswipe(e);
}
}
});
}
{
let node = node.clone();
let ontouchend = ontouchend.clone();
use_event(node, "touchend", move |e: TouchEvent| {
ontouchend(e);
});
}
{
let ontouchend = ontouchend.clone();
use_event(node, "touchcancel", move |e: TouchEvent| {
ontouchend(e);
});
}
UseSwipeHandle {
swiping,
direction,
coords_start,
coords_end,
length_x,
length_y,
}
}