# SimplebarReact
- **🐦 Follow me on [Twitter!](https://twitter.com/adriendenat) or [Mastodon!](https://mas.to/@adrien)**
- **👨💻 I'm available for hire! [Reach out to me!](https://adriendenat.com/)**
- **🚧 Check out my new project [Scroll Snap Carousel](https://github.com/Grsmto/scroll-snap-carousel)!**
### Installation
**- Via npm**
`npm install simplebar-react --save`
**- Via Yarn**
`yarn add simplebar-react`
### Usage
Check out the [Demo project](https://github.com/Grsmto/simplebar/blob/master/examples/react/src/App.js) or our live [Codesandbox example](https://codesandbox.io/s/simplebar-react-gwgyw).
If you are using a module loader (like Webpack) you first need to load SimpleBar:
```js
import SimpleBar from 'simplebar-react';
import 'simplebar-react/dist/simplebar.min.css';
const App = () => (
// your content
);
```
**Don't forget to import both css and js in your project!**
### :warning: Warning!
SimpleBar is **not intended to be used on the `body` element!** I don't recommend wrapping your entire web page inside a custom scroll as it will often badly affect the user experience (slower scroll performance compared to the native body scroll, no native scroll behaviours like click on track, etc.). Do it at your own risk! SimpleBar is meant to improve the experience of **internal web page scrolling**; such as a chat box or a small scrolling area. **Please read the [caveats](#5-caveats) section first to be aware of the limitations!**
### Troubleshooting
If you are experiencing issues when setting up SimpleBar, it is most likely because your styles are clashing with SimpleBar ones. Make sure the element you are setting SimpleBar on does not override any SimpleBar css properties! **We recommend to not style that element at all and use an inner element instead.**
### Sponsors
Thanks to BrowserStack for sponsoring open source projects and letting us test SimpleBar for free.
1. [Documentation](#1-documentation)
## 1. Documentation
### Passing options
Find the list of available options on [the core documentation](https://github.com/Grsmto/simplebar/blob/master/packages/simplebar/README.md#options).
```js
// your content
```
### Extra options
#### scrollableNodeProps
You can pass props to the underlying scrollable `div` element. This is useful for example to get a `ref` of it, if you want to access the `scroll` event or apply imperative directive (like scrolling SimpleBar to the bottom, etc.).
```js
const scrollableNodeRef = React.createRef();
// your content
;
```
### Accessing SimpleBar instance
You can pass a ref to the SimpleBar element:
```js
const ref = useRef();
useEffect(() => {
ref.current.recalculate();
console.log(ref.current.el); // <- the root element you applied SimpleBar on
})
// your content
```
### Usage with 3rd party libraries
For advanced usage, in some cases (like using react-window) you can forward the scrollable and content elements using a render prop pattern:
```js
{({ scrollableNodeRef, contentNodeRef }) => {
// Now you have access to scrollable and content nodes
return ;
}}
```
If you define your own elements you should do:
```js
{({ scrollableNodeProps, contentNodeProps }) => {
return (
outer/scrollable element
inner element