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

changed options to default-struct-builder

Browse source
This commit is contained in:
Maccesch 2023-05-27 15:12:05 +01:00
parent 25499083ef
commit 201df27f3a
16 changed files with 255 additions and 53 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -12,6 +12,7 @@
<sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" /> <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/examples/use_throttle_fn/src" isTestSource="false" /> <sourceFolder url="file://$MODULE_DIR$/examples/use_throttle_fn/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/src" isTestSource="false" /> <sourceFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/src" isTestSource="false" />
<sourceFolder url="file://$MODULE_DIR$/examples/use_scroll/src" isTestSource="false" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" /> <excludeFolder url="file://$MODULE_DIR$/examples/use_event_listener/target" />
<excludeFolder url="file://$MODULE_DIR$/target" /> <excludeFolder url="file://$MODULE_DIR$/target" />
<excludeFolder url="file://$MODULE_DIR$/docs/book/book" /> <excludeFolder url="file://$MODULE_DIR$/docs/book/book" />
@ -20,6 +21,7 @@
<excludeFolder url="file://$MODULE_DIR$/examples/use_throttle_fn/target" /> <excludeFolder url="file://$MODULE_DIR$/examples/use_throttle_fn/target" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/dist" /> <excludeFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/dist" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/target" /> <excludeFolder url="file://$MODULE_DIR$/examples/use_debounce_fn/target" />
<excludeFolder url="file://$MODULE_DIR$/examples/use_scroll/target" />
</content> </content>
<orderEntry type="inheritedJdk" /> <orderEntry type="inheritedJdk" />
<orderEntry type="sourceFolder" forTests="false" /> <orderEntry type="sourceFolder" forTests="false" />

1
Cargo.toml
View file

@ -17,3 +17,4 @@ leptos = "0.3"
web-sys = { version = "0.3", features = ["ScrollToOptions", "ScrollBehavior", "CssStyleDeclaration"] } web-sys = { version = "0.3", features = ["ScrollToOptions", "ScrollBehavior", "CssStyleDeclaration"] }
wasm-bindgen = "0.2" wasm-bindgen = "0.2"
js-sys = "0.3" js-sys = "0.3"
default-struct-builder = "0.1"

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

@ -0,0 +1,16 @@
[package]
name = "use_scroll"
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 = "../.." }
web-sys = "0.3"
[dev-dependencies]
wasm-bindgen = "0.2"
wasm-bindgen-test = "0.3.0"

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

@ -0,0 +1,23 @@
A simple example for `use_scroll`.
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
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_scroll/Trunk.toml Normal file
View file

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

7
examples/use_scroll/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_scroll/input.css Normal file
View file

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

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

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

18
examples/use_scroll/src/main.rs Normal file
View file

@ -0,0 +1,18 @@
use leptos::*;
use leptos_use::utils::demo_or_body;
#[component]
fn Demo(cx: Scope) -> impl IntoView {
view! { cx,
}
}
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 /> }
})
}

93
examples/use_scroll/style/output.css Normal file
View file

@ -0,0 +1,93 @@
*, ::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-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-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:
}

13
examples/use_scroll/tailwind.config.js Normal file
View file

@ -0,0 +1,13 @@
/** @type {import('tailwindcss').Config} */
module.exports = {
content: {
files: ["*.html", "./src/**/*.rs"],
},
theme: {
extend: {},
},
corePlugins: {
preflight: false,
},
plugins: [],
}

19
src/use_debounce_fn.rs
View file

