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

canvas-scroll-clip

v1.3.2

Published

Canvas based image sequence scroll animation. Zero dependencies.

Downloads

354

Readme

Canvas Scroll Clip

Build Status Storybook

Canvas Scroll Clip is a standalone JavaScript micro-library for a fancy scroll based image sequence animation in canvas. There is no third party dependencies.

Install

yarn add canvas-scroll-clip
npm install --save canvas-scroll-clip

Usage

Initialize Canvas Scroll Clip on an element with options:

import CanvasScrollClip from "canvas-scroll-clip";

new CanvasScrollClip(document.querySelector('.element'), {
  framePath: "{url_of_first_frame_in_a_sequence}",
  frameCount: 101,
  scrollArea: 2000
})

require('...').default

When importing a module using require use .default const CanvasScrollClip = require('canvas-scroll-clip').default. Decided to stick with pure ES6 module semantics and keep the code generation as clean as possible.

Options

Options object is required and takes these parameters:

framePath (required)

Type: String URL of first image of a sequence.

Important note: Sequence should start with leading 0, minimum 2 digits and at the end of the name. for example: https://<URL>/frame_0001.jpg.

frameCount (required)

Type: Number Number of in total in a sequence.

scrollArea (recommended)

Type: Number Default: 2x the IMAGE height

Scrollable area height that is used to play the image sequence.

identifier

Type: String Used for container and child element css classes.

Events

viewport.scroll

Callback params: scrollTop Type: Number

Event is triggered with scroll event. Returns scrollTop position.

Usage

CanvasScrollClip.events.on('viewport.scroll', function(scrollTop){
  console.log(scrollTop);
});

viewport.resize

Event is triggerent on window resize.

Usage

CanvasScrollClip.events.on('viewport.resize', function(){
  console.log("window resized");
});

images.loaded

Event is triggered after all images preloaded. Good place to implement loader animation.

Usage

CanvasScrollClip.events.on('images.loaded', function() {
  console.log("images.loaded");
});

images.progress

Callback params (object): total: frameCount loaded: loadedImageCount

Event is triggered after every image preloaded. Good place to implement progress bar.

Usage

CanvasScrollClip.events.on('images.progress', function(progress) {
  console.log(progress);
});

License

MIT license

Esbuild and UMD pending feature

Pending esbuild UMD format feature --format=umd support.