Skip to content

add lastSnapPointX/Y option to disable snapping past this point #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

add lastSnapPointX/Y option to disable snapping past this point #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,11 @@ const snapConfig = {
* @param t normalized time typically in the range [0, 1]
*/
easing: easeInOutQuad,
/**
* last Snap Interval after which scroll snapping is disabled. first section is 0. default = Infinity means scroll snapping is never disabled.
*/
lastSnapPointX: 4
lastSnapPointY: 5
}

function callback() {
Expand Down
22 changes: 18 additions & 4 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const DURATION_DEFAULT = 300
const THRESHOLD_DEFAULT = 0.2
const SNAPSTOP_DEFAULT = false
const EASING_DEFAULT = easeInOutQuad
const LAST_SNAP_POINT_DEFAULT = Infinity
const NOOP = () => {}

interface ScrollSnapConfiguration {
Expand Down Expand Up @@ -38,6 +39,11 @@ interface ScrollSnapConfiguration {
* @param t normalized time typically in the range [0, 1]
*/
easing?: (t: number) => number
/**
* last Snap Interval after which scroll snapping is disabled. first section is 0. default = Infinity means scroll snapping is never disabled.
*/
lastSnapPointX?: number
lastSnapPointY?: number
}

interface SnapLength {
Expand All @@ -63,6 +69,8 @@ export default class ScrollSnap {
threshold: ScrollSnapConfiguration['threshold']
snapStop: ScrollSnapConfiguration['snapStop']
easing: ScrollSnapConfiguration['easing']
lastSnapPointX: ScrollSnapConfiguration['lastSnapPointX']
lastSnapPointY: ScrollSnapConfiguration['lastSnapPointY']

element: HTMLElement
listenerElement: HTMLElement | Window
Expand Down Expand Up @@ -92,6 +100,8 @@ export default class ScrollSnap {
threshold,
snapStop,
easing,
lastSnapPointX,
lastSnapPointY,
} = config

if (
Expand Down Expand Up @@ -145,6 +155,10 @@ export default class ScrollSnap {
}
this.easing = easing || EASING_DEFAULT

this.lastSnapPointX = lastSnapPointX || LAST_SNAP_POINT_DEFAULT;

this.lastSnapPointY = lastSnapPointY || LAST_SNAP_POINT_DEFAULT;

if (snapStop && typeof snapStop !== 'boolean') {
throw new Error(
`Optional config property 'snapStop' is not valid, expected BOOLEAN but found ${(typeof snapStop).toUpperCase()}`
Expand Down Expand Up @@ -315,11 +329,11 @@ export default class ScrollSnap {
// console.log('currentPoint', currentPoint)
// console.log('nextPoint', nextPoint)

// calculate where to scroll
// calculate where to scroll - scroll normally (not ot snap point) if above last snap point
const scrollTo = {
y: nextPoint.y * snapLength.y,
x: nextPoint.x * snapLength.x,
}
y: currentPoint.y < this.lastSnapPointY ? nextPoint.y * snapLength.y : top,
x: currentPoint.x < this.lastSnapPointX ? nextPoint.x * snapLength.x : left,
};

// stay in bounds (minimum: 0, maxmimum: absolute height)
scrollTo.y = this.stayInBounds(0, target.scrollHeight, scrollTo.y)
Expand Down