@ -47,9 +47,8 @@ use leptos::MaybeSignal;
/// // do something /// // do something
/// }, /// },
/// 1000.0, /// 1000.0,
/// DebounceOptions { /// DebounceOptions::default()
/// max_wait: Some(5000.0), /// .max_wait(Some(5000.0)),
/// }
/// ); /// );
/// ///
/// window_event_listener(resize, move |_| debounced_fn()); /// window_event_listener(resize, move |_| debounced_fn());
@ -69,18 +68,17 @@ pub fn use_debounce_fn<F>(func: F, ms: impl Into<MaybeSignal<f64>>) -> impl Fn()
where where
F: FnOnce() + Clone + 'static, F: FnOnce() + Clone + 'static,
{ {
use_debounce_fn_with_options(func, ms, DebounceOptions::<Option<f64>>::default()) use_debounce_fn_with_options(func, ms, DebounceOptions::default())
} }
/// Version of [`use_debounce_fn`] with debounce options. See the docs for [`use_debounce_fn`] for how to use. /// Version of [`use_debounce_fn`] with debounce options. See the docs for [`use_debounce_fn`] for how to use.
pub fn use_debounce_fn_with_options<F, W>( pub fn use_debounce_fn_with_options<F>(
func: F, func: F,
ms: impl Into<MaybeSignal<f64>>, ms: impl Into<MaybeSignal<f64>>,
options: DebounceOptions<W>, options: DebounceOptions,
) -> impl Fn() ) -> impl Fn()
where where
F: FnOnce() + Clone + 'static, F: FnOnce() + Clone + 'static,
W: Into<MaybeSignal<Option<f64>>>,
{ {
create_filter_wrapper(debounce_filter(ms, options), func) create_filter_wrapper(debounce_filter(ms, options), func)
} }
@ -94,19 +92,18 @@ where
F: FnOnce(Arg) + Clone + 'static, F: FnOnce(Arg) + Clone + 'static,
Arg: Clone + 'static, Arg: Clone + 'static,
{ {
use_debounce_fn_with_arg_and_options(func, ms, DebounceOptions::<Option<f64>>::default()) use_debounce_fn_with_arg_and_options(func, ms, DebounceOptions::default())
} }
/// Version of [`use_debounce_fn_with_arg`] with debounce options. /// Version of [`use_debounce_fn_with_arg`] with debounce options.
pub fn use_debounce_fn_with_arg_and_options<F, Arg, W>( pub fn use_debounce_fn_with_arg_and_options<F, Arg>(
func: F, func: F,
ms: impl Into<MaybeSignal<f64>>, ms: impl Into<MaybeSignal<f64>>,
options: DebounceOptions<W>, options: DebounceOptions,
) -> impl Fn(Arg) + Clone ) -> impl Fn(Arg) + Clone
where where
F: FnOnce(Arg) + Clone + 'static, F: FnOnce(Arg) + Clone + 'static,
Arg: Clone + 'static, Arg: Clone + 'static,
W: Into<MaybeSignal<Option<f64>>>,
{ {
create_filter_wrapper_with_arg(debounce_filter(ms, options), func) create_filter_wrapper_with_arg(debounce_filter(ms, options), func)
} }

70
src/use_scroll.rs
View file

