Skip to content
A simple React component to reveal content behind a block using CSS3 animations 🏃💨
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.babelrc
.gitignore
.npmignore
LICENSE
README.md
package.json
yarn.lock

README.md

React Block Reveal Animation

A simple React component to reveal content behind a block using CSS3 animations.

Screenshot

Usage

Install using npm:

$ npm install react-block-reveal-animation --save

Install using yarn:

$ yarn add react-block-reveal-animation

Import react-block-reveal-animation and use it in your component like so:

import React from 'react';
import BlockRevealAnimation from 'react-block-reveal-animation';

const MyComponent = () => (
  <div>
    <BlockRevealAnimation>
      This will be revealed
    </BlockRevealAnimation>
  </div>
);

export default MyComponent;

Options

You can pass props to <BlockRevealAnimation> like so:

<BlockRevealAnimation className="myCustomClassName" delay={2} duration={1} color="#ff0000">
  Children goes here
</BlockRevealAnimation>

Props

All props are optional.

Name Description Default
color The color of the block #000
delay Animation start delay in seconds 1
duration Animation duration in seconds 0.9

Author

Created by Petter Samuelsen. Inspired by Tympanus Block Revealers

The MIT License (MIT)

Copyright © 2018 Petter Samuelsen

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.