npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@brybrant/fade-scroll

v1.0.1

Published

Fade Scroll is a cosmetic module which adds subtle gradient masks to the overflow of scrollable content.

Downloads

11

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

brybrantbrybrant

Keywords

FadeScrollFadeScrollGradientMask

Readme

Fade Scroll

Fade Scroll is a cosmetic module which adds subtle gradient masks to the overflow of scrollable content.

See the demo page for an interactive demonstration.

Install

$ npm i @brybrant/fade-scroll

Setup

<html>
  <head>
    <link rel='stylesheet' href='fade-scroll.css'/>
  </head>
  <body>
    <div id='horizontal'>
      <p>Some horizontal overflowing content...</p>
    </div>

    <div id='vertical'>
      <p>Some vertical overflowing content...</p>
    </div>

    <script type='module' src='index.js'></script>
  </body>
</html>

See fade-scroll.css for the Fade Scroll styles.

// index.js
import * as FadeScroll from '@brybrant/fade-scroll';

// Basic usage
const horizontal = new FadeScroll.Horizontal('#horizontal').mount();

// Set options
const vertical = new FadeScroll.Vertical('#vertical', {
  hideScrollbar: true,
}).mount();

// Change options
horizontal.options.captureWheel = true;
vertical.options.hideScrollbar = true;

// Destroy
horizontal.destroy();
vertical.destroy();

API

The constructor function takes two arguments:

  1. element — Required

    HTMLElement or querySelector string (this will be the content of the Fade Scroller)
    ▪ Type: HTMLElement | String

  2. options — Optional

    Fade Scroller options object
    ▪ Type: Object

...and returns a Fade Scroller:

Fade Scroller Properties:

  • content

    The element selected in the first argument of the constructor function
    ▪ Type: HTMLElement
    ▪ Access: Read

  • scrollBar

    The element with overflow (contains content element)
    ▪ Type: HTMLDivElement
    ▪ Access: Read

  • wrapper

    The outer element (contains scrollBar element)
    ▪ Type: HTMLDivElement
    ▪ Access: Read

  • contentSize

    The size of the content element (in pixels)
    ▪ Type: Number
    ▪ Access: Read | Horizontal | Vertical | |------------|----------| |offsetWidth|offsetHeight|

  • wrapperSize

    The size of the wrapper element (in pixels)
    ▪ Type: Number
    ▪ Access: Read | Horizontal | Vertical | |------------|----------| |offsetWidth|offsetHeight|

  • overflowSize

    The size of the overflow (contentSize minus wrapperSize)
    ▪ Type: Number
    ▪ Access: Read

  • scrollPosition

    The scroll position of the scrollBar element (in pixels)
    ▪ Type: Number
    ▪ Access: Read / Write | Horizontal | Vertical | |------------|----------| |scrollLeft|scrollTop|

  • options

    The Fade Scroller options:
    ▪ Type: Object

    • hideScrollbar
      Hide the scrollbar?
      ▪ Type: Boolean
      ▪ Default: false
      ▪ Access: Read / Write

    • captureWheel (Horizontal only)
      Capture wheel events and translate to horizontal scroll movement?
      ▪ Type: Boolean
      ▪ Default: false
      ▪ Access: Read / Write

Fade Scroller Methods:

  • mount()

    Starts observing the Fade Scroller elements to apply the correct classes when the sizes change

  • destroy()

    Stops observing the Fade Scroller elements and removes built-in event listeners and styles

  • addScrollListener( callback: EventListener )

    Add a scroll EventListener to the scrollBar element

  • removeScrollListener( callback: EventListener )

    Remove a scroll EventListener from the scrollBar element

Browser Compatibility

Fade Scroll uses CSS masks to blend seamlessly with any background, however the CSS can be changed to use linear gradients for better compatibility if the background is a solid color.

Fade Scroll uses the Resize Observer API to apply the correct styles when the elements sizes change. You can Ponyfill for unsupporting browsers by using the setResizeObserver function:

import { ResizeObserver as Polyfill } from '@juggle/resize-observer';

import * as FadeScroll from '@brybrant/fade-scroll';

FadeScroll.setResizeObserver(Polyfill);

// Create some Fade Scrollers after setting the polyfill...