@studio-freight/react-lenis
Advanced tools
 
react-lenis provides a <ReactLenis> component that creates a Lenis instance and provides it to its children via context. This allows you to use Lenis in your React app without worrying about passing the instance down through props. It also provides a useLenis hook that allows you to access the Lenis instance from any component in your app.
npm i @studio-freight/react-lenis
import { ReactLenis, useLenis } from '@studio-freight/react-lenis'
function Layout() {
const lenis = useLenis(({ scroll }) => {
// called every scroll
})
return (
<ReactLenis root>
{ /* content */ }
</ReactLenis>
)
}
// libs/react-lenis.js
'use client'
export * from '@studio-freight/react-lenis'
import { ReactLenis, useLenis } from 'libs/react-lenis'
options: Lenis options.root: Lenis will be instanciate using <html> scroll. Default: false.autoRaf: if false, lenis.raf needs to be called manually. Default: true.rafPriority: Tempus execution priority. Default: 0.className: Class name for the wrapper div. Default: ''.Once the Lenis context is set (components mounted inside <ReactLenis>) you can use these handy hooks:
useLenis is a hook that returns the Lenis instance
The hook takes three argument:
callback: The function to be called whenever a scroll event is emitteddeps: Trigger callback on changepriority: Manage callback execution orderGSAP integration
function Component() {
const lenisRef = useRef()
useEffect(() => {
function update(time) {
lenisRef.current?.lenis?.raf(time * 1000)
}
gsap.ticker.add(update)
return () => {
gsap.ticker.remove(update)
}
})
return (
<ReactLenis ref={lenisRef} autoRaf={false}>
{ /* content */ }
</ReactLenis>
)
}
This tool is maintained by the darkroom.engineering team:
FAQs
 
The npm package @studio-freight/react-lenis receives a total of 7,566 weekly downloads. As such, @studio-freight/react-lenis popularity was classified as popular.
We found that @studio-freight/react-lenis demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."