react-infinite/typelib/component/react_infinite_types.js

A browser-ready efficient scrolling container based on UITableView

import type React from 'react';

type PreloadType = number | {|
  type: string,
  amount: number
|};
type ElementHeight = number | Array<number>;

type CSSStyle = {[key: string]: string | number};

type ReactInfiniteUtilityFunctions = {
  getLoadingSpinnerHeight: () => number,
  subscribeToScrollListener: () => void,
  unsubscribeFromScrollListener: () => void,
  nodeScrollListener: (e: SyntheticEvent) => void,
  getScrollTop: () => number,
  setScrollTop: (top: number) => void,
  scrollShouldBeIgnored: (e: SyntheticEvent) => boolean,
  buildScrollableStyle: () => CSSStyle
};

type ReactInfiniteProvidedDefaultProps = {
  handleScroll: () => any,

  useWindowAsScrollContainer: boolean,

  onInfiniteLoad: () => any,
  loadingSpinnerDelegate: React.Element<any, any, any>,

  displayBottomUpwards: boolean,

  isInfiniteLoading: boolean,
  timeScrollStateLastsForAfterUserScrolls: number,

  className: string,

  styles: {
    scrollableStyle?: Object
  }
}

type ReactInfiniteProps = {
  children: any,
  handleScroll?: (event: any) => any,

  preloadBatchSize?: PreloadType,
  preloadAdditionalHeight?: PreloadType,

  elementHeight: ElementHeight,
  containerHeight?: number,
  useWindowAsScrollContainer?: boolean,

  displayBottomUpwards: boolean,

  infiniteLoadBeginEdgeOffset?: number,
  onInfiniteLoad?: () => any,
  loadingSpinnerDelegate?: React.Element<any, any, any>,

  isInfiniteLoading?: boolean,
  timeScrollStateLastsForAfterUserScrolls?: number,

  className?: string,

  styles: {
    scrollableStyle?: CSSStyle
  }
};

type ReactInfiniteComputedProps = {
  children: any,
  handleScroll: (event: any) => any,

  preloadBatchSize: number,
  preloadAdditionalHeight: number,

  elementHeight: ElementHeight,
  containerHeight: number,
  useWindowAsScrollContainer?: boolean,

  displayBottomUpwards: boolean,

  infiniteLoadBeginEdgeOffset?: number,
  onInfiniteLoad: () => any,
  loadingSpinnerDelegate?: React.Element<*>,

  isInfiniteLoading?: boolean,
  timeScrollStateLastsForAfterUserScrolls?: number,

  className?: string,
  styles: {
    scrollableStyle?: CSSStyle
  }
};

type ReactInfiniteState = {
  numberOfChildren: number,
  infiniteComputer: InfiniteComputer,
  isInfiniteLoading: boolean,
  preloadBatchSize: number,
  preloadAdditionalHeight: number,
  displayIndexStart: number,
  displayIndexEnd: number,
  isScrolling?: boolean,
  scrollTimeout?: any
};