Skip to content

Deep-Codes/scroll-indicator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

5 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation


Logo

๐ŸŒˆ Showcase

Logo

ScrollIndicator that Just Works. Use it with only 2lines of Code. ๐Ÿ˜

<ScrollIndicator bgColor='red' height='20px' />

Tried and Tested on NextJS , React , CRA.

๐Ÿš€ Getting Started

Make sure you have node installed.

To install the Package

npm install scroll-indicator

this package needs react & react-dom as peerDependencies so make sure you got them Installed.

๐Ÿ“– Documentation

To Import the Component:

import ScrollIndicator from 'scroll-indicator';

Props To Pass in the Component:

Property Default Type
height 10px String
bgColor gray String
<ScrollIndicator bgColor='red' height='20px' />

More Feature Will be Added Soon. If you need some Feel Free to Open an Issue.

๐Ÿ—Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

๐Ÿ“š License

Distributed under the MIT License. See LICENSE for more information.

๐Ÿ˜‡ Contact

Twitter - @DeepankarBhade

๐Ÿ“– Acknowledgements