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

react-just-parallax

v3.1.16

Published

React library for scroll and mousemove parallax effect ✨ Open source, production-ready

Downloads

7,929

Readme

React Just Parallax is an open source, production-ready library that's designed for all creative developers and more.

  • Written in TypeScript
  • Super lightweight
  • Easy to use
  • blazing fast

📦 NPM Link

📜 Examples

⚖️ License

  • React Just Parallax is MIT licensed.

✍🏻 Author

🐇 Quick start

npm install react-just-parallax
import { MouseParallax, ScrollParallax } from "react-just-parallax";

export const MyComponent = () => (
  <>
    <MouseParallax>
      <p>I'm reacting to mouse move</p>
    </MouseParallax>

    <ScrollParallax>
      <p>I'm reacting to scroll</p>
    </ScrollParallax>
  </>
);

Props for MouseParallax

| Name | Type | Default | Description | | ---------------------- | ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | strength | number | 0.14 | Parallax offset multiplier. Moving mouse by 10 pixels will move element position by 10px * strength | | lerpEase | number | 0.06 | Determines how quick the interpolation between offset values occurs (the higher the quicker) | | isAbsolutelyPositioned | boolean | false | If the element you want to use parallax on is positioned absolutely, set this prop to true | | zIndex | number | null | null | Specify element's outer container z-index (useful while using isAbsolutelyPositioned prop) | | shouldPause | boolean | true | Stops element from reacting to scroll and interpolating offset if it is out of view | | enableOnTouchDevice | boolean | false | Turns on/off parallax effect on touch devices | | scrollContainerRef | React.MutableRefObject | null | null | Use when element is situated in scrollable element other than window | | parallaxContainerRef | React.MutableRefObject | null | null | By default, element reacts to mousemove on window. You can specify any other container using this prop to make element react only within given container | | shouldResetPosition | boolean | false | Resets element's position if cursor leaves window or leaves parallaxContainerRef |

Props for ScrollParallax

| Name | Type | Default | Description | | ---------------------- | ------------------------------ | ------- | ------------------------------------------------------------------------------------------------- | | strength | number | 0.14 | Parallax offset multiplier. Scrolling by 10 pixels will move element position by 10px * strength | | lerpEase | number | 0.06 | Determines how quick the interpolation between offset values occurs (the higher the quicker) | | isAbsolutelyPositioned | boolean | false | If the element you want to use parallax on is positioned absolutely, set this prop to true | | zIndex | number | null | null | Specify element's outer container z-index (useful while using isAbsolutelyPositioned prop) | | shouldPause | boolean | true | Stops element from reacting to scroll and interpolating offset if it is out of view | | enableOnTouchDevice | boolean | true | Turns on/off parallax effect on touch devices | | isHorizontal | boolean | false | Enable if using horizontal scrolling | | scrollContainerRef | React.MutableRefObject | null | null | Use when element is situated in scrollable element other than window |

Recalculating values on demand for ScrollParallax

It's sometimes necessary to update values such as element's position or sizes on demand, for example if the DOM structure changes.

Library can't know of this kind of changes so it is not able to handle it by itself, and that's when we need to use ScrollParallaxHandle to update them manually.

import { ScrollParallax, ScrollParallaxHandle } from "react-just-parallax";

export const MyComponent = () => {
  const [display, setDisplay] = useState(true);
  const scrollParallaxRef = useRef<ScrollParallaxHandle | null>(null);

  useEffect(() => {
    scrollParallaxRef.current?.updateValues();
  }, [display]);

  return (
    <>
      <ScrollParallax ref={scrollParallaxRef}>
        <p>I'm reacting to scroll</p>
      </ScrollParallax>

      {display && (
        <button onClick={() => setDisplay((false)}>
          Disappear me
        </button>
      )}
    </>
  );
};