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

scroll-vibe

v0.1.1

Published

> A tool for any framework that simplifies working with scroll animations - 💡 Intuitive - 🦾 Type Safe - 📦 Extremely light - 🔧 Framework-agnostic

Downloads

13

Readme

ScrollVibe

A tool for any framework that simplifies working with scroll animations

  • 💡 Intuitive
  • 🦾 Type Safe
  • 📦 Extremely light
  • 🔧 Framework-agnostic

Installation

npm install scroll-vibe

Usage

html
<main class="example-page">
    <section class="example-section-1">1</section>
    <section class="example-section-2">2</section>
    <section class="example-section-3">3</section>
    <section class="example-section">4</section>
</main>

<style>
    .example-section {
        height: 500vh;
    }
</style>
javascript
import { ScrollVibe } from 'scroll-vibe'

const scrollVibeRoot = new ScrollVibe('.page')

// Or

const page = document.querySelector('.page')

const scrollVibeRoot = new ScrollVibe(page)
Handle root events
const scrollVibeRoot = new ScrollVibe('.page')

// data: { scrollY: number, oldScrollY: number, direction: "up" | "down"}
scrollVibeRoot.on('scroll', (data) => {
    console.log(data) 
})

// data: ResizeObserverEntry[]
scrollVibeRoot.on('resize', (data) => {
    console.log(data)
})
Handle child events
const scrollVibeChild = new ScrollVibeChild('.example-section-1')

// const data = {
//     prgogress: number - shows how much the block is scrolled (as a percentage)
//     properties: {
//         start: number - the upper point of the block relative to the page (in pixels)
//         end: number - the lower point of the block relative to the page (in pixels)
//         height: number - block height (in pixels)
//         padding: {
//             top: number - the upper indentation before the start of the scroll progress
//             bottom: number - lower indentation after full scrolling of the block
//         }
//     }
// }
scrollVibeChild.on('progressChange', (data) => {
    console.log(data)
})
Setting paddings (in pixels, percentage of height, vh)
<main class="page">
    <section class="section section_1" data-sv-padding-top="200px">1</section>
    <section class="section section_2" data-sv-padding-bottom="10%">2</section>
    <section class="section section_3" data-sv-padding-bottom="5vh">3</section>
    <section class="section section_4">4</section>
</main>
Using the progress value in css
<style>
    .section_1 {
        opacity: calc(var(--sv-progress) / 100);
    }
</style>
Removing handlers when leaving the page
const scrollVibeRoot = new ScrollVibe('.page')

scrollVibeRoot.destroy()
Recalculation if necessary (if the recalculation did not work for some reason)
const scrollVibeRoot = new ScrollVibe('.page')

scrollVibeRoot.recalc()
Exceptions that are not needed for calculations
<main class="page">
    <div></
    <section class="section section_1">1</section>
    <section class="section section_2">2</section>
    <section class="section section_3">3</section>
    <section class="section section_4">4</section>

    <div class="up-button" data-sv-exception="true">
        <button>up</button>
    </div>
</main>