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

mg-react-scrollspy

v1.0.9

Published

Scroll reveal by css transition props only

Downloads

4

Readme

mg-react-scrollspy

Description

This is a scrollspy wrapper for react components

Usage

import {ScrollSpy, TriggerMode } from "mg-react-scrollspy";
import {
  animationNames,
  animationTypes,
  createAnimatedComponent,
} from "./lib/animation";

const Card = function (props) {
  return <div style={props.style}>{props.name}</div>;
};

const Spied = createAnimatedComponent(() => (
  <Card style={{ color: "blue" }} name='Spied Card'/>
));

ReactDOM.render(
  <ScrollSpy
        render={({triggerIn, triggerOut, scrollMode}) => { console.log("scrollMode", scrollMode); return (
          <Spied
            duration={2}
            delay={1}
            type={animationTypes.ENTRANCE}
            name={animationNames.TOP}
            start={triggerOut}
          />
        )}}
        triggerMode={TriggerMode.BOTH}
      />,
  document.getElementById("root")
);

API

The api is simple

  1. Props

    1. render : function

    this is the function which is called to render the coponent you want to spy for scroll event it is called with the following object

    {triggerIn, triggerOut, scrollMode}
    1. triggerMode

    to indicate when you intend to trigger an action

    triggerMode = TriggerMode.IN // trigger when scrolling down and the coponent is gets into the viewport
    triggerMode = TriggerMode.OUT // trigger when scrolling up and the component is getting out of the viewport
    // default is 'in'
    1. thresholdDown

    this is the threshold in pixel to trigger when scrolling down default is 15

    Note. Strings are not valid here. only int e.g '10px' is invalid 10 is valid
    1. thresholdUp

    this is the threshold in pixel to trigger when scrolling up default is 15

    Note. Strings are not valid here. only int e.g '10px' is invalid 10 is valid