sveltejs/ svelte-scroller

Svelte

HTML

JavaScript

Need help with svelte-scroller?

Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

sveltejs

203 Stars

15 Forks

Other

28 Commits

9 Opened issues

Description

A <Scroller> component for Svelte apps

Services available

Need anything else?

Contributors list

Readme

svelte-scroller (demo)

Name: svelte-scroller
Brand: svelte-scroller
SKU: //sveltejs/svelte-scroller
Rating: 2.2575 (203 reviews)

A scroller component for Svelte apps.

Installation

yarn add @sveltejs/svelte-scroller

Usage

This is the background content. It will stay fixed in place while the foreground scrolls over the top.

<p>Section {index + 1} is currently active.</p>

This is the first section.

This is the second section.

This is the third section.

You must have one

slot="background"

element and one

slot="foreground"

element — see composing with <slot> for more info.

Parameters

The following parameters are available:

| parameter | default | description | | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | top | 0 | The vertical position that the top of the foreground must scroll past before the background becomes fixed, as a proportion of window height | | bottom | 1 | The inverse of

top

true

, the background will scroll such that the bottom edge reaches the

bottom

at the same time as the foreground. This effect can be unpleasant for people with high motion sensitivity, so use it advisedly |

index

offset

progress

and

count

By binding to these properties, you can track the user's behaviour:

```
index
```
— the currently active section
```
offset
```
— how far the section has scrolled past the
```
threshold
```
, as a value between 0 and 1
```
progress
```
— how far the foreground has travelled, where 0 is the top of the foreground crossing
```
top
```
, and 1 is the bottom crossing
```
bottom
```
```
count
```
— the number of sections

You can rename them with e.g.

bind:index={i}

Configuring webpack

If you're using webpack with svelte-loader, make sure that you add

"svelte"

resolve.mainFields

in your webpack config. This ensures that webpack imports the uncompiled component (

src/index.html

) rather than the compiled version (

index.mjs

) — this is more efficient.

If you're using Rollup with rollup-plugin-svelte, this will happen automatically.

License

LIL