@ -2,6 +2,7 @@ use crate::core::ElementMaybeSignal;
use crate::use_event_listener::use_event_listener_with_options; use crate::use_event_listener::use_event_listener_with_options;
use crate::utils::CloneableFnWithArg; use crate::utils::CloneableFnWithArg;
use crate::{use_debounce_fn_with_arg, use_throttle_fn_with_arg_and_options, ThrottleOptions}; use crate::{use_debounce_fn_with_arg, use_throttle_fn_with_arg_and_options, ThrottleOptions};
use default_struct_builder::DefaultBuilder;
use leptos::ev::EventDescriptor; use leptos::ev::EventDescriptor;
use leptos::*; use leptos::*;
use std::borrow::Cow; use std::borrow::Cow;
@ -48,16 +49,24 @@ use wasm_bindgen::JsCast;
/// # let element = create_node_ref(cx); /// # let element = create_node_ref(cx);
/// # /// #
/// let UseScrollReturn { /// let UseScrollReturn {
/// x, y, set_x, set_y, is_scrolling, arrived_state, directions, .. /// x,
/// } = use_scroll_with_options(cx, element, UseScrollOptions { /// y,
/// offset: ScrollOffset { /// set_x,
/// set_y,
/// is_scrolling,
/// arrived_state,
/// directions,
/// ..
/// } = use_scroll_with_options(
/// cx,
/// element,
/// UseScrollOptions::default().offset(ScrollOffset {
/// top: 30.0, /// top: 30.0,
/// bottom: 30.0, /// bottom: 30.0,
/// right: 30.0, /// right: 30.0,
/// left: 30.0, /// left: 30.0,
/// }, /// }),
/// ..Default::default() /// );
/// });
/// # /// #
/// # view! { cx, /// # view! { cx,
/// # <div node_ref=element>"..."</div> /// # <div node_ref=element>"..."</div>
@ -107,10 +116,11 @@ use wasm_bindgen::JsCast;
/// # /// #
/// let UseScrollReturn { /// let UseScrollReturn {
/// x, y, set_x, set_y, .. /// x, y, set_x, set_y, ..
/// } = use_scroll_with_options(cx, element, UseScrollOptions { /// } = use_scroll_with_options(
/// behavior: ScrollBehavior::Smooth.into(), /// cx,
/// ..Default::default() /// element,
/// }); /// UseScrollOptions::default().behavior(ScrollBehavior::Smooth),
/// );
/// # /// #
/// # view! { cx, /// # view! { cx,
/// # <div node_ref=element>"..."</div> /// # <div node_ref=element>"..."</div>
@ -137,10 +147,11 @@ use wasm_bindgen::JsCast;
/// ///
/// let UseScrollReturn { /// let UseScrollReturn {
/// x, y, set_x, set_y, .. /// x, y, set_x, set_y, ..
/// } = use_scroll_with_options(cx, element, UseScrollOptions { /// } = use_scroll_with_options(
/// behavior: behavior.into(), /// cx,
/// ..Default::default() /// element,
/// }); /// UseScrollOptions::default().behavior(behavior),
/// );
/// # /// #
/// # view! { cx, /// # view! { cx,
/// # <div node_ref=element>"..."</div> /// # <div node_ref=element>"..."</div>
@ -409,30 +420,45 @@ where
const ARRIVED_STATE_THRESHOLD_PIXELS: f64 = 1.0; const ARRIVED_STATE_THRESHOLD_PIXELS: f64 = 1.0;
/// Options for [`use_scroll`]. /// Options for [`use_scroll`].
#[derive(Default)] #[derive(DefaultBuilder)]
pub struct UseScrollOptions { pub struct UseScrollOptions {
/// Throttle time in milliseconds for the scroll events. Defaults to 0 (disabled). /// Throttle time in milliseconds for the scroll events. Defaults to 0 (disabled).
pub throttle: f64, throttle: f64,
/// After scrolling ends we wait idle + throttle milliseconds before we consider scrolling to have stopped. /// After scrolling ends we wait idle + throttle milliseconds before we consider scrolling to have stopped.
/// Defaults to 200. /// Defaults to 200.
pub idle: f64, idle: f64,
/// Threshold in pixels when we consider a side to have arrived (`UseScrollReturn::arrived_state`). /// Threshold in pixels when we consider a side to have arrived (`UseScrollReturn::arrived_state`).
pub offset: ScrollOffset, offset: ScrollOffset,
/// Callback when scrolling is happening. /// Callback when scrolling is happening.
pub on_scroll: Box<dyn CloneableFnWithArg<web_sys::Event>>, on_scroll: Box<dyn CloneableFnWithArg<web_sys::Event>>,
/// Callback when scrolling stops (after `idle` + `throttle` milliseconds have passed). /// Callback when scrolling stops (after `idle` + `throttle` milliseconds have passed).
pub on_stop: Box<dyn CloneableFnWithArg<web_sys::Event>>, on_stop: Box<dyn CloneableFnWithArg<web_sys::Event>>,
/// Options passed to the `addEventListener("scroll", ...)` call /// Options passed to the `addEventListener("scroll", ...)` call
pub event_listener_options: web_sys::AddEventListenerOptions, event_listener_options: web_sys::AddEventListenerOptions,
/// When changing the `x` or `y` signals this specifies the scroll behaviour. /// When changing the `x` or `y` signals this specifies the scroll behaviour.
/// Can be `Auto` (= not smooth) or `Smooth`. Defaults to `Auto`. /// Can be `Auto` (= not smooth) or `Smooth`. Defaults to `Auto`.
pub behavior: MaybeSignal<ScrollBehavior>, #[builder(into)]
behavior: MaybeSignal<ScrollBehavior>,
}
impl Default for UseScrollOptions {
fn default() -> Self {
Self {
throttle: 0.0,
idle: 200.0,
offset: ScrollOffset::default(),
on_scroll: Box::new(|_| {}),
on_stop: Box::new(|_| {}),
event_listener_options: Default::default(),
behavior: Default::default(),
}
}
} }
/// The scroll behavior. /// The scroll behavior.

