npm install react-parallax --save
# or
yarn add react-parallax
import React from 'react';
import { Parallax, Background } from 'react-parallax';
const MyComponent = () => (
<div>
{/* -----basic config-----*/}
<Parallax
blur={10}
bgImage={require('path/to/image.jpg')}
bgImageAlt="the cat"
strength={200}
>
Put some text content here - even an empty div with fixed dimensions to have a height
for the parallax.
<div style={{ height: '200px' }} />
</Parallax>
{/* -----dynamic blur-----*/}
<Parallax
blur={{ min: -15, max: 15 }}
bgImage={require('path/to/another/image.jpg')}
bgImageAlt="the dog"
strength={-200}
>
Blur transition from min to max
<div style={{ height: '200px' }} />
</Parallax>
{/* -----custom background element-----*/}
<Parallax strength={300}>
<div>Use the background component for custom elements</div>
<Background className="custom-bg">
<img src="http://www.fillmurray.com/500/320" alt="fill murray" />
</Background>
</Parallax>
{/* -----renderProp: "renderLayer"-----*/}
<Parallax
bgImage={'/path/to/another/image'}
strength={400}
renderLayer={percentage => (
<div
style={{
position: 'absolute',
background: `rgba(255, 125, 0, ${percentage * 1})`,
left: '50%',
top: '50%',
width: percentage * 500,
height: percentage * 500,
}}
/>
)}
>
<p>... Content</p>
</Parallax>
</div>
);
export default MyComponent;
For more flexibility and styling purposes you can add a <Background></Background>
section to your Parallax Container. Child nodes inside this Background will be positioned like the bgImage behind the other children. Compared to the bgImage there is no automatic scaling (see above).
path to the background image that makes parallax effect visible - (type: String)
alt text for bgImage - (type: String)
img sizes
attribute
img srcset
attribute
style object for the component itself - (type: Object)
additional style object for the bg image/children - (type: Object) Valid style attributes
custom classname for image - (type: String)
custom classname for parallax inner - (type: String) - default: 'react-parallax-content'
set bgImage width manually - (type: String), eg. '400px', 'auto'
set bgImage height manually - (type: String), eg. '400px', 'auto'
parallax effect strength (in pixel), default 100. this will define the amount of pixels the background image is translated - (type: Number)
- pixel value for background image blur, default: 0 - (type: Number)
- or object in format
{min:0, max:5}
for dynamic blur depending on scroll position
Function that gets a percentage value of the current position as parameter for custom calculationa. It renders a layer above the actual background, below children
. Implement like renderLayer={percentage => (<div style={{ background:`rgba(255, 125, 0, ${percentage * 1})`}}/> )}
- (type: Function)
turns off parallax effect if set to true, default: false - (type: Boolean)
set an additional className - (type: String)
set optional parent for nested scrolling, default: document - (type: Node)
for development, turns console.log on/off - (type: Boolean)
... used to display any content inside the react-parallax component
Initial set up, run:
npm install / yarn
Development, live reload, JSX transpiling, run:
npm run dev
Port 3000 on all OS by default. Can be set with option -port=8080
MIT