$scroll

November 5, 2022 · View on GitHub

A magic helper to generate to scroll the viewport in Alpine.Js

Usage

Coming soon

Include the following <script> tag in the <head> of your document, before Alpine:

<script src="https://unpkg.com/@alpine-collective/toolkit-scroll@1.0.1/dist/cdn.min.js" defer></script>

<script src="https://cdn.jsdelivr.net/npm/@alpine-collective/toolkit-scroll@1.0.1/dist/cdn.min.js" defer></script>

If you would like to bundle the plugin yourself, install it via NPM:

npm install @alpine-collective/toolkit-scroll --save-dev

You can then register the plugin with Alpine:

import Alpine from 'alpinejs'
import Scroll from '@alpine-collective/toolkit-scroll'

Alpine.plugin(Scroll)

Alpine.start()