7
src/use_throttle_fn.rs
View file

@ -50,10 +50,9 @@ pub use crate::utils::ThrottleOptions;
/// // do something, it will be called at most 1 time per second /// // do something, it will be called at most 1 time per second
/// }, /// },
/// 1000.0, /// 1000.0,
/// ThrottleOptions { /// ThrottleOptions::default()
/// leading: true, /// .leading(true)
/// trailing: true, /// .trailing(true),
/// }
/// ); /// );
/// # view! { cx, } /// # view! { cx, }
/// # } /// # }

27
src/utils/filters/debounce.rs
View file

@ -1,32 +1,31 @@
use crate::utils::CloneableFnWithReturn; use crate::utils::CloneableFnWithReturn;
use default_struct_builder::DefaultBuilder;
use leptos::leptos_dom::helpers::TimeoutHandle; use leptos::leptos_dom::helpers::TimeoutHandle;
use leptos::{set_timeout_with_handle, MaybeSignal, SignalGetUntracked}; use leptos::{set_timeout_with_handle, MaybeSignal, SignalGetUntracked};
use std::cell::{Cell, RefCell}; use std::cell::{Cell, RefCell};
use std::rc::Rc; use std::rc::Rc;
use std::time::Duration; use std::time::Duration;
pub struct DebounceOptions<W> #[derive(Clone, DefaultBuilder)]
where pub struct DebounceOptions {
W: Into<MaybeSignal<Option<f64>>>,
{
/// The maximum time allowed to be delayed before it's invoked. /// The maximum time allowed to be delayed before it's invoked.
/// In milliseconds. /// In milliseconds.
pub max_wait: W, #[builder(into)]
pub max_wait: MaybeSignal<Option<f64>>,
} }
impl Default for DebounceOptions<Option<f64>> { impl Default for DebounceOptions {
fn default() -> Self { fn default() -> Self {
Self { max_wait: None } Self {
max_wait: Default::default(),
}
} }
} }
pub fn debounce_filter<W>( pub fn debounce_filter(
ms: impl Into<MaybeSignal<f64>>, ms: impl Into<MaybeSignal<f64>>,
options: DebounceOptions<W>, options: DebounceOptions,
) -> impl Fn(Box<dyn CloneableFnWithReturn<()>>) -> Rc<RefCell<Option<()>>> + Clone ) -> impl Fn(Box<dyn CloneableFnWithReturn<()>>) -> Rc<RefCell<Option<()>>> + Clone {
where
W: Into<MaybeSignal<Option<f64>>>,
{
let timer = Rc::new(Cell::new(None::<TimeoutHandle>)); let timer = Rc::new(Cell::new(None::<TimeoutHandle>));
let max_timer = Rc::new(Cell::new(None::<TimeoutHandle>)); let max_timer = Rc::new(Cell::new(None::<TimeoutHandle>));
@ -38,7 +37,7 @@ where
}; };
let ms = ms.into(); let ms = ms.into();
let max_wait_signal = options.max_wait.into(); let max_wait_signal = options.max_wait;
move |invoke: Box<dyn CloneableFnWithReturn<()>>| { move |invoke: Box<dyn CloneableFnWithReturn<()>>| {
let duration = ms.get_untracked(); let duration = ms.get_untracked();

3
src/utils/filters/throttle.rs
View file

@ -1,4 +1,5 @@
use crate::utils::CloneableFnWithReturn; use crate::utils::CloneableFnWithReturn;
use default_struct_builder::DefaultBuilder;
use js_sys::Date; use js_sys::Date;
use leptos::leptos_dom::helpers::TimeoutHandle; use leptos::leptos_dom::helpers::TimeoutHandle;
use leptos::{set_timeout_with_handle, MaybeSignal, SignalGetUntracked}; use leptos::{set_timeout_with_handle, MaybeSignal, SignalGetUntracked};
@ -7,7 +8,7 @@ use std::cmp::max;
use std::rc::Rc; use std::rc::Rc;
use std::time::Duration; use std::time::Duration;
#[derive(Copy, Clone)] #[derive(Copy, Clone, DefaultBuilder)]
pub struct ThrottleOptions { pub struct ThrottleOptions {
pub trailing: bool, pub trailing: bool,
pub leading: bool, pub leading: bool,