@saleae/react-scrollbars-custom/dist/types/types.d.ts

The best React custom scrollbars component

import * as PropTypes from "prop-types";
import * as React from "react";
export declare enum AXIS_DIRECTION {
    X = "x",
    Y = "y"
}
export declare const AXIS_DIRECTION_PROP_TYPE: PropTypes.Requireable<AXIS_DIRECTION>;
export declare enum TRACK_CLICK_BEHAVIOR {
    JUMP = "jump",
    STEP = "step"
}
export declare const TRACK_CLICK_BEHAVIOR_PROP_TYPE: PropTypes.Requireable<TRACK_CLICK_BEHAVIOR>;
export declare type ElementRef<T = HTMLDivElement> = (element: T | null) => void;
export declare type ElementPropsWithElementRef<T = HTMLDivElement> = React.HTMLProps<T> & {
    elementRef?: ElementRef<T>;
};
export declare type ElementRenderer<T = HTMLDivElement> = React.FunctionComponent<ElementPropsWithElementRef<T>>;
export declare type ElementPropsWithElementRefAndRenderer<T = HTMLDivElement> = React.HTMLProps<T> & {
    elementRef?: ElementRef<T>;
    renderer?: ElementRenderer<T>;
};
/**
 * @description Contains all scroll-related values
 */
export declare type ScrollState = {
    /**
     * @description Scroller's native clientHeight parameter
     */
    clientHeight: number;
    /**
     * @description Scroller's native clientWidth parameter
     */
    clientWidth: number;
    /**
     * @description Content's scroll height
     */
    contentScrollHeight: number;
    /**
     * @description Content's scroll width
     */
    contentScrollWidth: number;
    /**
     * @description Scroller's native scrollHeight parameter
     */
    scrollHeight: number;
    /**
     * @description Scroller's native scrollWidth parameter
     */
    scrollWidth: number;
    /**
     * @description Scroller's native scrollTop parameter
     */
    scrollTop: number;
    /**
     * @description Scroller's native scrollLeft parameter
     */
    scrollLeft: number;
    /**
     * @description Indicates whether vertical scroll blocked via properties
     */
    scrollYBlocked: boolean;
    /**
     * @description Indicates whether horizontal scroll blocked via properties
     */
    scrollXBlocked: boolean;
    /**
     * @description Indicates whether the content overflows vertically and scrolling not blocked
     */
    scrollYPossible: boolean;
    /**
     * @description Indicates whether the content overflows horizontally and scrolling not blocked
     */
    scrollXPossible: boolean;
    /**
     * @description Indicates whether vertical track is visible
     */
    trackYVisible: boolean;
    /**
     * @description Indicates whether horizontal track is visible
     */
    trackXVisible: boolean;
    /**
     * @description Indicates whether display direction is right-to-left
     */
    isRTL?: boolean;
    /**
     * @description Pages zoom level - it affects scrollbars
     */
    zoomLevel: number;
};