@fastkit/scroller 0.2.13 → 0.3.3

package/dist/scroller.cjs.js

@@ -389,8 +389,12 @@ function scrollToElement(target, options = {}) {
     const cumulativeOffsetTarget = cumulativeOffset($target);
     const initialY = $container.scrollTop;
     const initialX = $container.scrollLeft;
-    const targetY = cumulativeOffsetTarget.top - cumulativeOffsetContainer.top + offset.y;
-    const targetX = cumulativeOffsetTarget.left - cumulativeOffsetContainer.left + offset.x;
+    const targetY = cumulativeOffsetTarget.top -
+        cumulativeOffsetContainer.top +
+        (offset.y || 0);
+    const targetX = cumulativeOffsetTarget.left -
+        cumulativeOffsetContainer.left +
+        (offset.x || 0);
     const diffX = x ? targetX - initialX : 0;
     const diffY = y ? targetY - initialY : 0;
     return scroll(diffX, diffY, _options, {
@@ -859,6 +863,13 @@ class Scroller extends ev.EV {
             this._isDocumentElement || this._isBodyElement ? window : this._el;
         this._setup();
     }
+    _scrollToElementAddtionalOffset;
+    setScrollToElementAddtionalOffset(offset) {
+        this._scrollToElementAddtionalOffset = offset;
+    }
+    deleteScrollToElementAddtionalOffset() {
+        delete this._scrollToElementAddtionalOffset;
+    }
     /**
      * インスタンスが実行可能になった際にresolveされるPromiseインスタンスを返却します。
      */
@@ -917,6 +928,7 @@ class Scroller extends ev.EV {
         delete this._resizeObserver;
         delete this._scrollToResult;
         delete this._visibilityListener;
+        this.deleteScrollToElementAddtionalOffset();
         this._setState(exports.ScrollerState.Destroyed);
         this.offAll();
     }
@@ -1428,6 +1440,34 @@ class Scroller extends ev.EV {
             ...this.scrollToElementSettingsDefaults,
             ...source,
         };
+        let { _scrollToElementAddtionalOffset: addtionalOffset } = this;
+        if (!addtionalOffset)
+            return merged;
+        if (typeof addtionalOffset === 'function') {
+            addtionalOffset = addtionalOffset(this);
+        }
+        if (!addtionalOffset)
+            return merged;
+        if (typeof addtionalOffset === 'number') {
+            addtionalOffset = {
+                x: addtionalOffset,
+                y: addtionalOffset,
+            };
+        }
+        let { offset } = merged;
+        if (!offset) {
+            merged.offset = addtionalOffset;
+            return merged;
+        }
+        if (typeof offset === 'number') {
+            offset = {
+                x: offset,
+                y: offset,
+            };
+        }
+        offset.x = (offset.x || 0) + (addtionalOffset.x || 0);
+        offset.y = (offset.y || 0) + (addtionalOffset.y || 0);
+        merged.offset = offset;
         return merged;
     }
     _clearScrollToResult() {

package/dist/scroller.cjs.prod.js

@@ -389,8 +389,12 @@ function scrollToElement(target, options = {}) {
     const cumulativeOffsetTarget = cumulativeOffset($target);
     const initialY = $container.scrollTop;
     const initialX = $container.scrollLeft;
-    const targetY = cumulativeOffsetTarget.top - cumulativeOffsetContainer.top + offset.y;
-    const targetX = cumulativeOffsetTarget.left - cumulativeOffsetContainer.left + offset.x;
+    const targetY = cumulativeOffsetTarget.top -
+        cumulativeOffsetContainer.top +
+        (offset.y || 0);
+    const targetX = cumulativeOffsetTarget.left -
+        cumulativeOffsetContainer.left +
+        (offset.x || 0);
     const diffX = x ? targetX - initialX : 0;
     const diffY = y ? targetY - initialY : 0;
     return scroll(diffX, diffY, _options, {
@@ -859,6 +863,13 @@ class Scroller extends ev.EV {
             this._isDocumentElement || this._isBodyElement ? window : this._el;
         this._setup();
     }
+    _scrollToElementAddtionalOffset;
+    setScrollToElementAddtionalOffset(offset) {
+        this._scrollToElementAddtionalOffset = offset;
+    }
+    deleteScrollToElementAddtionalOffset() {
+        delete this._scrollToElementAddtionalOffset;
+    }
     /**
      * インスタンスが実行可能になった際にresolveされるPromiseインスタンスを返却します。
      */
@@ -917,6 +928,7 @@ class Scroller extends ev.EV {
         delete this._resizeObserver;
         delete this._scrollToResult;
         delete this._visibilityListener;
+        this.deleteScrollToElementAddtionalOffset();
         this._setState(exports.ScrollerState.Destroyed);
         this.offAll();
     }
@@ -1428,6 +1440,34 @@ class Scroller extends ev.EV {
             ...this.scrollToElementSettingsDefaults,
             ...source,
         };
+        let { _scrollToElementAddtionalOffset: addtionalOffset } = this;
+        if (!addtionalOffset)
+            return merged;
+        if (typeof addtionalOffset === 'function') {
+            addtionalOffset = addtionalOffset(this);
+        }
+        if (!addtionalOffset)
+            return merged;
+        if (typeof addtionalOffset === 'number') {
+            addtionalOffset = {
+                x: addtionalOffset,
+                y: addtionalOffset,
+            };
+        }
+        let { offset } = merged;
+        if (!offset) {
+            merged.offset = addtionalOffset;
+            return merged;
+        }
+        if (typeof offset === 'number') {
+            offset = {
+                x: offset,
+                y: offset,
+            };
+        }
+        offset.x = (offset.x || 0) + (addtionalOffset.x || 0);
+        offset.y = (offset.y || 0) + (addtionalOffset.y || 0);
+        merged.offset = offset;
         return merged;
     }
     _clearScrollToResult() {

package/dist/scroller.d.ts

@@ -294,6 +294,9 @@ export declare class Scroller extends EV<ScrollerEventMap> {
      * @param el - Element、もしくはCSSクエリセレクタ文字列を指定します。
      */
     setElement(el?: Element | string | null): void;
+    private _scrollToElementAddtionalOffset;
+    setScrollToElementAddtionalOffset(offset: ScrollToElementAddtionalOffset | undefined): void;
+    deleteScrollToElementAddtionalOffset(): void;
     /**
      * インスタンスが実行可能になった際にresolveされるPromiseインスタンスを返却します。
      */
@@ -746,6 +749,14 @@ export declare function scrollToBottom(options?: ScrollOptions_2): ScrollResult;
  */
 export declare function scrollToElement(target: ScrollToElementTarget, options?: ScrollToElementOptions): ScrollResult;
 
+export declare type ScrollToElementAddtionalOffset = number | {
+    x?: number;
+    y?: number;
+} | ((scroller: Scroller) => number | {
+    x?: number;
+    y?: number;
+} | undefined);
+
 /**
  * 要素へスクロールさせる際のオプション設定です。
  */
@@ -760,8 +771,8 @@ export declare interface ScrollToElementSettings {
      * x, y 個別に設定が可能ですが、シングルのnumberのみを指定した場合、x, y のそれぞれのオプションが有効な場合にのみその軸に設定されます。
      */
     offset: number | {
-        x: number;
-        y: number;
+        x?: number;
+        y?: number;
     };
     /**
      * 横スクロールの可否を示します。

package/dist/scroller.esm-bundler.js

@@ -381,8 +381,12 @@ function scrollToElement(target, options = {}) {
     const cumulativeOffsetTarget = cumulativeOffset($target);
     const initialY = $container.scrollTop;
     const initialX = $container.scrollLeft;
-    const targetY = cumulativeOffsetTarget.top - cumulativeOffsetContainer.top + offset.y;
-    const targetX = cumulativeOffsetTarget.left - cumulativeOffsetContainer.left + offset.x;
+    const targetY = cumulativeOffsetTarget.top -
+        cumulativeOffsetContainer.top +
+        (offset.y || 0);
+    const targetX = cumulativeOffsetTarget.left -
+        cumulativeOffsetContainer.left +
+        (offset.x || 0);
     const diffX = x ? targetX - initialX : 0;
     const diffY = y ? targetY - initialY : 0;
     return scroll(diffX, diffY, _options, {
@@ -857,6 +861,13 @@ class Scroller extends EV {
             this._isDocumentElement || this._isBodyElement ? window : this._el;
         this._setup();
     }
+    _scrollToElementAddtionalOffset;
+    setScrollToElementAddtionalOffset(offset) {
+        this._scrollToElementAddtionalOffset = offset;
+    }
+    deleteScrollToElementAddtionalOffset() {
+        delete this._scrollToElementAddtionalOffset;
+    }
     /**
      * インスタンスが実行可能になった際にresolveされるPromiseインスタンスを返却します。
      */
@@ -915,6 +926,7 @@ class Scroller extends EV {
         delete this._resizeObserver;
         delete this._scrollToResult;
         delete this._visibilityListener;
+        this.deleteScrollToElementAddtionalOffset();
         this._setState(ScrollerState.Destroyed);
         this.offAll();
     }
@@ -1437,6 +1449,34 @@ class Scroller extends EV {
             ...this.scrollToElementSettingsDefaults,
             ...source,
         };
+        let { _scrollToElementAddtionalOffset: addtionalOffset } = this;
+        if (!addtionalOffset)
+            return merged;
+        if (typeof addtionalOffset === 'function') {
+            addtionalOffset = addtionalOffset(this);
+        }
+        if (!addtionalOffset)
+            return merged;
+        if (typeof addtionalOffset === 'number') {
+            addtionalOffset = {
+                x: addtionalOffset,
+                y: addtionalOffset,
+            };
+        }
+        let { offset } = merged;
+        if (!offset) {
+            merged.offset = addtionalOffset;
+            return merged;
+        }
+        if (typeof offset === 'number') {
+            offset = {
+                x: offset,
+                y: offset,
+            };
+        }
+        offset.x = (offset.x || 0) + (addtionalOffset.x || 0);
+        offset.y = (offset.y || 0) + (addtionalOffset.y || 0);
+        merged.offset = offset;
         return merged;
     }
     _clearScrollToResult() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fastkit/scroller",
-  "version": "0.2.13",
+  "version": "0.3.3",
   "description": "@fastkit/scroller",
   "buildOptions": {
     "name": "Scroller"
@@ -26,9 +26,9 @@
   },
   "homepage": "https://github.com/dadajam4/fastkit/tree/main/packages/scroller#readme",
   "dependencies": {
-    "@fastkit/ev": "0.2.13",
-    "@fastkit/visibility": "0.2.13",
-    "@fastkit/tiny-logger": "0.2.13",
+    "@fastkit/ev": "0.3.3",
+    "@fastkit/visibility": "0.3.3",
+    "@fastkit/tiny-logger": "0.3.3",
     "bezier-easing": "^2.1.0"
   }
 }