DefinitelyTyped/types/react-virtualized/ScrollSync.d.ts

import { PureComponent, Validator, Requireable } from 'react'

export type OnScrollParams = {
    clientHeight: number,
    clientWidth: number,
    scrollHeight: number,
    scrollLeft: number,
    scrollTop: number,
    scrollWidth: number
}

export type ScrollSyncChildProps = {
    clientHeight: number,
    clientWidth: number,
    onScroll: (params: OnScrollParams) => void,
    scrollHeight: number,
    scrollLeft: number,
    scrollTop: number,
    scrollWidth: number
}

export type ScrollSyncProps = {
    children?: (props: ScrollSyncChildProps) => React.ReactNode
};

export type ScrollSyncState = {
    clientHeight: number,
    clientWidth: number,
    scrollHeight: number,
    scrollLeft: number,
    scrollTop: number,
    scrollWidth: number
};

/**
 * HOC that simplifies the process of synchronizing scrolling between two or more virtualized components.
 */
export class ScrollSync extends PureComponent<ScrollSyncProps, ScrollSyncState> {
    static propTypes: {
        /**
         * Function responsible for rendering 2 or more virtualized components.
         * This function should implement the following signature:
         * ({ onScroll, scrollLeft, scrollTop }) => PropTypes.element
         */
        children: Validator<(props: ScrollSyncChildProps) => React.ReactNode>
    };

    constructor(props: ScrollSyncProps, context: any);

    render(): JSX.Element;
}