You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

787 lines
32 KiB

4 years ago
  1. /* mescroll
  2. * version 1.3.0
  3. * 2020-07-10 wenju
  4. * http://www.mescroll.com
  5. */
  6. export default function MeScroll(options, isScrollBody) {
  7. let me = this;
  8. me.version = '1.3.0'; // mescroll版本号
  9. me.options = options || {}; // 配置
  10. me.isScrollBody = isScrollBody || false; // 滚动区域是否为原生页面滚动; 默认为scroll-view
  11. me.isDownScrolling = false; // 是否在执行下拉刷新的回调
  12. me.isUpScrolling = false; // 是否在执行上拉加载的回调
  13. let hasDownCallback = me.options.down && me.options.down.callback; // 是否配置了down的callback
  14. // 初始化下拉刷新
  15. me.initDownScroll();
  16. // 初始化上拉加载,则初始化
  17. me.initUpScroll();
  18. // 自动加载
  19. setTimeout(function() { // 待主线程执行完毕再执行,避免new MeScroll未初始化,在回调获取不到mescroll的实例
  20. // 自动触发下拉刷新 (只有配置了down的callback才自动触发下拉刷新)
  21. if ((me.optDown.use || me.optDown.native) && me.optDown.auto && hasDownCallback) {
  22. if (me.optDown.autoShowLoading) {
  23. me.triggerDownScroll(); // 显示下拉进度,执行下拉回调
  24. } else {
  25. me.optDown.callback && me.optDown.callback(me); // 不显示下拉进度,直接执行下拉回调
  26. }
  27. }
  28. // 自动触发上拉加载
  29. if(!me.isUpAutoLoad){ // 部分小程序(头条小程序)emit是异步, 会导致isUpAutoLoad判断有误, 先延时确保先执行down的callback,再执行up的callback
  30. setTimeout(function(){
  31. me.optUp.use && me.optUp.auto && !me.isUpAutoLoad && me.triggerUpScroll();
  32. },100)
  33. }
  34. }, 30); // 需让me.optDown.inited和me.optUp.inited先执行
  35. }
  36. /* 配置参数:下拉刷新 */
  37. MeScroll.prototype.extendDownScroll = function(optDown) {
  38. // 下拉刷新的配置
  39. MeScroll.extend(optDown, {
  40. use: true, // 是否启用下拉刷新; 默认true
  41. auto: true, // 是否在初始化完毕之后自动执行下拉刷新的回调; 默认true
  42. native: false, // 是否使用系统自带的下拉刷新; 默认false; 仅mescroll-body生效 (值为true时,还需在pages配置enablePullDownRefresh:true;详请参考mescroll-native的案例)
  43. autoShowLoading: false, // 如果设置auto=true(在初始化完毕之后自动执行下拉刷新的回调),那么是否显示下拉刷新的进度; 默认false
  44. isLock: false, // 是否锁定下拉刷新,默认false;
  45. offset: 80, // 在列表顶部,下拉大于80px,松手即可触发下拉刷新的回调
  46. startTop: 100, // scroll-view快速滚动到顶部时,此时的scroll-top可能大于0, 此值用于控制最大的误差
  47. inOffsetRate: 1, // 在列表顶部,下拉的距离小于offset时,改变下拉区域高度比例;值小于1且越接近0,高度变化越小,表现为越往下越难拉
  48. outOffsetRate: 0.2, // 在列表顶部,下拉的距离大于offset时,改变下拉区域高度比例;值小于1且越接近0,高度变化越小,表现为越往下越难拉
  49. bottomOffset: 20, // 当手指touchmove位置在距离body底部20px范围内的时候结束上拉刷新,避免Webview嵌套导致touchend事件不执行
  50. minAngle: 45, // 向下滑动最少偏移的角度,取值区间 [0,90];默认45度,即向下滑动的角度大于45度则触发下拉;而小于45度,将不触发下拉,避免与左右滑动的轮播等组件冲突;
  51. textInOffset: '下拉刷新', // 下拉的距离在offset范围内的提示文本
  52. textOutOffset: '释放更新', // 下拉的距离大于offset范围的提示文本
  53. textLoading: '加载中 ...', // 加载中的提示文本
  54. bgColor: "transparent", // 背景颜色 (建议在pages.json中再设置一下backgroundColorTop)
  55. textColor: "gray", // 文本颜色 (当bgColor配置了颜色,而textColor未配置时,则textColor会默认为白色)
  56. inited: null, // 下拉刷新初始化完毕的回调
  57. inOffset: null, // 下拉的距离进入offset范围内那一刻的回调
  58. outOffset: null, // 下拉的距离大于offset那一刻的回调
  59. onMoving: null, // 下拉过程中的回调,滑动过程一直在执行; rate下拉区域当前高度与指定距离的比值(inOffset: rate<1; outOffset: rate>=1); downHight当前下拉区域的高度
  60. beforeLoading: null, // 准备触发下拉刷新的回调: 如果return true,将不触发showLoading和callback回调; 常用来完全自定义下拉刷新, 参考案例【淘宝 v6.8.0】
  61. showLoading: null, // 显示下拉刷新进度的回调
  62. afterLoading: null, // 显示下拉刷新进度的回调之后,马上要执行的代码 (如: 在wxs中使用)
  63. beforeEndDownScroll: null, // 准备结束下拉的回调. 返回结束下拉的延时执行时间,默认0ms; 常用于结束下拉之前再显示另外一小段动画,才去隐藏下拉刷新的场景, 参考案例【dotJump】
  64. endDownScroll: null, // 结束下拉刷新的回调
  65. afterEndDownScroll: null, // 结束下拉刷新的回调,马上要执行的代码 (如: 在wxs中使用)
  66. callback: function(mescroll) {
  67. // 下拉刷新的回调;默认重置上拉加载列表为第一页
  68. mescroll.resetUpScroll();
  69. }
  70. })
  71. }
  72. /* 配置参数:上拉加载 */
  73. MeScroll.prototype.extendUpScroll = function(optUp) {
  74. // 上拉加载的配置
  75. MeScroll.extend(optUp, {
  76. use: true, // 是否启用上拉加载; 默认true
  77. auto: true, // 是否在初始化完毕之后自动执行上拉加载的回调; 默认true
  78. isLock: false, // 是否锁定上拉加载,默认false;
  79. isBoth: true, // 上拉加载时,如果滑动到列表顶部是否可以同时触发下拉刷新;默认true,两者可同时触发;
  80. callback: null, // 上拉加载的回调;function(page,mescroll){ }
  81. page: {
  82. num: 0, // 当前页码,默认0,回调之前会加1,即callback(page)会从1开始
  83. size: 10, // 每页数据的数量
  84. time: null // 加载第一页数据服务器返回的时间; 防止用户翻页时,后台新增了数据从而导致下一页数据重复;
  85. },
  86. noMoreSize: 5, // 如果列表已无数据,可设置列表的总数量要大于等于5条才显示无更多数据;避免列表数据过少(比如只有一条数据),显示无更多数据会不好看
  87. offset: 80, // 距底部多远时,触发upCallback
  88. textLoading: '加载中 ...', // 加载中的提示文本
  89. textNoMore: '-- 我也是有底线的 --', // 没有更多数据的提示文本
  90. bgColor: "transparent", // 背景颜色 (建议在pages.json中再设置一下backgroundColorBottom)
  91. textColor: "gray", // 文本颜色 (当bgColor配置了颜色,而textColor未配置时,则textColor会默认为白色)
  92. inited: null, // 初始化完毕的回调
  93. showLoading: null, // 显示加载中的回调
  94. showNoMore: null, // 显示无更多数据的回调
  95. hideUpScroll: null, // 隐藏上拉加载的回调
  96. errDistance: 60, // endErr的时候需往上滑动一段距离,使其往下滑动时再次触发onReachBottom,仅mescroll-body生效
  97. toTop: {
  98. // 回到顶部按钮,需配置src才显示
  99. src: null, // 图片路径,默认null (绝对路径或网络图)
  100. offset: 1000, // 列表滚动多少距离才显示回到顶部按钮,默认1000
  101. duration: 300, // 回到顶部的动画时长,默认300ms (当值为0或300则使用系统自带回到顶部,更流畅; 其他值则通过step模拟,部分机型可能不够流畅,所以非特殊情况不建议修改此项)
  102. btnClick: null, // 点击按钮的回调
  103. onShow: null, // 是否显示的回调
  104. zIndex: 9990, // fixed定位z-index值
  105. left: null, // 到左边的距离, 默认null. 此项有值时,right不生效. (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx)
  106. right: 20, // 到右边的距离, 默认20 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx)
  107. bottom: 120, // 到底部的距离, 默认120 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx)
  108. safearea: false, // bottom的偏移量是否加上底部安全区的距离, 默认false, 需要适配iPhoneX时使用 (具体的界面如果不配置此项,则取本vue的safearea值)
  109. width: 72, // 回到顶部图标的宽度, 默认72 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx)
  110. radius: "50%" // 圆角, 默认"50%" (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx)
  111. },
  112. empty: {
  113. use: true, // 是否显示空布局
  114. icon: null, // 图标路径
  115. tip: '~ 暂无相关数据 ~', // 提示
  116. btnText: '', // 按钮
  117. btnClick: null, // 点击按钮的回调
  118. onShow: null, // 是否显示的回调
  119. fixed: false, // 是否使用fixed定位,默认false; 配置fixed为true,以下的top和zIndex才生效 (transform会使fixed失效,最终会降级为absolute)
  120. top: "100rpx", // fixed定位的top值 (完整的单位值,如 "10%"; "100rpx")
  121. zIndex: 99 // fixed定位z-index值
  122. },
  123. onScroll: false // 是否监听滚动事件
  124. })
  125. }
  126. /* 配置参数 */
  127. MeScroll.extend = function(userOption, defaultOption) {
  128. if (!userOption) return defaultOption;
  129. for (let key in defaultOption) {
  130. if (userOption[key] == null) {
  131. let def = defaultOption[key];
  132. if (def != null && typeof def === 'object') {
  133. userOption[key] = MeScroll.extend({}, def); // 深度匹配
  134. } else {
  135. userOption[key] = def;
  136. }
  137. } else if (typeof userOption[key] === 'object') {
  138. MeScroll.extend(userOption[key], defaultOption[key]); // 深度匹配
  139. }
  140. }
  141. return userOption;
  142. }
  143. /* 简单判断是否配置了颜色 (非透明,非白色) */
  144. MeScroll.prototype.hasColor = function(color) {
  145. if(!color) return false;
  146. let c = color.toLowerCase();
  147. return c != "#fff" && c != "#ffffff" && c != "transparent" && c != "white"
  148. }
  149. /* -------初始化下拉刷新------- */
  150. MeScroll.prototype.initDownScroll = function() {
  151. let me = this;
  152. // 配置参数
  153. me.optDown = me.options.down || {};
  154. if(!me.optDown.textColor && me.hasColor(me.optDown.bgColor)) me.optDown.textColor = "#fff"; // 当bgColor有值且textColor未设置,则textColor默认白色
  155. me.extendDownScroll(me.optDown);
  156. // 如果是mescroll-body且配置了native,则禁止自定义的下拉刷新
  157. if(me.isScrollBody && me.optDown.native){
  158. me.optDown.use = false
  159. }else{
  160. me.optDown.native = false // 仅mescroll-body支持,mescroll-uni不支持
  161. }
  162. me.downHight = 0; // 下拉区域的高度
  163. // 在页面中加入下拉布局
  164. if (me.optDown.use && me.optDown.inited) {
  165. // 初始化完毕的回调
  166. setTimeout(function() { // 待主线程执行完毕再执行,避免new MeScroll未初始化,在回调获取不到mescroll的实例
  167. me.optDown.inited(me);
  168. }, 0)
  169. }
  170. }
  171. /* 列表touchstart事件 */
  172. MeScroll.prototype.touchstartEvent = function(e) {
  173. if (!this.optDown.use) return;
  174. this.startPoint = this.getPoint(e); // 记录起点
  175. this.startTop = this.getScrollTop(); // 记录此时的滚动条位置
  176. this.startAngle = 0; // 初始角度
  177. this.lastPoint = this.startPoint; // 重置上次move的点
  178. this.maxTouchmoveY = this.getBodyHeight() - this.optDown.bottomOffset; // 手指触摸的最大范围(写在touchstart避免body获取高度为0的情况)
  179. this.inTouchend = false; // 标记不是touchend
  180. }
  181. /* 列表touchmove事件 */
  182. MeScroll.prototype.touchmoveEvent = function(e) {
  183. if (!this.optDown.use) return;
  184. let me = this;
  185. let scrollTop = me.getScrollTop(); // 当前滚动条的距离
  186. let curPoint = me.getPoint(e); // 当前点
  187. let moveY = curPoint.y - me.startPoint.y; // 和起点比,移动的距离,大于0向下拉,小于0向上拉
  188. // 向下拉 && 在顶部
  189. // mescroll-body,直接判定在顶部即可
  190. // scroll-view在滚动时不会触发touchmove,当触顶/底/左/右时,才会触发touchmove
  191. // scroll-view滚动到顶部时,scrollTop不一定为0,也有可能大于0; 在iOS的APP中scrollTop可能为负数,不一定和startTop相等
  192. if (moveY > 0 && (
  193. (me.isScrollBody && scrollTop <= 0)
  194. ||
  195. (!me.isScrollBody && (scrollTop <= 0 || (scrollTop <= me.optDown.startTop && scrollTop === me.startTop)) )
  196. )) {
  197. // 可下拉的条件
  198. if (!me.inTouchend && !me.isDownScrolling && !me.optDown.isLock && (!me.isUpScrolling || (me.isUpScrolling &&
  199. me.optUp.isBoth))) {
  200. // 下拉的初始角度是否在配置的范围内
  201. if(!me.startAngle) me.startAngle = me.getAngle(me.lastPoint, curPoint); // 两点之间的角度,区间 [0,90]
  202. if (me.startAngle < me.optDown.minAngle) return; // 如果小于配置的角度,则不往下执行下拉刷新
  203. // 如果手指的位置超过配置的距离,则提前结束下拉,避免Webview嵌套导致touchend无法触发
  204. if (me.maxTouchmoveY > 0 && curPoint.y >= me.maxTouchmoveY) {
  205. me.inTouchend = true; // 标记执行touchend
  206. me.touchendEvent(); // 提前触发touchend
  207. return;
  208. }
  209. me.preventDefault(e); // 阻止默认事件
  210. let diff = curPoint.y - me.lastPoint.y; // 和上次比,移动的距离 (大于0向下,小于0向上)
  211. // 下拉距离 < 指定距离
  212. if (me.downHight < me.optDown.offset) {
  213. if (me.movetype !== 1) {
  214. me.movetype = 1; // 加入标记,保证只执行一次
  215. me.optDown.inOffset && me.optDown.inOffset(me); // 进入指定距离范围内那一刻的回调,只执行一次
  216. me.isMoveDown = true; // 标记下拉区域高度改变,在touchend重置回来
  217. }
  218. me.downHight += diff * me.optDown.inOffsetRate; // 越往下,高度变化越小
  219. // 指定距离 <= 下拉距离
  220. } else {
  221. if (me.movetype !== 2) {
  222. me.movetype = 2; // 加入标记,保证只执行一次
  223. me.optDown.outOffset && me.optDown.outOffset(me); // 下拉超过指定距离那一刻的回调,只执行一次
  224. me.isMoveDown = true; // 标记下拉区域高度改变,在touchend重置回来
  225. }
  226. if (diff > 0) { // 向下拉
  227. me.downHight += diff * me.optDown.outOffsetRate; // 越往下,高度变化越小
  228. } else { // 向上收
  229. me.downHight += diff; // 向上收回高度,则向上滑多少收多少高度
  230. }
  231. }
  232. me.downHight = Math.round(me.downHight) // 取整
  233. let rate = me.downHight / me.optDown.offset; // 下拉区域当前高度与指定距离的比值
  234. me.optDown.onMoving && me.optDown.onMoving(me, rate, me.downHight); // 下拉过程中的回调,一直在执行
  235. }
  236. }
  237. me.lastPoint = curPoint; // 记录本次移动的点
  238. }
  239. /* 列表touchend事件 */
  240. MeScroll.prototype.touchendEvent = function(e) {
  241. if (!this.optDown.use) return;
  242. // 如果下拉区域高度已改变,则需重置回来
  243. if (this.isMoveDown) {
  244. if (this.downHight >= this.optDown.offset) {
  245. // 符合触发刷新的条件
  246. this.triggerDownScroll();
  247. } else {
  248. // 不符合的话 则重置
  249. this.downHight = 0;
  250. this.endDownScrollCall(this);
  251. }
  252. this.movetype = 0;
  253. this.isMoveDown = false;
  254. } else if (!this.isScrollBody && this.getScrollTop() === this.startTop) { // scroll-view到顶/左/右/底的滑动事件
  255. let isScrollUp = this.getPoint(e).y - this.startPoint.y < 0; // 和起点比,移动的距离,大于0向下拉,小于0向上拉
  256. // 上滑
  257. if (isScrollUp) {
  258. // 需检查滑动的角度
  259. let angle = this.getAngle(this.getPoint(e), this.startPoint); // 两点之间的角度,区间 [0,90]
  260. if (angle > 80) {
  261. // 检查并触发上拉
  262. this.triggerUpScroll(true);
  263. }
  264. }
  265. }
  266. }
  267. /* 根据点击滑动事件获取第一个手指的坐标 */
  268. MeScroll.prototype.getPoint = function(e) {
  269. if (!e) {
  270. return {
  271. x: 0,
  272. y: 0
  273. }
  274. }
  275. if (e.touches && e.touches[0]) {
  276. return {
  277. x: e.touches[0].pageX,
  278. y: e.touches[0].pageY
  279. }
  280. } else if (e.changedTouches && e.changedTouches[0]) {
  281. return {
  282. x: e.changedTouches[0].pageX,
  283. y: e.changedTouches[0].pageY
  284. }
  285. } else {
  286. return {
  287. x: e.clientX,
  288. y: e.clientY
  289. }
  290. }
  291. }
  292. /* 计算两点之间的角度: 区间 [0,90]*/
  293. MeScroll.prototype.getAngle = function(p1, p2) {
  294. let x = Math.abs(p1.x - p2.x);
  295. let y = Math.abs(p1.y - p2.y);
  296. let z = Math.sqrt(x * x + y * y);
  297. let angle = 0;
  298. if (z !== 0) {
  299. angle = Math.asin(y / z) / Math.PI * 180;
  300. }
  301. return angle
  302. }
  303. /* 触发下拉刷新 */
  304. MeScroll.prototype.triggerDownScroll = function() {
  305. if (this.optDown.beforeLoading && this.optDown.beforeLoading(this)) {
  306. //return true则处于完全自定义状态
  307. } else {
  308. this.showDownScroll(); // 下拉刷新中...
  309. !this.optDown.native && this.optDown.callback && this.optDown.callback(this); // 执行回调,联网加载数据
  310. }
  311. }
  312. /* 显示下拉进度布局 */
  313. MeScroll.prototype.showDownScroll = function() {
  314. this.isDownScrolling = true; // 标记下拉中
  315. if (this.optDown.native) {
  316. uni.startPullDownRefresh(); // 系统自带的下拉刷新
  317. this.showDownLoadingCall(0); // 仍触发showLoading,因为上拉加载用到
  318. } else{
  319. this.downHight = this.optDown.offset; // 更新下拉区域高度
  320. this.showDownLoadingCall(this.downHight); // 下拉刷新中...
  321. }
  322. }
  323. MeScroll.prototype.showDownLoadingCall = function(downHight) {
  324. this.optDown.showLoading && this.optDown.showLoading(this, downHight); // 下拉刷新中...
  325. this.optDown.afterLoading && this.optDown.afterLoading(this, downHight); // 下拉刷新中...触发之后马上要执行的代码
  326. }
  327. /* 显示系统自带的下拉刷新时需要处理的业务 */
  328. MeScroll.prototype.onPullDownRefresh = function() {
  329. this.isDownScrolling = true; // 标记下拉中
  330. this.showDownLoadingCall(0); // 仍触发showLoading,因为上拉加载用到
  331. this.optDown.callback && this.optDown.callback(this); // 执行回调,联网加载数据
  332. }
  333. /* 结束下拉刷新 */
  334. MeScroll.prototype.endDownScroll = function() {
  335. if (this.optDown.native) { // 结束原生下拉刷新
  336. this.isDownScrolling = false;
  337. this.endDownScrollCall(this);
  338. uni.stopPullDownRefresh();
  339. return
  340. }
  341. let me = this;
  342. // 结束下拉刷新的方法
  343. let endScroll = function() {
  344. me.downHight = 0;
  345. me.isDownScrolling = false;
  346. me.endDownScrollCall(me);
  347. if(!me.isScrollBody){
  348. me.setScrollHeight(0) // scroll-view重置滚动区域,使数据不满屏时仍可检查触发翻页
  349. me.scrollTo(0,0) // scroll-view需重置滚动条到顶部,避免startTop大于0时,对下拉刷新的影响
  350. }
  351. }
  352. // 结束下拉刷新时的回调
  353. let delay = 0;
  354. if (me.optDown.beforeEndDownScroll) delay = me.optDown.beforeEndDownScroll(me); // 结束下拉刷新的延时,单位ms
  355. if (typeof delay === 'number' && delay > 0) {
  356. setTimeout(endScroll, delay);
  357. } else {
  358. endScroll();
  359. }
  360. }
  361. MeScroll.prototype.endDownScrollCall = function() {
  362. this.optDown.endDownScroll && this.optDown.endDownScroll(this);
  363. this.optDown.afterEndDownScroll && this.optDown.afterEndDownScroll(this);
  364. }
  365. /* 锁定下拉刷新:isLock=ture,null锁定;isLock=false解锁 */
  366. MeScroll.prototype.lockDownScroll = function(isLock) {
  367. if (isLock == null) isLock = true;
  368. this.optDown.isLock = isLock;
  369. }
  370. /* 锁定上拉加载:isLock=ture,null锁定;isLock=false解锁 */
  371. MeScroll.prototype.lockUpScroll = function(isLock) {
  372. if (isLock == null) isLock = true;
  373. this.optUp.isLock = isLock;
  374. }
  375. /* -------初始化上拉加载------- */
  376. MeScroll.prototype.initUpScroll = function() {
  377. let me = this;
  378. // 配置参数
  379. me.optUp = me.options.up || {use: false}
  380. if(!me.optUp.textColor && me.hasColor(me.optUp.bgColor)) me.optUp.textColor = "#fff"; // 当bgColor有值且textColor未设置,则textColor默认白色
  381. me.extendUpScroll(me.optUp);
  382. if (me.optUp.use === false) return; // 配置不使用上拉加载时,则不初始化上拉布局
  383. me.optUp.hasNext = true; // 如果使用上拉,则默认有下一页
  384. me.startNum = me.optUp.page.num + 1; // 记录page开始的页码
  385. // 初始化完毕的回调
  386. if (me.optUp.inited) {
  387. setTimeout(function() { // 待主线程执行完毕再执行,避免new MeScroll未初始化,在回调获取不到mescroll的实例
  388. me.optUp.inited(me);
  389. }, 0)
  390. }
  391. }
  392. /*滚动到底部的事件 (仅mescroll-body生效)*/
  393. MeScroll.prototype.onReachBottom = function() {
  394. if (this.isScrollBody && !this.isUpScrolling) { // 只能支持下拉刷新的时候同时可以触发上拉加载,否则滚动到底部就需要上滑一点才能触发onReachBottom
  395. if (!this.optUp.isLock && this.optUp.hasNext) {
  396. this.triggerUpScroll();
  397. }
  398. }
  399. }
  400. /*列表滚动事件 (仅mescroll-body生效)*/
  401. MeScroll.prototype.onPageScroll = function(e) {
  402. if (!this.isScrollBody) return;
  403. // 更新滚动条的位置 (主要用于判断下拉刷新时,滚动条是否在顶部)
  404. this.setScrollTop(e.scrollTop);
  405. // 顶部按钮的显示隐藏
  406. if (e.scrollTop >= this.optUp.toTop.offset) {
  407. this.showTopBtn();
  408. } else {
  409. this.hideTopBtn();
  410. }
  411. }
  412. /*列表滚动事件*/
  413. MeScroll.prototype.scroll = function(e, onScroll) {
  414. // 更新滚动条的位置
  415. this.setScrollTop(e.scrollTop);
  416. // 更新滚动内容高度
  417. this.setScrollHeight(e.scrollHeight);
  418. // 向上滑还是向下滑动
  419. if (this.preScrollY == null) this.preScrollY = 0;
  420. this.isScrollUp = e.scrollTop - this.preScrollY > 0;
  421. this.preScrollY = e.scrollTop;
  422. // 上滑 && 检查并触发上拉
  423. this.isScrollUp && this.triggerUpScroll(true);
  424. // 顶部按钮的显示隐藏
  425. if (e.scrollTop >= this.optUp.toTop.offset) {
  426. this.showTopBtn();
  427. } else {
  428. this.hideTopBtn();
  429. }
  430. // 滑动监听
  431. this.optUp.onScroll && onScroll && onScroll()
  432. }
  433. /* 触发上拉加载 */
  434. MeScroll.prototype.triggerUpScroll = function(isCheck) {
  435. if (!this.isUpScrolling && this.optUp.use && this.optUp.callback) {
  436. // 是否校验在底部; 默认不校验
  437. if (isCheck === true) {
  438. let canUp = false;
  439. // 还有下一页 && 没有锁定 && 不在下拉中
  440. if (this.optUp.hasNext && !this.optUp.isLock && !this.isDownScrolling) {
  441. if (this.getScrollBottom() <= this.optUp.offset) { // 到底部
  442. canUp = true; // 标记可上拉
  443. }
  444. }
  445. if (canUp === false) return;
  446. }
  447. this.showUpScroll(); // 上拉加载中...
  448. this.optUp.page.num++; // 预先加一页,如果失败则减回
  449. this.isUpAutoLoad = true; // 标记上拉已经自动执行过,避免初始化时多次触发上拉回调
  450. this.num = this.optUp.page.num; // 把最新的页数赋值在mescroll上,避免对page的影响
  451. this.size = this.optUp.page.size; // 把最新的页码赋值在mescroll上,避免对page的影响
  452. this.time = this.optUp.page.time; // 把最新的页码赋值在mescroll上,避免对page的影响
  453. this.optUp.callback(this); // 执行回调,联网加载数据
  454. }
  455. }
  456. /* 显示上拉加载中 */
  457. MeScroll.prototype.showUpScroll = function() {
  458. this.isUpScrolling = true; // 标记上拉加载中
  459. this.optUp.showLoading && this.optUp.showLoading(this); // 回调
  460. }
  461. /* 显示上拉无更多数据 */
  462. MeScroll.prototype.showNoMore = function() {
  463. this.optUp.hasNext = false; // 标记无更多数据
  464. this.optUp.showNoMore && this.optUp.showNoMore(this); // 回调
  465. }
  466. /* 隐藏上拉区域**/
  467. MeScroll.prototype.hideUpScroll = function() {
  468. this.optUp.hideUpScroll && this.optUp.hideUpScroll(this); // 回调
  469. }
  470. /* 结束上拉加载 */
  471. MeScroll.prototype.endUpScroll = function(isShowNoMore) {
  472. if (isShowNoMore != null) { // isShowNoMore=null,不处理下拉状态,下拉刷新的时候调用
  473. if (isShowNoMore) {
  474. this.showNoMore(); // isShowNoMore=true,显示无更多数据
  475. } else {
  476. this.hideUpScroll(); // isShowNoMore=false,隐藏上拉加载
  477. }
  478. }
  479. this.isUpScrolling = false; // 标记结束上拉加载
  480. }
  481. /*
  482. *isShowLoading 是否显示进度布局;
  483. * 1.默认null,不传参,则显示上拉加载的进度布局
  484. * 2.传参true, 则显示下拉刷新的进度布局
  485. * 3.传参false,则不显示上拉和下拉的进度 (常用于静默更新列表数据)
  486. */
  487. MeScroll.prototype.resetUpScroll = function(isShowLoading) {
  488. if (this.optUp && this.optUp.use) {
  489. let page = this.optUp.page;
  490. this.prePageNum = page.num; // 缓存重置前的页码,加载失败可退回
  491. this.prePageTime = page.time; // 缓存重置前的时间,加载失败可退回
  492. page.num = this.startNum; // 重置为第一页
  493. page.time = null; // 重置时间为空
  494. if (!this.isDownScrolling && isShowLoading !== false) { // 如果不是下拉刷新触发的resetUpScroll并且不配置列表静默更新,则显示进度;
  495. if (isShowLoading == null) {
  496. this.removeEmpty(); // 移除空布局
  497. this.showUpScroll(); // 不传参,默认显示上拉加载的进度布局
  498. } else {
  499. this.showDownScroll(); // 传true,显示下拉刷新的进度布局,不清空列表
  500. }
  501. }
  502. this.isUpAutoLoad = true; // 标记上拉已经自动执行过,避免初始化时多次触发上拉回调
  503. this.num = page.num; // 把最新的页数赋值在mescroll上,避免对page的影响
  504. this.size = page.size; // 把最新的页码赋值在mescroll上,避免对page的影响
  505. this.time = page.time; // 把最新的页码赋值在mescroll上,避免对page的影响
  506. this.optUp.callback && this.optUp.callback(this); // 执行上拉回调
  507. }
  508. }
  509. /* 设置page.num的值 */
  510. MeScroll.prototype.setPageNum = function(num) {
  511. this.optUp.page.num = num - 1;
  512. }
  513. /* 设置page.size的值 */
  514. MeScroll.prototype.setPageSize = function(size) {
  515. this.optUp.page.size = size;
  516. }
  517. /* ,
  518. * dataSize: 当前页的数据量(必传)
  519. * totalPage: 总页数(必传)
  520. * systime: 服务器时间 (可空)
  521. */
  522. MeScroll.prototype.endByPage = function(dataSize, totalPage, systime) {
  523. let hasNext;
  524. if (this.optUp.use && totalPage != null) hasNext = this.optUp.page.num < totalPage; // 是否还有下一页
  525. this.endSuccess(dataSize, hasNext, systime);
  526. }
  527. /* ,
  528. * dataSize: 当前页的数据量(必传)
  529. * totalSize: 列表所有数据总数量(必传)
  530. * systime: 服务器时间 (可空)
  531. */
  532. MeScroll.prototype.endBySize = function(dataSize, totalSize, systime) {
  533. let hasNext;
  534. if (this.optUp.use && totalSize != null) {
  535. let loadSize = (this.optUp.page.num - 1) * this.optUp.page.size + dataSize; // 已加载的数据总数
  536. hasNext = loadSize < totalSize; // 是否还有下一页
  537. }
  538. this.endSuccess(dataSize, hasNext, systime);
  539. }
  540. /* ,
  541. * dataSize: 当前页的数据个数(不是所有页的数据总和),用于上拉加载判断是否还有下一页.如果不传,则会判断还有下一页
  542. * hasNext: 是否还有下一页,布尔类型;用来解决这个小问题:比如列表共有20条数据,每页加载10条,共2页.如果只根据dataSize判断,则需翻到第三页才会知道无更多数据,如果传了hasNext,则翻到第二页即可显示无更多数据.
  543. * systime: 服务器时间(可空);用来解决这个小问题:当准备翻下一页时,数据库新增了几条记录,此时翻下一页,前面的几条数据会和上一页的重复;这里传入了systime,那么upCallback的page.time就会有值,把page.time传给服务器,让后台过滤新加入的那几条记录
  544. */
  545. MeScroll.prototype.endSuccess = function(dataSize, hasNext, systime) {
  546. let me = this;
  547. // 结束下拉刷新
  548. if (me.isDownScrolling) me.endDownScroll();
  549. // 结束上拉加载
  550. if (me.optUp.use) {
  551. let isShowNoMore; // 是否已无更多数据
  552. if (dataSize != null) {
  553. let pageNum = me.optUp.page.num; // 当前页码
  554. let pageSize = me.optUp.page.size; // 每页长度
  555. // 如果是第一页
  556. if (pageNum === 1) {
  557. if (systime) me.optUp.page.time = systime; // 设置加载列表数据第一页的时间
  558. }
  559. if (dataSize < pageSize || hasNext === false) {
  560. // 返回的数据不满一页时,则说明已无更多数据
  561. me.optUp.hasNext = false;
  562. if (dataSize === 0 && pageNum === 1) {
  563. // 如果第一页无任何数据且配置了空布局
  564. isShowNoMore = false;
  565. me.showEmpty();
  566. } else {
  567. // 总列表数少于配置的数量,则不显示无更多数据
  568. let allDataSize = (pageNum - 1) * pageSize + dataSize;
  569. if (allDataSize < me.optUp.noMoreSize) {
  570. isShowNoMore = false;
  571. } else {
  572. isShowNoMore = true;
  573. }
  574. me.removeEmpty(); // 移除空布局
  575. }
  576. } else {
  577. // 还有下一页
  578. isShowNoMore = false;
  579. me.optUp.hasNext = true;
  580. me.removeEmpty(); // 移除空布局
  581. }
  582. }
  583. // 隐藏上拉
  584. me.endUpScroll(isShowNoMore);
  585. }
  586. }
  587. /* 回调失败,结束下拉刷新和上拉加载 */
  588. MeScroll.prototype.endErr = function(errDistance) {
  589. // 结束下拉,回调失败重置回原来的页码和时间
  590. if (this.isDownScrolling) {
  591. let page = this.optUp.page;
  592. if (page && this.prePageNum) {
  593. page.num = this.prePageNum;
  594. page.time = this.prePageTime;
  595. }
  596. this.endDownScroll();
  597. }
  598. // 结束上拉,回调失败重置回原来的页码
  599. if (this.isUpScrolling) {
  600. this.optUp.page.num--;
  601. this.endUpScroll(false);
  602. // 如果是mescroll-body,则需往回滚一定距离
  603. if(this.isScrollBody && errDistance !== 0){ // 不处理0
  604. if(!errDistance) errDistance = this.optUp.errDistance; // 不传,则取默认
  605. this.scrollTo(this.getScrollTop() - errDistance, 0) // 往上回滚的距离
  606. }
  607. }
  608. }
  609. /* 显示空布局 */
  610. MeScroll.prototype.showEmpty = function() {
  611. this.optUp.empty.use && this.optUp.empty.onShow && this.optUp.empty.onShow(true)
  612. }
  613. /* 移除空布局 */
  614. MeScroll.prototype.removeEmpty = function() {
  615. this.optUp.empty.use && this.optUp.empty.onShow && this.optUp.empty.onShow(false)
  616. }
  617. /* 显示回到顶部的按钮 */
  618. MeScroll.prototype.showTopBtn = function() {
  619. if (!this.topBtnShow) {
  620. this.topBtnShow = true;
  621. this.optUp.toTop.onShow && this.optUp.toTop.onShow(true);
  622. }
  623. }
  624. /* 隐藏回到顶部的按钮 */
  625. MeScroll.prototype.hideTopBtn = function() {
  626. if (this.topBtnShow) {
  627. this.topBtnShow = false;
  628. this.optUp.toTop.onShow && this.optUp.toTop.onShow(false);
  629. }
  630. }
  631. /* 获取滚动条的位置 */
  632. MeScroll.prototype.getScrollTop = function() {
  633. return this.scrollTop || 0
  634. }
  635. /* 记录滚动条的位置 */
  636. MeScroll.prototype.setScrollTop = function(y) {
  637. this.scrollTop = y;
  638. }
  639. /* 滚动到指定位置 */
  640. MeScroll.prototype.scrollTo = function(y, t) {
  641. this.myScrollTo && this.myScrollTo(y, t) // scrollview需自定义回到顶部方法
  642. }
  643. /* 自定义scrollTo */
  644. MeScroll.prototype.resetScrollTo = function(myScrollTo) {
  645. this.myScrollTo = myScrollTo
  646. }
  647. /* 滚动条到底部的距离 */
  648. MeScroll.prototype.getScrollBottom = function() {
  649. return this.getScrollHeight() - this.getClientHeight() - this.getScrollTop()
  650. }
  651. /*
  652. star: 开始值
  653. end: 结束值
  654. callback(step,timer): 回调step值,计步器timer,可自行通过window.clearInterval(timer)结束计步器;
  655. t: 计步时长,传0则直接回调end值;不传则默认300ms
  656. rate: 周期;不传则默认30ms计步一次
  657. * */
  658. MeScroll.prototype.getStep = function(star, end, callback, t, rate) {
  659. let diff = end - star; // 差值
  660. if (t === 0 || diff === 0) {
  661. callback && callback(end);
  662. return;
  663. }
  664. t = t || 300; // 时长 300ms
  665. rate = rate || 30; // 周期 30ms
  666. let count = t / rate; // 次数
  667. let step = diff / count; // 步长
  668. let i = 0; // 计数
  669. let timer = setInterval(function() {
  670. if (i < count - 1) {
  671. star += step;
  672. callback && callback(star, timer);
  673. i++;
  674. } else {
  675. callback && callback(end, timer); // 最后一次直接设置end,避免计算误差
  676. clearInterval(timer);
  677. }
  678. }, rate);
  679. }
  680. /* 滚动容器的高度 */
  681. MeScroll.prototype.getClientHeight = function(isReal) {
  682. let h = this.clientHeight || 0
  683. if (h === 0 && isReal !== true) { // 未获取到容器的高度,可临时取body的高度 (可能会有误差)
  684. h = this.getBodyHeight()
  685. }
  686. return h
  687. }
  688. MeScroll.prototype.setClientHeight = function(h) {
  689. this.clientHeight = h;
  690. }
  691. /* 滚动内容的高度 */
  692. MeScroll.prototype.getScrollHeight = function() {
  693. return this.scrollHeight || 0;
  694. }
  695. MeScroll.prototype.setScrollHeight = function(h) {
  696. this.scrollHeight = h;
  697. }
  698. /* body的高度 */
  699. MeScroll.prototype.getBodyHeight = function() {
  700. return this.bodyHeight || 0;
  701. }
  702. MeScroll.prototype.setBodyHeight = function(h) {
  703. this.bodyHeight = h;
  704. }
  705. /* 阻止浏览器默认滚动事件 */
  706. MeScroll.prototype.preventDefault = function(e) {
  707. // 小程序不支持e.preventDefault, 已在wxs中禁止
  708. // app的bounce只能通过配置pages.json的style.app-plus.bounce为"none"来禁止, 或使用renderjs禁止
  709. // cancelable:是否可以被禁用; defaultPrevented:是否已经被禁用
  710. if (e && e.cancelable && !e.defaultPrevented) e.preventDefault()
  711. }