easing-scroll 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "easing-scroll",
3
- "version": "1.0.0",
3
+ "version": "1.0.2",
4
4
  "description": "♿️ Smooth scrolling",
5
5
  "type": "module",
6
6
  "source": "src/index.ts",
@@ -8,28 +8,36 @@ type Ms = number;
8
8
  type Pct = number;
9
9
 
10
10
  type Options = {
11
- top: Px;
12
- left: Px;
13
- duration: Ms;
14
- signal: AbortSignal;
11
+ top?: Px;
12
+ left?: Px;
13
+ duration?: Ms;
14
+ signal?: AbortSignal;
15
15
  /**
16
16
  * @see Easing functions https://easings.net
17
17
  */
18
- easing: (t: Pct) => Pct;
18
+ easing?: (t: Pct) => Pct;
19
19
  };
20
20
 
21
21
  const linear = (t: number): number => t;
22
22
 
23
+ const scrollTo = <E extends Element>(
24
+ target: E,
25
+ { top, left }: Pick<Options, "top" | "left">
26
+ ) => {
27
+ target.scrollTop = top ?? target.scrollTop;
28
+ target.scrollLeft = left ?? target.scrollLeft;
29
+ };
30
+
23
31
  export const easingScroll = <E extends Element>(
24
32
  target: E,
25
- { top, left, signal, duration = 0, easing = linear }: Partial<Options>
33
+ { top, left, signal, duration = 0, easing = linear }: Options
26
34
  ): Promise<Pct> => {
27
35
  if (signal?.aborted) {
28
36
  return Promise.resolve(0);
29
37
  }
30
38
 
31
39
  if (!duration) {
32
- target.scrollTo({ top, left });
40
+ scrollTo(target, { top, left });
33
41
  return Promise.resolve(1);
34
42
  }
35
43
 
@@ -64,10 +72,10 @@ export const easingScroll = <E extends Element>(
64
72
  : startLeft + (left - startLeft) * easing(progress);
65
73
 
66
74
  if (progress < 1) {
67
- target.scrollTo({ top: tickTop, left: tickLeft });
75
+ scrollTo(target, { top: tickTop, left: tickLeft });
68
76
  ramID = requestAnimationFrame(tick);
69
77
  } else {
70
- target.scrollTo({ top, left });
78
+ scrollTo(target, { top, left });
71
79
  signal?.removeEventListener("abort", abortHandler);
72
80
  resolve(1);
73
81
  }