astro-lenis

This is an Astro integration that adds simple and performant smooth-scrolling with Lenis.

Usage

Installation

Install the integration automatically using the Astro CLI:

npx astro add astro-lenis

pnpm astro add astro-lenis

yarn astro add astro-lenis

Or install it manually:

1. Install the required dependencies

npm install astro-lenis

pnpm add astro-lenis

yarn add astro-lenis

2. Add the integration to your astro.config.mjs

+import lenis from "astro-lenis";

export default defineConfig({
  integrations: [
+    lenis(),
  ],
});

Configuration

This package is meant to be a simple drop-in smooth-scroll solution using the default Lenis configuration. If you need a more complex solution visit the Lenis Github.

Licensing

MIT Licensed. Made with ❤️ by Matthew Justice.

Acknowledgements

@Bryceguy for helping me out so much with this in the discord
@Florian for making the template
@Houston because you're cute