vevet 2.3.0 → 2.4.0

package/src/ts/utils/scroll/scrollToElement.ts

@@ -0,0 +1,74 @@
+import { selectOne } from 'vevet-dom';
+import { ScrollLike } from '../types/general';
+import getScrollValues from './getScrollValues';
+import clamp from '../math/clamp';
+import scrollTo from './scrollTo';
+
+interface Props {
+    /**
+     * @default window
+     */
+    container?: Window | Element | ScrollLike;
+    /**
+     * The target element
+     */
+    el: Element | string;
+    /**
+     * top padding
+     * @default 0
+     */
+    top?: number;
+    /**
+     * left padding
+     * @default 0
+     */
+    left?: number;
+    /**
+     * scroll duration
+     * @default 250
+     */
+    duration?: number;
+}
+
+/**
+ * Scroll to element
+ */
+export default function scrollToElement ({
+    container = window,
+    el,
+    top = 0,
+    left = 0,
+    duration = 250,
+}: Props) {
+    return new Promise<void>((
+        resolve, reject,
+    ) => {
+        const startValues = getScrollValues(container);
+        if (startValues) {
+            const element = selectOne(el);
+            if (element) {
+                const bounding = element.getBoundingClientRect();
+                const toTop = clamp(
+                    bounding.top + startValues.scrollTop - top,
+                    [0, Infinity],
+                );
+                const toLeft = clamp(
+                    bounding.left + startValues.scrollLeft - left,
+                    [0, Infinity],
+                );
+                scrollTo({
+                    container,
+                    top: toTop,
+                    left: toLeft,
+                    duration,
+                }).then(() => {
+                    resolve();
+                }).catch(() => {
+                    reject();
+                });
+            }
+            return;
+        }
+        reject();
+    });
+}

package/src/ts/utils/types/general.ts

@@ -5,3 +5,10 @@ export interface IRemovable {
 export interface IDestroyable {
     destroy: () => void;
 }
+
+export interface ScrollLike {
+    scrollTop: number;
+    scrollLeft: number;
+    scrollTo(options: ScrollToOptions): void;
+    scrollTo(x: number, y: number): void;
+}