# Repository: darkroomengineering/lenis
# Stars: 13639
## README.md
[](https://github.com/darkroomengineering/lenis)
[](https://www.npmjs.com/package/lenis)
[](https://www.npmjs.com/package/lenis)
[](https://bundlephobia.com/package/lenis)
## Introduction
Lenis ("smooth" in latin) is a lightweight, robust, and performant smooth scroll library. It's designed by [@darkroom.engineering](https://twitter.com/darkroomdevs) to be simple to use and easy to integrate into your projects. It's built with performance in mind and is optimized for modern browsers. It's perfect for creating smooth scrolling experiences on your website such as WebGL scroll syncing, parallax effects, and much more, see [Demo](https://lenis.darkroom.engineering/) and [Showcase](https://www.lenis.dev/showcase).
Read our [Manifesto](https://github.com/darkroomengineering/lenis/blob/main/MANIFESTO.md) to learn more about the inspiration behind Lenis.
- [Sponsors](#sponsors)
- [Packages](#packages)
- [Showcase](https://www.lenis.dev/showcase)
- [Installation](#installation)
- [Setup](#setup)
- [No-code usage](#no-code-usage)
- [Settings](#settings)
- [Properties](#properties)
- [Methods](#methods)
- [Events](#events)
- [Considerations](#considerations)
- [Limitations](#limitations)
- [Troubleshooting](#troubleshooting)
- [Tutorials](#tutorials)
- [Plugins](#plugins)
- [License](#license)
## Sponsors
If you’ve used Lenis and it made your site feel just a little more alive, consider [sponsoring](https://github.com/sponsors/darkroomengineering).
Your support helps us smooth out the internet one library at a time—and lets us keep building tools that care about the details most folks overlook.
[](mailto:jesse@cosmos.so) [](https://github.com/smsunarto) [](https://github.com/bizarro) [](https://github.com/itsoffbrand) [](https://github.com/arkconclave) [](mailto:hello@framerpod.com) [](https://github.com/glauber-sampaio) [](https://github.com/cachet-studio) [](https://github.com/OHO-Design) [](https://github.com/joevingracien) [](mailto:webdesignbylazar@gmail.com)
## Packages
- [lenis](https://github.com/darkroomengineering/lenis/blob/main/README.md)
- [lenis/react](https://github.com/darkroomengineering/lenis/blob/main/packages/react/README.md)
- [lenis/vue](https://github.com/darkroomengineering/lenis/tree/main/packages/vue/README.md)
- [lenis/framer](https://lenis.framer.website/)
- [lenis/snap](https://github.com/darkroomengineering/lenis/tree/main/packages/snap/README.md)
## Installation
Using a package manager:
```bash
npm i lenis
# or
yarn add lenis
# or
pnpm add lenis
```
```js
import Lenis from 'lenis'
```
Using scripts:
```html
```
## Setup
### Basic:
```js
// Initialize Lenis
const lenis = new Lenis({
autoRaf: true,
});
// Listen for the scroll event and log the event data
lenis.on('scroll', (e) => {
console.log(e);
});
```
### Custom raf loop:
```js
// Initialize Lenis
const lenis = new Lenis();
// Use requestAnimationFrame to continuously update the scroll
function raf(time) {
lenis.raf(time);
requestAnimationFrame(raf);
}
requestAnimationFrame(raf);
```
### Recommended CSS:
**Import stylesheet:**
```js
import 'lenis/dist/lenis.css'
```
**Or link the CSS file:**
```html
```
**Or add it manually:**
[See lenis.css stylesheet](./packages/core/lenis.css)
### GSAP ScrollTrigger:
```js
// Initialize a new Lenis instance for smooth scrolling
const lenis = new Lenis();
// Synchronize Lenis scrolling with GSAP's ScrollTrigger plugin
lenis.on('scroll', ScrollTrigger.update);
// Add Lenis's requestAnimationFrame (raf) method to GSAP's ticker
// This ensures Lenis's smooth scroll animation updates on each GSAP tick
gsap.ticker.add((time) => {
lenis.raf(time * 1000); // Convert time from seconds to milliseconds
});
// Disable lag smoothing in GSAP to prevent any delay in scroll animations
gsap.ticker.lagSmoothing(0);
```
## No-code usage
One line, no build step — just drop this into your HTML:
```html
```
That's it, your page now has smooth scrolling and should handle most of the usual issues such as:
- compatibility with other packages
- modals
- smooth anchors
- scroll reset on page change
## Settings
| Option | Type | Default | Description |
|-------------------------|----------------------------|----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `allowNestedScroll` | `boolean` | `false` | Automatically allow nested scrollable elements to scroll natively. This is the simplest way to handle nested scroll. ⚠️ Can create performance issues since it checks the DOM tree on every scroll event. If that's a concern, use `prevent` option instead. |
| `anchors` | `boolean, ScrollToOptions` | `false` | Scroll to anchor links when clicked. If `true` is passed, it will enable anchor links with default options. If `ScrollToOptions` is passed, it will enable anchor links with the given options. |
| `autoRaf` | `boolean` | `false` | Whether or not to automatically run `requestAnimationFrame` loop. |
| `autoResize` | `boolean` | `true` | Resize instance automatically based on `ResizeObserver`. If `false` you must resize manually using `.resize()`. |
| `autoToggle` | `boolean` | `false` | Automatically start or stop the lenis instance based on the wrapper's overflow property, ⚠️ this requires Lenis recommended CSS. Safari > 17.3, Chrome > 116 and Firefox > 128 ([https://caniuse.com/?search=transition-behavior](https://caniuse.com/?search=transition-behavior)). |
| `content` | `HTMLElement` | `document.documentElement` | The element that contains the content that will be scrolled, usually `wrapper`'s direct child. |
| `duration` | `number` | `1.2` | The duration of scroll animation (in seconds). Useless if lerp defined. |
| `easing` | `function` | `(t) => Math.min(1, 1.001 - Math.pow(2, -10 * t))` | The easing function to use for the scroll animation, our default is custom but you can pick one from [Easings.net](https://easings.net/en). Useless if lerp defined. |
| `eventsTarget` | `HTMLElement, Window` | `wrapper` | The element that will listen to `wheel` and `touch` events. |
| `gestureOrientation` | `string` | `vertical` | The orientation of the gestures. Can be `vertical`, `horizontal` or `both`. |
| `infinite` | `boolean` | `false` | Enable infinite scrolling! `syncTouch: true` is required on touch devices ([See example](https://codepen.io/ClementRoche/pen/OJqBLod)). |
| `lerp` | `number` | `0.1` | Linear interpolation (lerp) intensity (between 0 and 1). |
| `naiveDimensions` | `boolean` | `false` | If `true`, Lenis will use naive dimensions calculation. ⚠️ Be careful, this has a performance impact. |
| `orientation` | `string` | `vertical` | The orientation of the scrolling. Can be `vertical` or `horizontal`. |
| `overscroll` | `boolean` | `true` | Similar to CSS overscroll-behavior (https://developer.mozilla.org/en-US/docs/Web/CSS/overscroll-behavior). |
| `prevent` | `function` | `undefined` | Manually prevent scroll to be smoothed based on elements traversed by events. If `true` is returned, it will prevent the scroll to be smoothed. Example: `(node) => node.classList.contains('cookie-modal')`. |
| `smoothWheel` | `boolean` | `true` | Smooth the scroll initiated by `wheel` events. |
| `stopInertiaOnNavigate` | `boolean` | `false` | If `true`, Lenis will stop inertia when an internal link is clicked. |
| `syncTouch` | `boolean` | `false` | Mimic touch device scroll while allowing scroll sync (can be unstable on iOS<16). |
| `syncTouchLerp` | `number` | `0.075` | Lerp applied during `syncTouch` inertia. |
| `touchInertiaExponent` | `number` | `1.7` | Manage the strength of syncTouch inertia. |
| `touchMultiplier` | `number` | `1` | The multiplier to use for touch events. |
| `virtualScroll` | `function` | `undefined` | Manually modify the events before they get consumed. If `false` is returned, the scroll will not be smoothed. Examples: `(e) => { e.deltaY /= 2 }` (to slow down vertical scroll) or `({ event }) => !event.shiftKey` (to prevent scroll to be smoothed if shift key is pressed). |
| `wheelMultiplier` | `number` | `1` | The multiplier to use for mouse wheel events. |
| `wrapper` | `HTMLElement, Window` | `window` | The element that will be used as the scroll container. |
## Properties
| Property | Type | Description |
|-------------------------|-------------------|----------------------------------------------------------------------------|
| `actualScroll` | `number` | Current scroll value registered by the browser |
| `animatedScroll` | `number` | Current scroll value |
| `className` (getter) | `string` | `rootElement` className |
| `dimensions` | `object` | Dimensions instance |
| `direction` | `number` | `1`: scrolling up, `-1`: scrolling down |
| `isHorizontal` (getter) | `boolean` | Whether or not the instance is horizontal |
| `isScrolling` (getter) | `boolean, string` | Whether or not the scroll is being animated, `smooth`, `native` or `false` |
| `isStopped` (getter) | `boolean` | Whether or not the user should be able to scroll |
| `lastVelocity` | `number` | Last scroll velocity |
| `limit` (getter) | `number` | Maximum scroll value |
| `options` | `object` | Instance options |
| `progress` (getter) | `number` | Scroll progress from `0` to `1` |
| `rootElement` (getter) | `HTMLElement` | Element on which Lenis is instanced |
| `scroll` (getter) | `number` | Current scroll value (handles infinite scroll if activated) |
| `targetScroll` | `number` | Target scroll value |
| `time` | `number` | Time elapsed since instance creation |
| `velocity` | `number` | Current scroll velocity |
## Methods
| Method | Description | Arguments |
|-----------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `destroy()` | Destroys the instance and removes all events. | |
| `on(id, function)` | `id` can be any of the following [instance events](#instance-events) to listen. | |
| `raf(time)` | Must be called every frame for internal usage. | `time`: in ms |
| `resize()` | Compute internal sizes, it has to be used if `autoResize` option is `false`. | |
| `scrollTo(target, options)` | Scroll to target. | `target`: goal to reach
`offset`(`number`): equivalent to [`scroll-padding-top`](https://developer.mozilla.org/en-US/docs/Web/CSS/scroll-padding-top)
`lerp`(`number`): animation lerp intensity
`duration`(`number`): animation duration (in seconds)
`easing`(`function`): animation easing
`immediate`(`boolean`): ignore duration, easing and lerp
`lock`(`boolean`): whether or not to prevent the user from scrolling until the target is reached
`force`(`boolean`): reach target even if instance is stopped
`onComplete`(`function`): called when the target is reached
`userData`(`object`): this object will be forwarded through `scroll` events
|
| `start()` | Resumes the scroll | |
| `stop()` | Pauses the scroll | |
## Events
| Event | Callback Arguments |
|------------------|---------------------------|
| `scroll` | Lenis instance |
| `virtual-scroll` | `{deltaX, deltaY, event}` |
## Considerations
### Nested scroll
The simplest and most reliable way to handle nested scrollable elements is to use the `allowNestedScroll` option:
```js
const lenis = new Lenis({
allowNestedScroll: true,
})
```
This automatically detects nested scrollable elements and lets them scroll natively. However, this can create performance issues since Lenis needs to check the DOM tree on every scroll event. If you experience performance problems, use `data-lenis-prevent` instead.
#### Using HTML attributes
```html
