Need help with react-parallax?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

rrutsche
509 Stars 55 Forks MIT License 339 Commits 5 Opened issues

Description

A React Component for parallax effect

Services available

!
?

Need anything else?

Contributors list

react-parallax NPM version

Install

yarn add react-parallax

Demo on codesandbox

Contribute

If you find any bug or have problems and/or ideas regarding this library feel free to open an issue or pull request. Either way please create a working example so I can reproduce it. Link to a repository or even easier - fork the demo codesandbox project. This would help a lot.

This project is maintained during evenings and weekends. If you like it, please consider to buy me a coffee ;-) ...or contribute in other ways.

Usage examples

Basic - background image with fixed blur effect

import { Parallax } from 'react-parallax';

const Container = () => ( Content goes here. Parallax height grows with content height. );

Dynamic blur and negative strength for reverse direction

import { Parallax, Background } from 'react-parallax';

const Container = () => ( Blur transition from min to max

);

Custom background element

Use the background component for custom elements. Unlike the

bgImage
this one will not be scaled depending on the parent/window width.
import { Parallax, Background } from 'react-parallax';

const Container = () => ( fill murray );

Render prop

Calculate your own stuff depending on the

percentage
value.
import { Parallax, Background } from 'react-parallax';

const Container = () => ( (

)} >

... Content

);

Background Component

Child nodes inside this Background will be positioned like the bgImage behind the other children. Unlike the bgImage there is no automatic scaling.

Props

| Name | Type | Default | Description | example | | --------------------- | :-----------: | :-----------------------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------------------------------------------------------------------ | | bgImage |

String
| | path to the background image that makes parallax effect | | | bgImageAlt |
String
| | alt text for bgImage. | | | bgImageSize |
String
| | img
sizes
attribute. | | | bgImageSrcSet |
String
| | img
srcset
attribute | | | style |
Object
| | style object for the component itself | | | bgStyle |
Object
| | additional style object for the bg image/children Valid style attributes | | | bgClassName |
String
| | custom classname for image | | | contentClassName |
String
|
react-parallax-content
| custom classname for parallax inner | | | bgImageStyle |
Object
| | set background image styling |
{height: '50px', maxWidth: '75px', opacity: '.5'}
| | strength |
Number
|
100
| parallax effect strength (in pixel). this will define the amount of pixels the background image is translated | | | blur |
Number
|
0
or
{min:0, max:5}
| number value for background image blur or object in format
{min:0, max:5}
for dynamic blur depending on scroll position | | | renderLayer |
Function
| | 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
. |
renderLayer={percentage => (
)}
| | disabled |
Booleam
|
false
| turns off parallax effect if set to true |
{height: '50px', maxWidth: '75px', opacity: '.5'}
| | className |
String
| | set an additional className | | | parents |
Node
|
document
| set optional parent for nested scrolling | | | children | | | used to display any content inside the react-parallax component | |

Development

# setup
yarn
# Development, live reload, JSX transpiling, run:
yarn dev

Port

3000
on all OS by default. Can be set with option -port=8080

License

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.