Home

Awesome

<p align="center"><img src="https://raw.githubusercontent.com/ashthornton/asscroll/master/docs/banner.jpg"></p> <p align="center"> <a href="https://www.npmjs.com/package/@ashthornton/asscroll"><img src="https://img.shields.io/npm/v/@ashthornton/asscroll?color=%23F7894A" alt="NPM Version"></a> <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/@ashthornton/asscroll?color=%23F7894A"> <a href="https://www.jsdelivr.com/package/npm/@ashthornton/asscroll"><img alt="jsDelivr hits (npm)" src="https://img.shields.io/jsdelivr/npm/hm/@ashthornton/asscroll?color=%23F7894A"></a> </p> <h3 align="center"><strong>āš ļø This repo is no longer actively maintained! ASScroll is still functional but I would recommend switching to <a href="https://github.com/studio-freight/lenis">Lenis</a> as an alternative if you are looking for regular updates and support.</strong></h3>
<h3 align="center"><strong>ASScroll is a Javascript hybrid smooth scroll setup that combines the<br>performance gains of virtual scroll with the reliability of native scroll.</strong></h3> <p align="center" style="padding: 0 15%">This setup aims to be a lightweight solution that provides a consistent smooth scrolling experience across all platforms, devices and hardware.</p>

Advantages over pure virtual scroll:

Other Features:

No animation features are included as there are other libraries that can be used with ASScroll. GreenSock's ScrollTrigger is a great example and a demo is included below

Demos

Sites using ASScroll

Table of contents

<!--ts--> <!--te-->

Install

npm i --save @ashthornton/asscroll or yarn add @ashthornton/asscroll

Also available via JSDelivr CDN which you can then include with a <script> tag.

Zero Config Setup

  1. Add the attribute asscroll-container to the parent element of the content to be smooth scrolled. By default, the first child found within will be scrolled. Both of these selectors be changed in the options.
<body>
    <div asscroll-container>
        <div><!-- The Y translation will be applied to this element --></div>
    </div>
</body>
  1. Import and initialise in Javascript
import ASScroll from '@ashthornton/asscroll'

const asscroll = new ASScroll()

window.addEventListener('load', () => {
    asscroll.enable()
})

<a name="ASScroll"></a>

ASScroll

Ash's Smooth Scroll šŸ‘

<a name="new_ASScroll_new"></a>

new ASScroll([parameters])

Creates an ASScroll instance

ParamTypeDefaultDescription
[parameters]<code>object</code>
[parameters.containerElement]<code>string</code> | <code>HTMLElement</code><code>"[asscroll-container]"</code>The selector string for the outer container element, or the element itself
[parameters.scrollElements]<code>string</code> | <code>HTMLElement</code> | <code>NodeList</code><code>"[asscroll]"</code>The selector string for the elements to scroll, or the elements themselves
[parameters.ease]<code>number</code><code>0.075</code>The ease amount for the transform lerp
[parameters.touchEase]<code>number</code><code>1</code>The ease amount for the transform lerp on touch devices
[parameters.touchScrollType]<code>string</code><code>"none"</code>Set the scrolling method on touch devices. Other options are 'transform' and 'scrollTop'. See the Touch Devices section for more info
[parameters.lockIOSBrowserUI]<code>boolean</code><code>false</code>When using an iOS device and touchScrollType is 'transform', this will change the setup to prevent the browser UI from showing/hiding to stop resize events on scroll.
[parameters.scrollbarEl]<code>string</code><code>".asscrollbar"</code>The selector string for the custom scrollbar element
[parameters.scrollbarHandleEl]<code>string</code><code>".asscrollbar__handle"</code>The selector string for the custom scrollbar handle element
[parameters.customScrollbar]<code>boolean</code><code>true</code>Toggle the custom scrollbar
[parameters.scrollbarStyles]<code>boolean</code><code>true</code>Include the scrollbar CSS via Javascript
[parameters.disableNativeScrollbar]<code>boolean</code><code>true</code>Disable the native browser scrollbar
[parameters.disableRaf]<code>boolean</code><code>false</code>Disable internal requestAnimationFrame loop in order to use an external one
[parameters.disableResize]<code>boolean</code><code>false</code>Disable internal resize event on the window in order to use an external one
[parameters.limitLerpRate]<code>boolean</code><code>true</code>Match lerp speed on >60Hz displays to that of a 60Hz display
[parameters.blockScrollClass]<code>string</code><code>".asscroll-block"</code>The class to add to elements that should block ASScroll when hovered

