ROADMAP

[clementroche]

List

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

How can you help ?

• Pull Requests
• Sponsor darkroom.engineering

[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 https://github.com/darkroomengineering/lenis/pull/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
    },
});