bee-tree/src/infiniteScroll.js

/**
 * 处理滚动加载逻辑
 */
import React, { Component } from 'react';
import PropTypes from 'prop-types';
import {throttle} from './util';
import CONFIG from './config';

export default class InfiniteScroll extends Component {
  static propTypes = {
    children: PropTypes.node.isRequired,
    element: PropTypes.node,
    ref: PropTypes.func,
    getScrollParent: PropTypes.func,
    treeList: PropTypes.array,
    handleTreeListChange: PropTypes.func
  };

  static defaultProps = {
    element: 'div',
    ref: null,
    getScrollParent: null,
    treeList: [],
    handleTreeListChange: () => {}
  };

  constructor(props) {
    super(props);

    //默认显示20条，rowsInView根据定高算的。在非固定高下，这个只是一个大概的值。
    this.rowsInView = CONFIG.defaultRowsInView;
    //一维数组
    this.treeList = props.treeList;
    //一次加载多少数据
    this.loadCount = CONFIG.loadBuffer ? this.rowsInView + CONFIG.loadBuffer * 2 : 16; 
    //可视区第一条数据的 index
    this.currentIndex = 0;
    this.startIndex = this.currentIndex; //数据开始位置
    this.endIndex = this.currentIndex + this.loadCount; //数据结束位置
  }

  componentDidMount() {
    this.options = this.eventListenerOptions();
    this.attachScrollListener();
  }

  componentWillReceiveProps(nextProps){
    let {treeList:newTreeList} = nextProps;
    let {treeList:oldTreeList} = this.props;
    if(newTreeList !== oldTreeList) {
      this.treeList = newTreeList;
      this.handleScrollY();
    }
  }

  // componentDidUpdate() {
  //   const el = this.scrollComponent;
  //   const parentNode = this.getParentElement(el);
  //   parentNode.scrollTop = this.scrollTop;
  // };

  componentWillUnmount() {
    this.detachScrollListener();
    this.detachMousewheelListener();
  }

  isPassiveSupported() {
    let passive = false;

    const testOptions = {
      get passive() {
        passive = true;
      }
    };

    try {
      document.addEventListener('test', null, testOptions);
      document.removeEventListener('test', null, testOptions);
    } catch (e) {
      // ignore
    }
    return passive;
  }

  eventListenerOptions = () => {
    let options = this.props.useCapture;

    if (this.isPassiveSupported()) {
      options = {
        useCapture: this.props.useCapture,
        passive: true
      };
    }
    return options;
  }

  /**
   * 解除mousewheel事件监听
   */
  detachMousewheelListener() {
    let scrollEl = window;
    if (this.props.useWindow === false) {
      scrollEl = this.scrollComponent.parentNode;
    }

    scrollEl.removeEventListener(
      'mousewheel',
      this.mousewheelListener,
      this.options ? this.options : this.props.useCapture
    );
  }
  /**
   * 解除scroll事件监听
   */
  detachScrollListener() {
    let scrollEl = window;
    if (this.props.useWindow === false) {
      scrollEl = this.getParentElement(this.scrollComponent);
    }

    scrollEl.removeEventListener(
      'scroll',
      this.scrollListener,
      this.options ? this.options : this.props.useCapture
    );
    scrollEl.removeEventListener(
      'resize',
      this.scrollListener,
      this.options ? this.options : this.props.useCapture
    );
  }
  /**
   * 获取父组件(用户自定义父组件或者当前dom的parentNode)
   * @param {*} el 
   */
  getParentElement(el) {
    const scrollParent =
      this.props.getScrollParent && this.props.getScrollParent();
    if (scrollParent != null) {
      return scrollParent;
    }
    return el && el.parentNode;
  }

  filterProps(props) {
    return props;
  }
  /**
   * 绑定scroll事件
   */
  attachScrollListener() {
    const { store } = this.props;
    const parentElement = this.getParentElement(this.scrollComponent);
    if (!parentElement) {
      return;
    }
    let scrollEl = parentElement;
    let scrollY = scrollEl && scrollEl.clientHeight;
  
    let rowHeight = store.getState().rowHeight; 
    //默认显示20条，rowsInView根据定高算的。
    this.rowsInView = scrollY ? Math.floor(scrollY / rowHeight) : CONFIG.defaultRowsInView;

    scrollEl.addEventListener(
      'scroll',
      throttle(this.scrollListener, 150),
      this.options ? this.options : this.props.useCapture
    );
    scrollEl.addEventListener(
      'resize',
      throttle(this.scrollListener, 150),
      this.options ? this.options : this.props.useCapture
    );
  }

