React-parlx NPM

react-parlx

parlx.js implementation for React.js component

Demo

How to Use

• Install plugin via favourite package manager:

$ npm install react-parlx
$ yarn add react-parlx

Getting Started

• Import plugin in React.js application file:

import ReactParlx from 'react-parlx';

• Later create parallax component and pass options:

<ReactParlx
  overlay={ /* true/false */ }
  options={ /* options */ }
  styles={ /* CSS styles */ }
  className={ /* class name(s) */ }
  parlxMove={ /* event output destination */ }
/>

You can add components with or without additional content:

with:

<ReactParlx /* options */>
  // additional content
</ReactParlx>

without:

<ReactParlx /* options *//>

Props

Name	Type	Default	Description	Available options
overlay	boolean	`false`	Create overlay for parallax container element	`true` (enable) / `false` (disable)
style	object	`{}`	CSS styles for parallax container	CSS styles
options	object	`{}`	Default parlx.js options	parlx.js options
className	string	`parallax`	Parallax container class name	Name of parallax container