react-scroll-element

Documentation & Demo

Documentation and demo can be found here

Table of Contents

• Installation
• Description
  • Parameter naming
• Setup
• Development
  • Linting
  • Testing
• How To Contribute
  • Bots used
• License

Installation

With yarn

yarn add react-scroll-element

or with npm

npm install react-scroll-element

Setup

Import

import ScrollElement from 'react-scroll-element';

Development

Linting

yarn lib:lint

Testing

yarn lib:test

jest is used for as the testing framework.

How to Contribute

1. Clone repo and create a new branch:

git checkout https://github.com/crisboarna/react-scroll-element -b name_for_new_branch`.

2. Make changes and test
3. Submit Pull Request with comprehensive description of changes

Bots used

To facilitate development the following bots are integrated into the repository:

1. Request Info
2. Semantic Pull Requests
3. Welcome
4. Snyk
5. Todo

License

Full license details can be found in LICENSE.md