Skip to content
This repository was archived by the owner on Aug 9, 2023. It is now read-only.

Commit 7d82fe3

Browse files
committed
update docs
1 parent dad9b9d commit 7d82fe3

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,7 @@ Ash's Smooth Scroll 🍑
107107
* [.containerElement](#ASScroll+containerElement) ⇒ <code>HTMLElement</code>
108108
* [.scrollElements](#ASScroll+scrollElements) ⇒ <code>Array</code>
109109
* [.isHorizontal](#ASScroll+isHorizontal) ⇒ <code>boolean</code>
110+
* [.isScrollJacking](#ASScroll+isScrollJacking) ⇒ <code>boolean</code>
110111
* ~~[.scrollPos](#ASScroll+scrollPos)~~
111112
* ~~[.smoothScrollPos](#ASScroll+smoothScrollPos)~~
112113
* [.enable([parameters])](#ASScroll+enable)
@@ -188,6 +189,12 @@ Returns the the element(s) that ASScroll is scrolling.
188189
Returns whether or not ASScroll is in horizontal scroll mode
189190

190191
**Returns**: <code>boolean</code> - The status of horizontal scroll
192+
<a name="ASScroll+isScrollJacking"></a>
193+
194+
## asscroll.isScrollJacking ⇒ <code>boolean</code>
195+
Returns whether or not ASScroll is actively transforming the page element(s). For example, would return false if running on a touch device and touchScrollType !== 'transform', or if ASScroll was currently disabled via the .disable() method.
196+
197+
**Returns**: <code>boolean</code> - The status of actively controlling the page scroll
191198
<a name="ASScroll+scrollPos"></a>
192199

193200
## ~~asscroll.scrollPos~~

0 commit comments

Comments
 (0)