Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@studio-freight/react-lenis

Package Overview
Dependencies
Maintainers
4
Versions
48
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@studio-freight/react-lenis

a react wrapper for lenis smooth scroll library

  • 0.0.27
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
9.5K
increased by20.29%
Maintainers
4
Weekly downloads
 
Created
Source

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


Authors

This tool is maintained by the Studio Freight Darkroom team:


License

The MIT License.

Keywords

FAQs

Package last updated on 06 Sep 2023

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc