react-skrollr

1.0.4 • Public • Published

React Skrollr

npm version

React Component parallax scrolling JavaScript library base on Skrollr

See live demo

Getting Started

$ npm install --save react-skrollr

Import package

import { ParallaxProvider, Parallax } from 'react-skrollr'

Init config (Optional)

Use init config via props init (props type is object)

Skrollr init Options

Add ParallaxProvider into root app

class App extends React.Component {
  render() {
    return (
      <ParallaxProvider
        init={{
          smoothScrollingDuration: 500,
          smoothScrolling: true,
          forceHeight: false
        }}
      >
      ...
      </>
    )
  }
}

Setting parallax data (Required)

Use data scrolling via props data (props type is object)

Skrollr Data attr document

const Component = () => {
  return (
    <Parallax
      data={{
        'data-center-center': 'opacity: 1;',
        'data-bottom-top': 'opacity: 0;'
      }}
    >Some content</Parallax>
  )
}

Example use

  class App extends React.Component {
    render() {
      return (
        <ParallaxProvider>
          <Parallax
            data={{
              'data-center-center': 'opacity: 1;',
              'data-bottom-top': 'opacity: 0;'
            }}
          >
            Some content or Component
          </Parallax>
        </ParallaxProvider>
      );
    }
  }

Thank you for your suggestions!

Package Sidebar

Install

npm i react-skrollr

Weekly Downloads

219

Version

1.0.4

License

MIT

Unpacked Size

10.9 kB

Total Files

7

Last publish

Collaborators

  • ga-mo