All files / react useLoadMore.ts

97.67% Statements 42/43
86.96% Branches 20/23
100% Functions 7/7
97.67% Lines 42/43

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181                                                                                                                                                                                        69x 69x 69x 69x 69x 69x 69x 69x   69x               69x 13x 13x 13x 13x 10x   13x 13x 13x 13x         13x 13x   13x 10x 10x   3x   3x 3x     3x     13x           69x 4x 4x 3x   1x     69x 10x 10x 10x 10x         69x 7x     69x                          
import {
  DependencyList,
  Dispatch,
  SetStateAction,
  useCallback,
  useEffect,
  useRef,
  useState,
} from 'react'
import { useLatest } from 'react-use'
 
/**
 * 加载服务载荷。
 *
 * @public
 */
export interface UseLoadMoreServicePayload {
  /** 已加载的数据量 */
  offset: number
  /** 当前页码 */
  pageNumber: number
}
 
/**
 * 加载服务结果。
 *
 * @public
 */
export type UseLoadMoreServiceResult<TItem> =
  | TItem[]
  | {
      /** 总数据量 */
      total: number
      /** 当前页数据 */
      data: TItem[]
    }
  | {
      /** 总数据量 */
      total: number
      /** 当前页数据 */
      list: TItem[]
    }
 
/**
 * 加载服务。
 *
 * @public
 */
export interface UseLoadMoreService<TItem> {
  (payload: UseLoadMoreServicePayload): Promise<UseLoadMoreServiceResult<TItem>>
}
 
/**
 * 加载更多结果。
 *
 * @public
 */
export interface UseLoadMoreResult<TItem> {
  /** 当前页码 */
  pageNumber: number
  /** 已加载的数据 */
  data?: TItem[]
  /** 总数据量 */
  total: number
  /** 是否正在加载数据 */
  loading: boolean
  /** 是否正在加载初始数据 */
  initialLoading: boolean
  /** 是否正在加载更多数据 */
  incrementalLoading: boolean
  /** 数据是否已加载完 */
  noMore: boolean
  /** 加载更多数据 */
  loadMore: () => Promise<void>
  /** 从首页重新加载数据 */
  reload: () => Promise<void>
  /** 设置数据 */
  setData: Dispatch<SetStateAction<TItem[]>>
}
 
/**
 * 数据加载。
 *
 * @public
 * @param service 数据加载服务
 * @param deps 依赖若发生变化则从首页重新加载数据
 * @returns 返回结果
 */
export function useLoadMore<TItem>(
  service: UseLoadMoreService<TItem>,
  deps: DependencyList,
): UseLoadMoreResult<TItem> {
  const [data, setData] = useState<TItem[]>([])
  const [pageNumber, setPageNumber] = useState<number>(1)
  const [initialLoading, setInitialLoading] = useState(true)
  const [incrementalLoading, setIncrementalLoading] = useState(false)
  const loading = initialLoading || incrementalLoading
  const [noMore, setNoMore] = useState<boolean>(false)
  const [total, setTotal] = useState<number>(0)
  const firstRef = useRef(true)
 
  const latest = useLatest({
    service,
    data,
    loading,
    pageNumber,
    noMore,
  })
 
  const load = useCallback((nextPageNumber: number): Promise<void> => {
    return new Promise<void>((resolve, reject) => {
      const { data, service } = latest.current
      const isFirstPage = nextPageNumber === 1
      if (isFirstPage) {
        setData([])
      }
      setInitialLoading(isFirstPage)
      setIncrementalLoading(!isFirstPage)
      setPageNumber(nextPageNumber)
      service({
        offset: data.length,
        pageNumber: nextPageNumber,
      })
        .then(res => {
          setInitialLoading(false)
          setIncrementalLoading(false)
 
          if (Array.isArray(res)) {
            setNoMore(res.length === 0)
            setData(isFirstPage ? res : [...data, ...res])
          } else {
            setTotal(res.total)
            const pageData: TItem[] =
              (res as any).data || (res as any).list || []
            setNoMore(
              (isFirstPage ? 0 : data.length) + pageData.length >= res.total,
            )
            setData(isFirstPage ? pageData : [...data, ...pageData])
          }
 
          resolve()
        })
        .catch(reject)
    })
  }, [])
 
  const loadMore = useCallback(() => {
    const { noMore, loading, pageNumber } = latest.current
    if (!noMore && !loading) {
      return load(pageNumber + 1)
    }
    return Promise.resolve()
  }, [])
 
  const reload = useCallback(() => {
    const { loading } = latest.current
    if (firstRef.current || !loading) {
      firstRef.current = false
      return load(1)
    }
    return Promise.resolve()
  }, [])
 
  useEffect(() => {
    reload()
  }, deps)
 
  return {
    pageNumber,
    data,
    total,
    loading,
    initialLoading,
    incrementalLoading,
    noMore,
    loadMore,
    reload,
    setData,
  }
}