Get Started

Svelte Lenis is a library that helps you smoothly scroll through your page. It's built on Lenis

Requirements

Supports projects created using Svelte 5.

Install Svelte Lenis using your package manager of choice.

pnpm add svelte-lenis
bun add svelte-lenis
npm install svelte-lenis

<script>
  import { SvelteLenis } from 'svelte-lenis'
</script>

<SvelteLenis root>
  <!-- content -->
</SvelteLenis>

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.
class : class name for the wrapper div. Default: undefined.
onSetup : When Lenis setup is done, this callback will be called. Read OnSetup for more details.

type OnSetup = (value: {
	lenis: Lenis;
	wrapper?: HTMLDivElement;
	content?: HTMLDivElement;
}) => void;