Skip to content

Latest commit

 

History

History
114 lines (77 loc) · 2.77 KB

README.md

File metadata and controls

114 lines (77 loc) · 2.77 KB
Raw

lenis/react

Introduction

lenis/react 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.

Installation

npm i lenis

Usage

Basic

import { ReactLenis, useLenis } from 'lenis/react'

function Layout() {
  const lenis = useLenis(({ scroll }) => {
    // called every scroll
  })

  return (
    <ReactLenis root>
      { /* content */ }
    </ReactLenis>
  )
}

RSC

// libs/lenis.js

'use client'

export * from 'lenis/react'
import { ReactLenis, useLenis } from 'libs/lenis'

Props

  • 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: ''.

Hooks

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 emitted
  • deps: Trigger callback on change
  • priority: Manage callback execution order

Examples

GSAP 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>
  )
}

lenis/react in use


Authors

This tool is maintained by the darkroom.engineering team:


License

The MIT License.