# @types/react-custom-scrollbars

> TypeScript definitions for react-custom-scrollbars

Latest version **4.0.13** (published 2023-12-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/react-custom-scrollbars
pnpm add @types/react-custom-scrollbars
yarn add @types/react-custom-scrollbars
bun add @types/react-custom-scrollbars
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 4.0.13 |
| Published | 2023-12-12 |
| First published | 2017-02-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51432 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/react-custom-scrollbars
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-custom-scrollbars
- npm.io page: https://npm.io/package/@types/react-custom-scrollbars

## Dependencies (1)

- [@types/react](https://npm.io/package/@types/react.md) *

## Recent versions

- 4.0.13 (latest) — 2023-12-12
- 4.0.12 (ts4.5) — 2023-11-07
- 4.0.10 (ts3.8) — 2021-12-24
- 4.0.9 (ts3.7) — 2021-10-20
- 4.0.8 (ts3.6) — 2021-07-07
- 4.0.7 (ts3.0) — 2020-08-12
- 4.0.6 (ts2.8) — 2019-08-13
- 4.0.4 (ts2.6) — 2018-06-29
- 4.0.1 (ts2.3) — 2017-06-23
- 4.0.0 (ts2.1) — 2017-05-04
- 3.0.11 — 2023-12-12
- 3.0.10 — 2023-11-07
- 3.0.9 — 2023-10-18
- 4.0.11 — 2023-10-18
- 3.0.8 — 2021-12-24
- … 12 more at https://npm.io/package/@types/react-custom-scrollbars/versions

## README

# Installation
> `npm install --save @types/react-custom-scrollbars`

# Summary
This package contains type definitions for react-custom-scrollbars (https://github.com/malte-wessel/react-custom-scrollbars).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-custom-scrollbars.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-custom-scrollbars/index.d.ts)
````ts
import * as React from "react";

export as namespace ReactCustomScrollbars;

export interface positionValues {
    top: number;
    left: number;
    clientWidth: number;
    clientHeight: number;
    scrollWidth: number;
    scrollHeight: number;
    scrollLeft: number;
    scrollTop: number;
}

export interface ScrollbarProps extends React.HTMLProps<Scrollbars> {
    onScroll?: React.UIEventHandler<any> | undefined;
    onScrollFrame?: ((values: positionValues) => void) | undefined;
    onScrollStart?: (() => void) | undefined;
    onScrollStop?: (() => void) | undefined;
    onUpdate?: ((values: positionValues) => void) | undefined;

    renderView?: React.FunctionComponent<any> | undefined;
    renderTrackHorizontal?: React.FunctionComponent<any> | undefined;
    renderTrackVertical?: React.FunctionComponent<any> | undefined;
    renderThumbHorizontal?: React.FunctionComponent<any> | undefined;
    renderThumbVertical?: React.FunctionComponent<any> | undefined;

    tagName?: string | undefined;
    hideTracksWhenNotNeeded?: boolean | undefined;

    autoHide?: boolean | undefined;
    autoHideTimeout?: number | undefined;
    autoHideDuration?: number | undefined;

    thumbSize?: number | undefined;
    thumbMinSize?: number | undefined;
    universal?: boolean | undefined;

    autoHeight?: boolean | undefined;
    autoHeightMin?: number | string | undefined;
    autoHeightMax?: number | string | undefined;

    style?: React.CSSProperties | undefined;
}

export class Scrollbars extends React.Component<ScrollbarProps> {
    scrollTop(top: number): void;
    scrollLeft(left: number): void;
    scrollToTop(): void;
    scrollToBottom(): void;
    scrollToLeft(): void;
    scrollToRight(): void;
    getScrollLeft(): number;
    getScrollTop(): number;
    getScrollWidth(): number;
    getScrollHeight(): number;
    getClientWidth(): number;
    getClientHeight(): number;
    getValues(): positionValues;
}

export default Scrollbars;

````

### Additional Details
 * Last updated: Tue, 12 Dec 2023 19:06:50 GMT
 * Dependencies: [@types/react](https://npmjs.com/package/@types/react)

# Credits
These definitions were written by [kittimiyo](https://github.com/kittimiyo).

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