@phntms/reveal-on-scroll
TypeScript icon, indicating that this package has built-in type declarations

0.1.3 • Public • Published

reveal-on-scroll

NPM version Actions Status PR Welcome

Lightweight library to reveal elements on scroll.

Also SSR safe and won't break build if pre-rendered.

Installation

Install this package with npm.

npm i @phntms/reveal-on-scroll

Usage

To use, initialize a new RevealOnScroll() component.

import RevealOnScroll from "@phntms/reveal-on-scroll";

new RevealOnScroll();

// Or...

new RevealOnScroll({
  /**
   * If multiple elements are visible at same time, this defines the delay
   * before showing next element.
   *
   * Set to 0 to remove default stagger.
   */
  delayBetweenQueuedElements: 150,

  // Threshold of element that has to be in view, before revealing element
  thresholdToRevealElements: 0.2,

  // Used to querySelectAll with the following
  revealSelector: ".reveal-on-scroll",

  // Class added to element when revealed
  visibleClass: "reveal-scrolled",

  // If used alongside revealSelector, ignores reveal events till removed
  hiddenClass: "reveal-hidden",
});

Then to use, simply add the reveal-on-scroll class to any HTMLElement. For example:

<div class="reveal-on-scroll"></div>

Additionally use reveal-hidden to prevent elements being revealed till ready, for example the following won't be revealed until reveal-hidden is removed:

<div class="reveal-on-scroll reveal-hidden"></div>

🍪 Recipes:

The library works by adding reveal-scrolled to any reveal-on-scroll elements.

To animate, simply hook into this with any custom CSS, for example:

.reveal-on-scroll {
  opacity: 0;
  transform: translateY(32px);
  transition: opacity 0.8s, transform 0.6s;
  transition-timing-function: cubic-bezier(0.3, 1, 0.7, 1);

  &.reveal-scrolled {
    opacity: 1;
    transform: translateY(0);
  }
}

Browser Support

This library utilizes intersectionObserver, as such browser support is pretty good (par IE11 and below), for more information check caniuse. For fallback, reveal-scrolled is automatically added to all reveal-on-scroll elements to ensure older browsers still reveal content.

If you need reveal-on-scroll to work on any browser that doesn't support intersectionObserver consider using a polyfill such as - intersection-observer.

🍰 Contributing

Want to get involved, or found an issue? Please contribute using the GitHub Flow. Create a branch, add commits, and open a Pull Request or submit a new issue.

Please read CONTRIBUTING for details on our CODE_OF_CONDUCT, and the process for submitting pull requests to us!

Package Sidebar

Install

npm i @phntms/reveal-on-scroll

Weekly Downloads

25

Version

0.1.3

License

MIT

Unpacked Size

34 kB

Total Files

33

Last publish

Collaborators

  • digitaljohn