<a name="ASScroll+targetPos"></a>

asscroll.targetPos ā‡’ <code>number</code>

Returns the target scroll position.

Returns: <code>number</code> - Target scroll position
<a name="ASScroll+currentPos"></a>

asscroll.currentPos ā‡’ <code>number</code>

Gets or sets the current scroll position.

Returns: <code>number</code> - Current scroll position

ParamTypeDescription
scrollPos<code>number</code>The desired scroll position

Example (Sets the scroll position to 200, bypassing any lerps)

asscroll.currentPos = 200

<a name="ASScroll+maxScroll"></a>

asscroll.maxScroll ā‡’ <code>number</code>

Returns the maximum scroll height of the page.

Returns: <code>number</code> - Maxmium scroll height
<a name="ASScroll+containerElement"></a>

asscroll.containerElement ā‡’ <code>HTMLElement</code>

Returns the outer element that ASScroll is attached to.

Returns: <code>HTMLElement</code> - The outer element
<a name="ASScroll+scrollElements"></a>

asscroll.scrollElements ā‡’ <code>Array</code>

Returns the the element(s) that ASScroll is scrolling.

Returns: <code>Array</code> - An array of elements ASScroll is scrolling
<a name="ASScroll+isHorizontal"></a>

asscroll.isHorizontal ā‡’ <code>boolean</code>

Returns whether or not ASScroll is in horizontal scroll mode

Returns: <code>boolean</code> - The status of horizontal scroll
<a name="ASScroll+isScrollJacking"></a>

asscroll.isScrollJacking ā‡’ <code>boolean</code>

Returns whether or not ASScroll is actively transforming the page element(s). For example, would return false if running on a touch device and touchScrollType !== 'transform', or if ASScroll was currently disabled via the .disable() method.

Returns: <code>boolean</code> - The status of actively controlling the page scroll
<a name="ASScroll+scrollPos"></a>

asscroll.scrollPos

Deprecated

See: targetPos
<a name="ASScroll+smoothScrollPos"></a>

asscroll.smoothScrollPos

Deprecated

See: currentPos
<a name="ASScroll+enable"></a>

asscroll.enable([parameters])

Enable ASScroll.

ParamTypeDefaultDescription
[parameters]<code>object</code>
[parameters.newScrollElements]<code>boolean</code> | <code>NodeList</code> | <code>HTMLElement</code><code>false</code>Specify the new element(s) that should be scrolled
[parameters.reset]<code>boolean</code><code>false</code>Reset the scroll position to 0
[parameters.restore]<code>boolean</code><code>false</code>Restore the scroll position to where it was when disable() was called
[parameters.horizontalScroll]<code>boolean</code><code>false</code>Toggle horizontal scrolling

Example (Enables ASScroll on the '.page' element and resets the scroll position to 0)

asscroll.enable({ newScrollElements: document.querySelector('.page'), reset: true })

Example (Enables ASScroll and restores to the previous position before ASScroll.disable() was called)

asscroll.enable({ restore: true })

<a name="ASScroll+disable"></a>

asscroll.disable([parameters])

Disable ASScroll.

ParamTypeDefaultDescription
[parameters]<code>object</code>
[parameters.inputOnly]<code>boolean</code><code>false</code>Only disable the ability to manually scroll (still allow transforms)

Example (Disables the ability to manually scroll whilst still allowing position updates to be made via asscroll.currentPos, for example)

