@maxweek/react-scroller

React-scroller

Make your blocks scrolling easy, with a custom scroll-bar, based on native browser scroll

How to install

npm i @maxweek/react-scroller

Usage

import Scroller from "@maxweek/react-scroller";

<Scroller
  needBar={true}
  barAltPosition={false}
  horizontal={false}
  grab={true}
  borderFade={true}
  borderPadding={true}
  grabCursor={true}
  className={'your-scroller-class'}
  barClassName={'your-scroller-bar-class'}
  barRollerClassName={'your-scroller-bar-roller-class'}
  contentClassName={'your-scroller-content-class'}
>
  {/* Your content */}
</Scroller>

Props

PropName	Type	Default	Description
children	ReactNode		React child
needBar?	boolean	false	enables scrollbar
barAltPosition?	boolean	false	changes scrollbar position, default at right - changes to left, when horizontal enabled - changes bottom to top
horizontal?	boolean	false	makes your box scrolling horizontal
grab?	boolean	false	enables grabbing your scroll content
borderFade?	boolean	false	add fadding in directions of scroll by masking
borderPadding?	boolean	false	add padding in directions of scroll
grabCursor?	boolean	false	enables grab cursor on hover
className?	string	false	class for scroller box
barClassName?	string	false	class for scrollbar
barRollerClassName?	string	false	class for scrollbar roller
contentClassName?	string	false	class for content wrapper

License

• React Scroll is licensed under the MIT License. Explore this to understand terms and conditions of the license- https://opensource.org/licenses/MIT

Thank you for using my package! Max Nedelko