mescroll-uni.js 34 KB

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