https://github.com/nitesh9001/scroller

A react component library for react Js which provides a UI and scroll to top method
https://github.com/nitesh9001/scroller

Last synced: 9 days ago
JSON representation

A react component library for react Js which provides a UI and scroll to top method

• Host: GitHub
• URL: https://github.com/nitesh9001/scroller
• Owner: nitesh9001
• Created: 2020-09-05T12:40:30.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-05T19:18:16.000Z (about 4 years ago)
• Last Synced: 2024-10-19T05:43:38.263Z (about 1 month ago)
• Language: JavaScript
• Size: 532 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# scroller

> Scoller UI and Scroll to top function 

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

## Install

```bash

npm install --save @nitesh2020/scroller

```

## Usage

```jsx

import React, { Component } from 'react'

import {Scroller} from 'scroller'

// If you want to use animation then import css//

import 'scroller/dist/index.css'

class Example extends Component {

  var objectScroll={

      backgroundColor: 'blue' ,

      color: 'white',

      borderRadius: '40',

      right: '30',

      onhover: 'orange',

      shadowColor: 'black',

  }

  render() {

    return 

  }

}

```

## DataType

 ```

/-----------------------------------------------------------------------------------------------------------\

|                     |                                                 |                                   |

|     Prop Name       |                     Use                         |               Type                |

|_____________________|_________________________________________________|___________________________________|

| backgroundColor     |   Add background Color to scrollTop btn         |  hex, rbga , rbg , name           |

| color               |   Define color for arrow in scrollTop btn       |  hex, rbga , rbg , name           |

| shadowColor         |   Define color of sahdow in scrollTop btn       |  hex, rbga , rbg , name           |

| onHover             |   Define color on mouse hover on scrollTop btn  |  hex, rbga , rbg , name           |

| right               |   Give indentation from right side (in px)      |  numeric value                    |

| borderRadius        |   Provide border radius to button  (in px)      |  numeric value                    |

\-----------------------------------------------------------------------------------------------------------/

 ```

## License

MIT © [nitesh9001](https://github.com/nitesh9001)