https://github.com/dreamsparkx/parallex-image

Parallex Image is a port of atvImg library in react. It gives you Apple TV 3D parallex effect.
https://github.com/dreamsparkx/parallex-image

component parallex react

Last synced: 9 days ago
JSON representation

Parallex Image is a port of atvImg library in react. It gives you Apple TV 3D parallex effect.

• Host: GitHub
• URL: https://github.com/dreamsparkx/parallex-image
• Owner: dreamsparkx
• Created: 2018-03-01T07:42:03.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-03-01T10:20:15.000Z (over 6 years ago)
• Last Synced: 2024-04-29T13:01:52.885Z (7 months ago)
• Topics: component, parallex, react
• Language: JavaScript
• Homepage:
• Size: 31.3 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Parallex-Image

Parallex Image is a port of [atvImg library](https://github.com/drewwilson/atvImg "atvImg library") in react. It gives you Apple TV 3D parallex effect.

## Install

`npm install parallex-image --save`

## API

**Data**

- `layers`: This is required. The images will be stacked on top of each other and the last element will be at the top.

- `isStatic`: This is optional. When you pass `true`, it disables the parallex effect, and shows the flattened image (`staticFallback`) instead.

- `staticFallback`: This is optional. Pass the flattened image that contains all the layers.

## Example

``` javascript

import ParallexImage from 'parallex-image';

```

## License

[MIT](http://spdx.org/licenses/MIT.html "MIT")