mescroll-uni.js 32 KB

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