mescroll-uni.js 33 KB

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