ROADMAP

[clementroche]

List

• support pull to refresh and UI collapse on syncTouch
• support scroll snap (https://github.com/darkroomengineering/lenis/blob/main/packages/snap/README.md)
• support typescript
• lenis/vue
• lenis/svelte
• support RSC 'use client'
• listen to overflow change and stop/start accordingly
• include scroll-padding to scrollTo
• auto RAF
• examples (nested scroll, horizontal, etc.)
• check if GSAP Scrolltrigger integration is even necessary
• detect internal links (#anchor) click and scroll to accordingly
• deprecate lenis/snap type option.
• use bun

Breaking changes:

• rename options correctly (eg: syncTouch -> touch.sync)
• lenis/react deprecate root option to not target window but just forward instance. Maybe children detection can help.
• rename properties to be more explicit (eg: isScrolling -> isWheelScrolling/isTouchScrolling/isUserScrolling)
• lenis/react use useSyncExternalStore

How can you help ?

• Pull Requests
• Become a Sponsor

[Myphz]

Hello! I see that many types are typed as any in dist/types.
Would it be helpful to open a PR and make those types a bit narrower? Or are you working on it already?

[clementroche]

@Myphz PR are always welcome

[Myphz]

@Myphz PR are always welcome

I opened #345 to improve TypeScript support. Let me know if everything's ok! Thank you

[giuliobracci]

Hi @clementroche regarding rename options correctly (eg: syncTouch -> touch.sync), you are talking about renaming and also refactoring the options passed on Lenis instantiation?

E.G:

const lenis = new Lenis({
    lerp: 0.1,
    touch: {
     sync: false,
     syncLerp: 0.075,
     inertiaMultiplier: 35
    },
});

[clementroche]

Hi @clementroche regarding rename options correctly (eg: syncTouch -> touch.sync), you are talking about renaming and also refactoring the options passed on Lenis instantiation?

E.G:

const lenis = new Lenis({
    lerp: 0.1,
    touch: {
     sync: false,
     syncLerp: 0.075,
     inertiaMultiplier: 35
    },
});

Yes @giuliobracci

const lenis = new Lenis({
    wheel: {
      lerp: 0.1,
    },
    touch: {
     sync: false,
     lerp: 0.075,
     inertiaMultiplier: 35
    },
});

[joebentaylor1995]

Are we getting rid of snap?

[clementroche]

no @joebentaylor1995, it's just about removing type option that is legacy stuff