  mousewheelListener = (e) => {
    // Prevents Chrome hangups
    // See: https://stackoverflow.com/questions/47524205/random-high-content-download-time-in-chrome/47684257#47684257
    if (e.deltaY === 1 && !this.isPassiveSupported()) {
      e.preventDefault();
    }
  }
  /**
   * 滚动事件监听
   */
  scrollListener = () => {
    const el = this.scrollComponent;
    const parentNode = this.getParentElement(el);
    this.scrollTop = parentNode.scrollTop;
    this.handleScrollY()
  }

  /**
   * @description 根据返回的scrollTop计算当前的索引。
   */
  handleScrollY = () => {
    const { store } = this.props;
    const parentElement = this.getParentElement(this.scrollComponent);
    if (!parentElement) {
      return;
    }
    let scrollEl = parentElement;
    let scrollY = scrollEl && scrollEl.clientHeight;
  
    let rowHeight = store.getState().rowHeight; 
    //默认显示20条，rowsInView根据定高算的。在非固定高下，这个只是一个大概的值。
    this.rowsInView = scrollY ? Math.floor(scrollY / rowHeight) : CONFIG.defaultRowsInView;

    let currentIndex = this.currentIndex,
        startIndex = this.startIndex,
        endIndex = this.endIndex,
        treeList = this.treeList,
        loadCount = this.loadCount,
        rowsInView = this.rowsInView;

    let index = 0;
    let tempScrollTop = this.scrollTop;
    //根据 scrollTop 计算 currentIndex
    while (tempScrollTop > 0) {
      tempScrollTop -= rowHeight;
      if (tempScrollTop > 0) {
        index += 1;
      }
    }

    //true 为向下滚动， false 为向上滚动
    let isScrollDown = index - currentIndex > 0 ? true : false;

    if (index < 0) index = 0;
    //如果之前的索引和下一次的不一样则重置索引和滚动的位置
    this.currentIndex = currentIndex !== index ? index : currentIndex;

    // 如果rowsInView 小于 缓存的数据则重新render
    // 向下滚动 下临界值超出缓存的endIndex则重新渲染
    if (isScrollDown && rowsInView + index > endIndex - CONFIG.rowDiff) {
      startIndex = index - CONFIG.loadBuffer > 0 ? index - CONFIG.loadBuffer : 0;
      endIndex = startIndex + loadCount;
      if (endIndex > treeList.length) {
        endIndex = treeList.length;
      }
      if (endIndex > this.endIndex ) {
        this.startIndex = startIndex;
        this.endIndex = endIndex;
        this.sliceTreeList(this.startIndex, this.endIndex);
      }
    }
    // 向上滚动，当前的index是否已经加载（currentIndex），若干上临界值小于startIndex则重新渲染
    if (!isScrollDown && index < startIndex + CONFIG.rowDiff) {
      startIndex = index - CONFIG.loadBuffer;
      if (startIndex < 0) {
        startIndex = 0;
      }
      if (startIndex <= this.startIndex) {
        this.startIndex = startIndex;
        this.endIndex = this.startIndex + loadCount;
        this.sliceTreeList(this.startIndex, this.endIndex);
      }
    }
  }

  /**
   * 根据 startIndex 和 endIndex 截取数据
   * @param startIndex
   * @param endIndex
   */
  sliceTreeList = (startIndex, endIndex) => {
    let newTreeList = []; //存储截取后的新数据
    newTreeList = this.treeList.slice(startIndex,endIndex);
    this.props.handleTreeListChange && this.props.handleTreeListChange(newTreeList, startIndex, endIndex);
  }

  render() {
    const {
      children,
      element,
      ref,
      getScrollParent,
      treeList,
      handleTreeListChange,
      store,
      ...props
    } = this.props;

    props.ref = node => {
      this.scrollComponent = node;
      if (ref) {
        ref(node);
      }
    };

    const childrenArray = [children];

    return React.createElement(element, props, childrenArray);
  }
}