https://github.com/jmadankumar/react-scrollup-lite

React wrapper component to scroll up
https://github.com/jmadankumar/react-scrollup-lite

component package react scrollup

Last synced: 5 months ago
JSON representation

React wrapper component to scroll up

• Host: GitHub
• URL: https://github.com/jmadankumar/react-scrollup-lite
• Owner: jmadankumar
• Created: 2020-07-17T16:13:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-02-08T23:02:28.000Z (over 3 years ago)
• Last Synced: 2025-10-27T06:55:09.001Z (8 months ago)
• Topics: component, package, react, scrollup
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/react-scrollup-lite
• Size: 1.51 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
# react-scrollup-lite

> React wrapper component to scroll up/top when user scrolls the page

[![NPM](https://img.shields.io/npm/v/react-scrollup-lite.svg)](https://www.npmjs.com/package/react-scrollup-lite) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash

npm install --save react-scrollup-lite

```

## Usage

```jsx

import React, { Component } from 'react';

import ScrollUp from 'react-scrollup-lite';

class Example extends Component {

    render() {

        return (

            

                Scroll up

            

        );

    }

}

```

## Proptypes

| Props               | Type   | Description                                                                   |

| ------------------- | ------ | ----------------------------------------------------------------------------- |

| startPosition       | number | start position to scroll up                                                   |

| showAtPosition      | number | when scrolling the page at what position component children should be visible |

| position (optional) | string | left or right (where to show the children component) (default - right)        |

## License

MIT © [Madan Kumar](https://github.com/jmadankumar)