# react-custom-scrollbars-4

> React scrollbars component

Latest version **4.5.1** (published 2025-02-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-custom-scrollbars-4
pnpm add react-custom-scrollbars-4
yarn add react-custom-scrollbars-4
bun add react-custom-scrollbars-4
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.5.1 |
| Published | 2025-02-14 |
| First published | 2025-02-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 193 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Sebastian Barrenechea |
| Maintainers | barrenechea |
| Keywords | scroll, scroller, scrollbars, react-component, react, custom |

## Links

- npm: https://www.npmjs.com/package/react-custom-scrollbars-4
- Repository: https://github.com/barrenechea/react-custom-scrollbars-4
- Issues: https://github.com/barrenechea/react-custom-scrollbars-4/issues
- npm.io page: https://npm.io/package/react-custom-scrollbars-4

## Dependencies (3)

- [raf](https://npm.io/package/raf.md) ^3.1.0
- [dom-css](https://npm.io/package/dom-css.md) ^2.0.0
- [prop-types](https://npm.io/package/prop-types.md) ^15.5.10

## 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

- 4.5.1 (latest) — 2025-02-14

## README

# react-custom-scrollbars-4

[![npm](https://img.shields.io/badge/npm-react--custom--scrollbars--4-brightgreen.svg?style=flat-square)]()
[![npm version](https://img.shields.io/npm/v/react-custom-scrollbars-4.svg?style=flat-square)](https://www.npmjs.com/package/react-custom-scrollbars-4)
[![npm downloads](https://img.shields.io/npm/dm/react-custom-scrollbars-4.svg?style=flat-square)](https://www.npmjs.com/package/react-custom-scrollbars-4)

- frictionless native browser scrolling
- native scrollbars for mobile devices
- [fully customizable](https://github.com/barrenechea/react-custom-scrollbars-4/blob/master/docs/customization.md)
- [auto hide](https://github.com/barrenechea/react-custom-scrollbars-4/blob/master/docs/usage.md#auto-hide)
- [auto height](https://github.com/barrenechea/react-custom-scrollbars-4/blob/master/docs/usage.md#auto-height)
- [universal](https://github.com/barrenechea/react-custom-scrollbars-4/blob/master/docs/usage.md#universal-rendering) (runs on client & server)
- `requestAnimationFrame` for 60fps
- no extra stylesheets
- well tested, 100% code coverage

**[Demos](https://robpethick.github.io/react-custom-scrollbars-2/) · [Documentation](https://github.com/barrenechea/react-custom-scrollbars-4/tree/master/docs)**

## Quick note

This repo is due to both the original [`react-custom-scrollbars`](https://www.npmjs.com/package/react-custom-scrollbars) and [`react-custom-scrollbars-2`](https://www.npmjs.com/package/react-custom-scrollbars-2) packages being stale. Initially to add React 19 support, this fork aims to modernize it in every way, while keeping the original APIs intact.

## Installation

```bash
npm install react-custom-scrollbars-4 --save
```

This assumes that you’re using [npm](http://npmjs.com/) package manager with a module bundler like [Webpack](http://webpack.github.io) or [Browserify](http://browserify.org/) to consume [CommonJS modules](http://webpack.github.io/docs/commonjs.html).

If you don’t yet use [npm](http://npmjs.com/) or a modern module bundler, and would rather prefer a single-file [UMD](https://github.com/umdjs/umd) build that makes `ReactCustomScrollbars` available as a global object, you can grab a pre-built version from [unpkg](https://unpkg.com/react-custom-scrollbars-4@4.5.1/dist/react-custom-scrollbars.js). We _don’t_ recommend this approach for any serious application, as most of the libraries complementary to `react-custom-scrollbars-4` are only available on [npm](http://npmjs.com/).

## Usage

This is the minimal configuration. [Check out the Documentation for advanced usage](https://github.com/barrenechea/react-custom-scrollbars-4/tree/master/docs).

```javascript
import { Scrollbars } from "react-custom-scrollbars-4";

class App extends Component {
  render() {
    return (
      <Scrollbars style={{ width: 500, height: 300 }}>
        <p>Some great content...</p>
      </Scrollbars>
    );
  }
}
```

The `<Scrollbars>` component is completely customizable. Check out the following code:

```javascript
import { Scrollbars } from 'react-custom-scrollbars-4';

class CustomScrollbars extends Component {
  render() {
    return (
      <Scrollbars
        onScroll={this.handleScroll}
        onScrollFrame={this.handleScrollFrame}
        onScrollStart={this.handleScrollStart}
        onScrollStop={this.handleScrollStop}
        onUpdate={this.handleUpdate}
        renderView={this.renderView}
        renderTrackHorizontal={this.renderTrackHorizontal}
        renderTrackVertical={this.renderTrackVertical}
        renderThumbHorizontal={this.renderThumbHorizontal}
        renderThumbVertical={this.renderThumbVertical}
        autoHide
        autoHideTimeout={1000}
        autoHideDuration={200}
        autoHeight
        autoHeightMin={0}
        autoHeightMax={200}
        thumbMinSize={30}
        universal={true}
        {...this.props}>
    );
  }
}
```

All properties are documented in the [API docs](https://github.com/barrenechea/react-custom-scrollbars-4/blob/master/docs/API.md)

## Examples

Run the simple example:

```bash
# Make sure that you've installed the dependencies
npm install
# Move to example directory
cd react-custom-scrollbars-4/examples/simple
npm install
npm start
```

## Tests

```bash
# Make sure that you've installed the dependencies
npm install
# Run tests
npm test
```

### Code Coverage

```bash
# Run code coverage. Results can be found in `./coverage`
npm run test:cov
```

## License

MIT

---
_Source: https://npm.io/package/react-custom-scrollbars-4 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._