@types/react-custom-scrollbars

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/v3.

index.d.ts

// Type definitions for react-custom-scrollbars 3.0
// Project: https://github.com/malte-wessel/react-custom-scrollbars
// Definitions by: David-LeBlanc-git <https://github.com/David-LeBlanc-git>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.8

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.StatelessComponent<any> | undefined;
    renderTrackHorizontal?: React.StatelessComponent<any> | undefined;
    renderTrackVertical?: React.StatelessComponent<any> | undefined;
    renderThumbHorizontal?: React.StatelessComponent<any> | undefined;
    renderThumbVertical?: React.StatelessComponent<any> | undefined;

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

    thumbSize?: number | undefined;
    thumbMinSize?: number | undefined;
    universal?: boolean | 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;
    getWidth(): number;
    getHeight(): number;
    getValues(): positionValues;
}

export default Scrollbars;

Additional Details

• Last updated: Wed, 07 Jul 2021 17:33:39 GMT
• Dependencies: @types/react
• Global values: ReactCustomScrollbars

Credits

These definitions were written by David-LeBlanc-git.