@iojcde/react-locomotive-scroll-v5

v0.0.45

Published

a year ago

a react wrapper for locomotive-scroll@v5

Downloads

0High
0Medium
0Low

iojcde

react locomotive-scroll

Introduction

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.

Installation

For npm users:

npm i @studio-freight/react-lenis

For yarn users:

yarn add @studio-freight/react-lenis

Usage

import { ReactLenis, useLenis } from '@studio-freight/react-lenis'

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

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

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.

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?.raf(time * 1000)
    }
  
    gsap.ticker.add(update)
  
    return () => {
      gsap.ticker.remove(update)
    }
  })
  
  return (
    <ReactLenis ref={lenisRef} autoRaf={false}>
      { /* content */ }
    </ReactLenis>
  )
}

Folder Structure

/bundled: Generated by microbundle after running build:bundled script. Includes all external dependencies.
/dist: Generated by microbundle after running build:dist script.
- /dist/types Generated by tsc after running build:types script.
/docs: Used by vite through dev script to serve the documentation.
/docs/App.jsx: here's where you can test your library.
/src: Your library's raw code.

@studio-freight/react-lenis in use

@studio-freight/compono Our Next.js/React component library.
@studio-freight/satus Our starter kit.

Authors

This tool is maintained by the Studio Freight Darkroom team:

Clement Roche (@clementroche_) – Studio Freight
Guido Fier (@uido15) – Studio Freight
Leandro Soengas (@lsoengas) - Studio Freight
Franco Arza (@arzafran) - Studio Freight

License

The MIT License.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme