A sticky view with scroll listener API for parallax style views

A sticky view with scroll listener API for parallax style views

This is the contributor documentation for the react-stickyroll mono-repository.

A sticky view with scroll listener API for parallax style views.

Stickyroll

Stickyroll logo

Site | Getting started | Live support | Typedoc

Are you looking for a Vue.js version?
Check out Vue Stickyroll.

MIT license Getting started Code of Conduct Say Thanks

Build status Test Coverage Code Quality Vulnerabilities

Powered by

Browserstack

This is the contributor documentation for the react-stickyroll mono-repository. For user docs see Getting started

Core Packages

version description
stickyroll The core component and listener
stickyroll decorators Decorators for plugins and smart components
stickyroll utils Utilities to build plugins

Styled Components

version description
stickyroll inner A themed inner frame (made for pagers)
stickyroll pagers Themed pagers (made for inner)
stickyroll themes A collection of themes to select and combine

Contribute to Stickyroll

Please read our contributing guide

git clone https://github.com/stickyroll/react-stickyroll.git
cd react-stickyroll
yarn
yarn dev

# Test your changes
yarn test
# scoped tests
yarn lerna run test --scope @stickyroll/<package_name>

Develop guides (via patternplate)

yarn patternplate:dev

License

Copyright by Gregor Adams. All @stickyroll packages are released under the MIT license.

Github Repository

Tags: #React #Scroll