GitXplorerGitXplorer
k

react-atv-img

public
309 stars
29 forks
4 issues

Commits

List of commits on branch master.
Unverified
6360ed9a0965aa43ab2929497439c2088cb4fd3b

Merge pull request #4 from NeXTs/patch-1

kkeyz committed 8 years ago
Unverified
1c4b9377967b675204796495bbe9ba2463d9b934

Fixes #3

NNeXTs committed 8 years ago
Unverified
5a1346bf85b9572662a9d3dd4b61cb52d88dd2ef

look ma, no requires

kkeyz committed 9 years ago
Unverified
a501bcd849f35e6542a87ce679ccc7c64231004e

fixed a typo in .npmignore

kkeyz committed 9 years ago
Unverified
ec104b027ec9a6902211f02cd5cec87f94cd97c6

added a gif

kkeyz committed 9 years ago
Unverified
33129e738e84c04e7e38cd5bf106f9ff72525a01

Update README.md

kkeyz committed 9 years ago

README

The README file for this repository.

react-atv-img

A port of @drewwilson’s amazing atvImg (Apple TV 3D parallax effect) library in React. It supports both touch and mouse events.

Install

npm install --save react-atv-img

Demo

http://keyanzhang.github.io/react-atv-img

GIF

Or run it locally:

git clone https://github.com/keyanzhang/react-atv-img/
cd react-atv-img
npm install
npm run example

Then navigate to http://localhost:3000/

API

Props

static propTypes = {
  layers: PropTypes.arrayOf(PropTypes.string).isRequired,
  isStatic: PropTypes.bool,
  staticFallback: PropTypes.string,
  className: PropTypes.string,
  style: PropTypes.object,
};

Data

  • layers: Required. An array of image URLs. The images will be stacked on top of each other and the last element will be at the top.
  • isStatic: Optional. A boolean value. When it evaluates to true, it disables the parallax effect, and shows the flattened image (staticFallback) instead.
  • staticFallback: Optional. A flattened image that contains all the layers.

Styling: use the following options to set up the width/height of the entire component

  • className: Optional.
  • style: Optional.

Example

import AtvImg from 'react-atv-img';

<AtvImg
  layers={[
    'http://kloc.pm/images/back.png',
    'http://kloc.pm/images/front.png',
  ]}
  staticFallback="http://kloc.pm/images/kloc-icon-flattened.jpg"
  isStatic={false}
  className={'thisIsOptional'}
  style={{ width: 320, height: 190 }}
/>

License

MIT