@dreamsparkx/parallax
Advanced tools
Comparing version 2.0.11 to 2.0.12
{ | ||
"name": "@dreamsparkx/parallax", | ||
"version": "2.0.11", | ||
"version": "2.0.12", | ||
"main": "build/index.js", | ||
@@ -54,8 +54,8 @@ "module": "build/index.esm.js", | ||
"@rollup/plugin-commonjs": "^17.0.0", | ||
"@rollup/plugin-image": "^2.0.5", | ||
"@rollup/plugin-node-resolve": "^11.0.0", | ||
"@storybook/addon-actions": "^6.1.10", | ||
"@storybook/addon-essentials": "^6.1.10", | ||
"@rollup/plugin-image": "^2.0.6", | ||
"@rollup/plugin-node-resolve": "^11.0.1", | ||
"@storybook/addon-actions": "^6.1.11", | ||
"@storybook/addon-essentials": "^6.1.11", | ||
"@storybook/addon-links": "^6.1.10", | ||
"@storybook/react": "^6.1.10", | ||
"@storybook/react": "^6.1.11", | ||
"@storybook/storybook-deployer": "^2.8.7", | ||
@@ -68,5 +68,5 @@ "@testing-library/jest-dom": "^5.11.6", | ||
"@types/storybook__react": "^5.2.1", | ||
"@types/styled-components": "^5.1.4", | ||
"@types/styled-components": "^5.1.7", | ||
"@typescript-eslint/eslint-plugin": "^4.9.1", | ||
"@typescript-eslint/parser": "^4.9.1", | ||
"@typescript-eslint/parser": "^4.11.0", | ||
"babel-loader": "^8.2.2", | ||
@@ -80,3 +80,3 @@ "babel-preset-react-app": "^10.0.0", | ||
"eslint-plugin-react": "^7.21.5", | ||
"husky": "^4.3.5", | ||
"husky": "^4.3.6", | ||
"identity-obj-proxy": "^3.0.0", | ||
@@ -99,3 +99,3 @@ "jest": "^26.6.3", | ||
"ts-jest": "^26.4.4", | ||
"typescript": "^4.1.2" | ||
"typescript": "^4.1.3" | ||
}, | ||
@@ -102,0 +102,0 @@ "husky": { |
# apple-tv-parallax | ||
[](https://david-dm.org/dreamsparkx/apple-tv-parallax) [](https://app.fossa.com/projects/git%2Bgithub.com%2Fdreamsparkx%2Fapple-tv-parallax?ref=badge_shield) | ||
[](https://github.com/semantic-release/semantic-release)   | ||
[](https://github.com/semantic-release/semantic-release)  [](https://www.npmjs.com/package/@dreamsparkx/parallax) | ||
<!-- [](https://circleci.com/gh/dreamsparkx/apple-tv-parallax) --> | ||
Live Demo: https://dreamsparkx.github.io/apple-tv-parallax/ | ||
## Install | ||
`npm i @dreamsparkx/parallax` | ||
@@ -14,23 +16,19 @@ | ||
| Step | Description | | ||
|-------------------|---------------------------------------------------------------------------------------------------------------------------------| | ||
| layers | The images will be stacked on top of each other and the last element/image will be at the top. | | ||
| isStatic | When you pass `true`, it disables the parallex effect, and shows the flattened image instead. (optional) | | ||
| style | Pass on css properties (optional) | | ||
| className | Pass on className (optional). | | ||
| Step | Description | | ||
| --------- | -------------------------------------------------------------------------------------------------------- | | ||
| layers | The images will be stacked on top of each other and the last element/image will be at the top. | | ||
| isStatic | When you pass `true`, it disables the parallex effect, and shows the flattened image instead. (optional) | | ||
| style | Pass on css properties (optional) | | ||
| className | Pass on className (optional). | | ||
## Example | ||
``` javascript | ||
```javascript | ||
import { Parallax } from '@dreamsparkx/parallax'; | ||
<Parallex | ||
layers={[ | ||
'/assets/images/back.png', | ||
'/assets/images/front.png', | ||
]} | ||
isStatic={false} | ||
style={{ flex: 0.21, height: 100, textAlign: 'center' }} | ||
/> | ||
layers={['/assets/images/back.png', '/assets/images/front.png']} | ||
isStatic={false} | ||
style={{ flex: 0.21, height: 100, textAlign: 'center' }} | ||
/>; | ||
``` | ||
@@ -40,4 +38,4 @@ | ||
## License | ||
## License | ||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdreamsparkx%2Fapple-tv-parallax?ref=badge_large) | ||
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fdreamsparkx%2Fapple-tv-parallax?ref=badge_large) |
464801
40