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-multilayer-page-reveal

v2.2.2

Published

React component that adds multi-layer page transitions using CSS Animations

Downloads

75

Readme

React Multi-Layer Page Reveal

A React component that adds multi-layer page transitions using CSS Animations. Inspired by Multi-Layer Page Reveal Effects by Codrops. Original repo: https://github.com/codrops/PageRevealEffects

Documentation

Documentation

Installation

  npm install react-multilayer-page-reveal

Usage/Examples

Basic Usage

Wrap your components inside MultiLayerPageRevealProvider component

import React from 'react';
import { MultiLayerPageRevealProvider } from 'react-multilayer-page-reveal';
import { MyComponent } from './MyComponent';

function App() {
  return (
    <MultiLayerPageRevealProvider preset="duo-move" direction="left">
      <MyComponent />
    </MultiLayerPageRevealProvider>
  );
}

Start the animation by calling reveal() function from useMultiLayerPageReveal hook

function MyComponent() {
  const { reveal } = useMultiLayerPageReveal();

  function handleReveal() {
    reveal();
  }

  return (
    <>
      <h1>Hello world</h1>
      <button onClick={handleReveal}>Go</button>
    </>
  );
}

Call a function when animation starts or ends

To call a function when animation starts, use onStart prop, or use onEnd to call a function when animation ends.

function App() {
  function onStart() {
    console.log('animation starts');
  }

  function onEnd() {
    console.log('animation ends');
  }

  return (
    <MultiLayerPageRevealProvider
      preset="duo-move"
      direction="left"
      onStart={onStart}
      onEnd={onEnd}
    >
      <MyComponent />
    </MultiLayerPageRevealProvider>
  );
}

Start the animation with a callback and delay

function MyComponent() {
    ...
    function handleReveal() {
        reveal(() => {
            console.log('hello')
        }, 750);
    }
    ...
    <button onClick={handleReveal}>Go</button>
}

Props

preset (simple | duo-move | triple-woosh |content-move)

Default: simple

Presets of the animation style


direction (left | right | top | bottom | cornerTopLeft | cornerTopRight | cornerBottomLeft | cornerBottomRight)

Default: right

Direction from which the animation moves


onStart (Function)

Callback function when animation starts


onEnd (Function)

Callback function when animation ends


layerColors (string[])

Color(s) for the layers, e.g: ['#fff', '#ddd'].

simple preset requires 1 color, duo-move requires 2 colors, tripe-woosh and content-move require 3 colors.

If no layer colors provided, these default colors will be applied:

simple: ['#202023']

duo-move: ['#202023', '#3d4a41']

triple-woosh: ['#0092dd', '#fff', '#3e3a35'],

content-move: ['#202023', '#555', '#d1d1d1']

Contributing

Pull requests are warmly welcomed. However, for significant changes, kindly initiate an issue beforehand to engage in discussion about the proposed changes.