From dc805e1bded3cb09a0cb19371de3abc137803c28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cau=C3=AA=20Lima?= Date: Fri, 14 Aug 2026 17:23:02 -0400 Subject: [PATCH] docs: fix inverted direction property values The README stated direction is 1 when scrolling up and -1 when scrolling down, but the implementation sets direction = Math.sign(newScroll - lastScroll), so scrolling down (increasing scroll value) yields 1 and scrolling up yields -1. Co-Authored-By: Claude Fable 5 Claude-Session: https://claude.ai/code/session_017d8jkYPToh2LvKGu1rLk8i --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7288504f..7fb6cc3d 100644 --- a/README.md +++ b/README.md @@ -238,7 +238,7 @@ That's it, your page now has smooth scrolling and should handle most of the usua | `animatedScroll` | `number` | Current scroll value | | `className` (getter) | `string` | `rootElement` className | | `dimensions` | `object` | Dimensions instance | -| `direction` | `number` | `1`: scrolling up, `-1`: scrolling down | +| `direction` | `number` | `1`: scrolling down, `-1`: scrolling up | | `isHorizontal` (getter) | `boolean` | Whether or not the instance is horizontal | | `isScrolling` (getter) | `boolean, string` | Whether or not the scroll is being animated, `smooth`, `native` or `false` | | `isStopped` (getter) | `boolean` | Whether or not the user should be able to scroll |