asscroll.disable({ inputOnly: true })

<a name="ASScroll+update"></a>

asscroll.update()

Call the internal animation frame request callback.

<a name="ASScroll+resize"></a>

asscroll.resize([parameters])

Call the internal resize callback.

ParamTypeDescription
[parameters]<code>object</code>
[parameters.width]<code>number</code>Window width
[parameters.height]<code>number</code>Window height

<a name="ASScroll+on"></a>

asscroll.on(eventName, callback)

Add an event listener.

ParamTypeDescription
eventName<code>string</code>Name of the event you wish to listen for
callback<code>function</code>Callback function that should be executed when the event fires

Example (Logs out the scroll position when the 'scroll' event is fired)

asscroll.on('scroll', scrollPos => console.log(scrollPos))

Example (Returns the target scroll position and current scroll position during the internal update loop)

asscroll.on('update', ({ targetPos, currentPos }) => console.log(targetPos, currentPos))

Example (Fires when the lerped scroll position has reached the target position)

asscroll.on('scrollEnd', scrollPos => console.log(scrollPos))

<a name="ASScroll+off"></a>

asscroll.off(eventName, callback)

Remove an event listener.

ParamTypeDescription
eventName<code>string</code>Name of the event
callback<code>function</code>Callback function

<a name="ASScroll+scrollTo"></a>

asscroll.scrollTo(targetPos, [emitEvent])

Scroll to a given position on the page.

ParamTypeDefaultDescription
targetPos<code>number</code>Target scroll position
[emitEvent]<code>boolean</code><code>true</code>Whether to emit the external scroll events or not

<a name="ASScroll+onRaf"></a>

asscroll.onRaf()

Deprecated

See: update
<a name="ASScroll+onResize"></a>

asscroll.onResize()

Deprecated

See: resize

Custom Scrollbar

When customScrollbar is enabled in the options, a default set of styles will get added to the page that match the following HTML:

<div class="asscrollbar"><div class="asscrollbar__handle"><div></div></div></div>

This HTML will get added to your page automatically if you don't add it yourself.

You can change the classes that are used by changing the scrollbarEl and scrollbarHandleEl options.

You can use your own styles by setting the scrollbarStyles option to false.

āš  Note: These styles are added via JS so will only be applied after JS has loaded. This may cause the native scrollbar to show for a moment before the styles are added resulting in a jump of the page.

You can include the styles necessary to hide the native scrollbar in your CSS by copy and pasting the contents of /css/index.css or simply by importing them into your CSS setup. For example:

@import '~@ashthornton/asscroll/css'

Usage with external requestAnimationFrame

Multiple requestAnimationFrame loops causes a significant impact on performance, so ASScroll provides the option to disable its internal rAF loop in order for you to update it yourself externally.

const asscroll = new ASScroll({
    disableRaf: true
})

// Regular RAF loop
requestAnimationFrame(onRaf)
function onRaf() {
    asscroll.update()
    requestAnimationFrame(onRaf)
}

// Or use with GSAP's internal RAF
gsap.ticker.add(asscroll.update)

Usage with external window resize

You may already have a window resize listener in your project where you get the window size for other components. Rather than let ASScroll access these window properties during its internal resize event, which causes extra browser calculations, you can pass your own values.

const asscroll = new ASScroll({
    disableResize: true
})

window.addEventListener('resize', () => {
    // trigger other resize logic
    const width = window.innerWidth
    const height = window.innerHeight
    asscroll.resize({ width, height })
})

Touch Devices

ASScroll provides three options for handling itself on touch devices via the touchScrollType option:

The scrollTop option is primarily used for syncing WebGL content to the scroll position on mobile, without overriding the native inertia scroll. Some CSS will be injected automatically when this option is enabled. This CSS can be found here.

touchScrollType: transform will also achieve DOM and WebGL content sync but is more expensive.

Changelog

View Changelog

Verified on Openbase