Website   •   Examples

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.

Note: The identity of both functions is stable and won't change, thus they can safely be used in any dependency array.

License

MIT

Changelog

0.5.6

Improvements

• The OverlayScrollbarsComponent now properly supports 'body' as its element tag.

0.5.5

Improvements

• Improve the type definitions with the usage of the ElementType type instead of the JSX namespace of the @types/react package in order to improve compatibility to older react versions.

0.5.4

Improvements

• Adapt the exports field in the package.json for correct commonjs and module handling.

0.5.3

Bug Fixes

• Make sure component is stateless and children won't update more often than needed. (#565)

0.5.2

• Improve Server Side Rendering behavior by creating additional markup only on the client with the hydration phase.
• Improve deferred initialization where the time between created markup and actual initialization is masked with CSS.

0.5.1

• The package.json has now an appropriate exports field to optimize builds in modern bundlers.

0.5.0

Features

Added the possibility to defer the initialization to a point in time when the browser is idle. (or to the next frame if window.requestIdleCallback is not supported)

• OverlayScrollbarsComponent accepts now the defer property
• useOverlayScrollbars params accept now the defer property
• useOverlayScrollbars will now always try to destroy the instance if the component unmounts.

Breaking Changes

• Because initialization can be deferred now, the initialize function of the useOverlayScrollbars hook isn't returning the instance anymore. Use the instance function of the useOverlayScrollbars hook instead.

0.4.0

Depends on OverlayScrollbars version ^2.0.0 and React version >=16.8.0.
The component was rewritten using hooks. (#218)

Features

• OverlayScrollbarsComponent accepts now the events property
• OverlayScrollbarsComponent accepts now the element property
• The useOverlayScrollbars hook was added for advanced usage

Breaking Changes

• The extensions property is removed from OverlayScrollbarsComponent
• The osTarget() function from the OverlayScrollbarsComponent ref is renamed to getElement()