darkroomengineering / lenis

How smooth scroll should be
https://lenis.darkroom.engineering
MIT License
7.37k stars 317 forks source link

docs: add instance props section #210

Closed mickaelchanrion closed 11 months ago

mickaelchanrion commented 11 months ago

Hi there 👋 I noticed that the docs was not mentioning the properties attached to a Lenis instance so I thought it would be nice to add it. Could come handy to know at first glance how to get lenis.velocity or lenis.progress!

Some properties were voluntarily ignored as they seem quite "internal". (e.g.: animate, onScroll, virtualScroll, etc.)

vercel[bot] commented 11 months ago

@mickaelchanrion is attempting to deploy a commit to the Studio Freight Team on Vercel.

A member of the Team first needs to authorize it.

clementroche commented 11 months ago

Looks sharp, thank you !