Overlayscrollbars-react NPM

OverlayScrollbars for React

This is the official OverlayScrollbars React wrapper.

Installation

npm install overlayscrollbars-react

Peer Dependencies

OverlayScrollbars for React has the following peer dependencies:

The vanilla JavaScript library: overlayscrollbars

npm install overlayscrollbars

The React framework: react

npm install react

Usage

The first step is to import the CSS file into your app:

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:

import { OverlayScrollbarsComponent } from "overlayscrollbars-react";

// ...

<OverlayScrollbarsComponent defer>
  example content
</OverlayScrollbarsComponent>

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.

// example usage
<OverlayScrollbarsComponent
  element="span"
  options={{ scrollbars: { autoHide: 'scroll' } }}
  events={{ scroll: () => { /* ... */ } }}
  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:

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 <div ref={ref} />
}

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.