# overlayscrollbars-react
> OverlayScrollbars for React.
Latest version **0.5.6** (published 2024-04-01) · MIT license · 0 weekly downloads
## Install
```sh
npm install overlayscrollbars-react
pnpm add overlayscrollbars-react
yarn add overlayscrollbars-react
bun add overlayscrollbars-react
```
## Health
**Score 35/100 (D)** — status: abandoned.
Positive: has types; esm support; no vulnerabilities.
Warnings: low downloads; pre 1.0.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 0.5.6 |
| Published | 2024-04-01 |
| First published | 2019-08-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 80.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5200 |
| Author | Rene Haas \| KingSora |
| Maintainers | kingsora |
| Keywords | overlayscrollbars, react, component, hook, hooks, styleable, custom, scrollbar, scrollbars, scroll |
## Links
- npm: https://www.npmjs.com/package/overlayscrollbars-react
- Repository: https://github.com/KingSora/OverlayScrollbars
- Homepage: https://kingsora.github.io/OverlayScrollbars
- Issues: https://github.com/KingSora/OverlayScrollbars/issues
- npm.io page: https://npm.io/package/overlayscrollbars-react
## Alternatives
- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads
## Recent versions
- 0.5.6 (latest) — 2024-04-01
- 0.5.5 — 2024-03-26
- 0.5.4 — 2024-01-24
- 0.5.3 — 2023-10-15
- 0.5.2 — 2023-08-25
- 0.5.1 — 2023-07-09
- 0.5.0 — 2022-11-16
- 0.4.0 — 2022-11-12
- 0.3.0 — 2022-06-01
- 0.2.3 — 2021-06-30
- 0.2.2 — 2020-04-05
- 0.2.1 — 2019-12-30
- 0.2.0 — 2019-10-11
- 0.1.0 — 2019-08-03
## README
[](https://github.com/KingSora/OverlayScrollbars)
[](https://github.com/facebook/react/)
[](https://www.npmjs.com/package/overlayscrollbars-react)
[](https://www.npmjs.com/package/overlayscrollbars-react)
[](#)
# OverlayScrollbars for React
This is the official OverlayScrollbars React wrapper.
## Installation
```sh
npm install overlayscrollbars-react
```
## Peer Dependencies
OverlayScrollbars for React has the following **peer dependencies**:
- The vanilla JavaScript library: [overlayscrollbars](https://www.npmjs.com/package/overlayscrollbars)
```
npm install overlayscrollbars
```
- The React framework: [react](https://www.npmjs.com/package/react)
```
npm install react
```
## Usage
The first step is to import the CSS file into your app:
```ts
import 'overlayscrollbars/overlayscrollbars.css';
```
> __Note__: If the path `'overlayscrollbars/overlayscrollbars.css'` is not working use `'overlayscrollbars/styles/overlayscrollbars.css'` as the import path for the CSS file.
## Component
The main entry point is the `OverlayScrollbarsComponent` which can be used in your application as a component:
```jsx
import { OverlayScrollbarsComponent } from "overlayscrollbars-react";
// ...
example content
```
### Properties
The component accepts all properties of regular elements such as `div` and `span`.
Additionally it has custom optional properties:
- `element`: accepts a `string` which represents the tag of the root element.
- `options`: accepts an `object` which represents the OverlayScrollbars options.
- `events`: accepts an `object` which represents the OverlayScrollbars events.
- `defer`: accepts an `boolean` or `object`. Defers the initialization to a point in time when the browser is idle.
> __Note__: None of the properties has to be memoized.
> __Note__: Its **highly recommended** to use the `defer` option whenever possible to defer the initialization to a browser's idle period.
```jsx
// example usage
{ /* ... */ } }}
defer
/>
```
### Ref
The `ref` of the `OverlayScrollbarsComponent` will give you an object with which you can access the OverlayScrollbars `instance` and the root `element` of the component.
The ref object has two properties:
- `osInstance`: a function which returns the OverlayScrollbars instance.
- `getElement`: a function which returns the root element.
## Hook
In case the `OverlayScrollbarsComponent` is not enough, you can also use the `useOverlayScrollbars` hook:
```jsx
import { useOverlayScrollbars } from "overlayscrollbars-react";
// example usage
const Component = () => {
const ref = useRef();
const [initialize, instance] = useOverlayScrollbars({ options, events, defer });
useEffect(() => {
initialize(ref.current);
}, [initialize]);
return
}
```
The hook is for advanced usage and lets you control the whole initialization process. This is useful if you want to integrate it with other plugins such as `react-window` or `react-virtualized`.
The hook will destroy the instance automatically if the component unmounts.
### Parameters
Parameters are optional and similar to the `OverlayScrollbarsComponent`.
Its an `object` with optional properties:
- `options`: accepts an `object` which represents the OverlayScrollbars options.
- `events`: accepts an `object` which represents the OverlayScrollbars events.
- `defer`: accepts an `boolean` or `object`. Defers the initialization to a point in time when the browser is idle.
### Return
The `useOverlayScrollbars` hook returns a `tuple` with two values:
- The first value is the `initialization` function, it takes one argument which is the `InitializationTarget`.
- The second value is a function which returns the current OverlayScrollbars instance or `null` if not initialized.
> __Note__: The identity of both functions is stable and won't change, thus they can safely be used in any dependency array.
## License
MIT
---
_Source: https://npm.io/package/overlayscrollbars-react · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
