Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 3.71 KB

README.md

File metadata and controls

93 lines (67 loc) · 3.71 KB
Raw

Unmaintained. See notice below

react-turn-reveal

npm (scoped) CircleCI CodeCov LGTM DeepScan grade js-standard-style standard-readme compliant PRs Welcome

A 3D reveal animation library for React.

This project started when I thought I could pull something I made into a package easily. However, during the development, I started to take it on as a challenge to create the most comprehensive development environment I could. After a long time, I finally published the project. All was well.

However, a year later, I wanted to update to docz 2, since this would resolve various issues I had ran into and improve the documentation. My progress can be viewed on the feature/docz-2 branch, but apparently I have also created dependency hell with my comprehensive development environment.

As much as I would like to fix it, I have better things to do with my time. Feel free to take over the project if you want. There is surprisingly little actual code :)

Install

npm install --save react-turn-reveal

Usage

See the interactive documentation for demonstrative usage examples.

TurnReveal

import TurnReveal, { Direction, Pose } from "react-turn-reveal";

const perspective = 400;

const YourComponent = () => (
  <div style={{ position: "relative", perspective: perspective + "px" }}>
    <TurnReveal
      pose={Pose.closed}
      direction={Direction.right}
      perspective={perspective}
    >
      <div>Lorem ipsum</div>
    </TurnReveal>
    <img src="background.png" alt="background" />
  </div>
);

FollowReveal

import FollowReveal from "react-turn-reveal";

const perspective = 400;

const YourComponent = (
  <div style={{ position: "relative", perspective: perspective + "px" }}>
    <FollowReveal perspective={perspective}>
      <div>Lorem ipsum</div>
    </FollowReveal>
    <img src="background.png" alt="background" />
  </div>
);

Acknowledgements

Adapted from https://codepen.io/noeldelgado/pen/pGwFx

Limitations

  • Special perspective styling (like `perspective-origin) is not taken into account. (PR's for this are welcome)
  • A separate element is needed to catch mouse events and measure the size of the animated component. In order to allow multiple reveals to use the same perspective container any layout styling applied to the animated element has to be duplicated for the separate elements with the className prop. It is still possible to use one perspective container per animated component and put these in the desired layout, which doesn't require passing the className for that layout. (See the FollowReveal Grid example)

Contributing

See CONTRIBUTING.md

License

GNU GPL v3.0 © cdfa