Skip to content

README.md

Latest commit

 

History

History
55 lines (35 loc) · 1.17 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.17 KB

👯‍♀️ Easy Scroll Sync

npm version bundlephobia

Easily Synchronise scrolling between elements!

Features 🔥

  • Less than 2kb!
  • Zero Dependencies
  • Easy to use! 💪

Install 🔮

NPM

npm install easy-scroll-sync

Yarn

yarn add easy-scroll-sync

Via Script Tag

At the bottom of you body tag

<script src="https://cdn.jsdelivr.net/npm/easy-scroll-sync@latest/dist/easy-scroll-sync.min.js"></script>

Usage 💻

If you are using a module loader you will need to import easy-scroll-sync

import { easyScrollSync } from "easy-scroll-sync";

Set data-scrollsync on the elements you want to synchronise scrolling and you're done!

<div data-scrollsync class="scrollable_item_1"></div>
<div data-scrollsync class="scrollable_item_2"></div>

You can also call easyScrollSync() to reset and recreate the elements scroll listeners.

Support 💬