docs: fix inverted direction property values in README - #539
Open
cauelimsia wants to merge 1 commit into
Open
Conversation
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 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017d8jkYPToh2LvKGu1rLk8i
|
@cauelimsia is attempting to deploy a commit to the Darkroom Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Properties table describes
directionas1: scrolling up,-1: scrolling down, but the implementation computes it as the sign of the scroll delta:https://github.com/darkroomengineering/lenis/blob/main/packages/core/src/lenis.ts#L630-L632
Scrolling down increases the scroll value, so
directionis1when scrolling down and-1when scrolling up. This PR flips the two values in the table to match the implementation.