mescroll-body.vue 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. <template>
  2. <view
  3. class="mescroll-body mescroll-render-touch"
  4. :class="{'mescorll-sticky': sticky}"
  5. :style="{'minHeight':minHeight, 'padding-top': padTop, 'padding-bottom': padBottom}"
  6. @touchstart="wxsBiz.touchstartEvent"
  7. @touchmove="wxsBiz.touchmoveEvent"
  8. @touchend="wxsBiz.touchendEvent"
  9. @touchcancel="wxsBiz.touchendEvent"
  10. :change:prop="wxsBiz.propObserver"
  11. :prop="wxsProp"
  12. >
  13. <!-- 状态栏 -->
  14. <view v-if="topbar&&statusBarHeight" class="mescroll-topbar" :style="{height: statusBarHeight+'px', background: topbar}"></view>
  15. <view class="mescroll-body-content mescroll-wxs-content" :style="{ transform: translateY, transition: transition }" :change:prop="wxsBiz.callObserver" :prop="callProp">
  16. <!-- 下拉加载区域 (支付宝小程序子组件传参给子子组件仍报单项数据流的异常,暂时不通过mescroll-down组件实现)-->
  17. <!-- <mescroll-down :option="mescroll.optDown" :type="downLoadType" :rate="downRate"></mescroll-down> -->
  18. <view v-if="mescroll.optDown.use" class="mescroll-downwarp" :style="{'background':mescroll.optDown.bgColor,'color':mescroll.optDown.textColor}">
  19. <view class="downwarp-content">
  20. <view class="downwarp-progress mescroll-wxs-progress" :class="{'mescroll-rotate': isDownLoading}" :style="{'border-color':mescroll.optDown.textColor, 'transform': downRotate}"></view>
  21. <view class="downwarp-tip">{{downText}}</view>
  22. </view>
  23. </view>
  24. <!-- 列表内容 -->
  25. <slot></slot>
  26. <!-- 空布局 -->
  27. <mescroll-empty v-if="isShowEmpty" :option="mescroll.optUp.empty" @emptyclick="emptyClick"></mescroll-empty>
  28. <!-- 上拉加载区域 (下拉刷新时不显示, 支付宝小程序子组件传参给子子组件仍报单项数据流的异常,暂时不通过mescroll-up组件实现)-->
  29. <!-- <mescroll-up v-if="mescroll.optUp.use && !isDownLoading && upLoadType!==3" :option="mescroll.optUp" :type="upLoadType"></mescroll-up> -->
  30. <view v-if="mescroll.optUp.use && !isDownLoading && upLoadType!==3" class="mescroll-upwarp" :style="{'background':mescroll.optUp.bgColor,'color':mescroll.optUp.textColor}">
  31. <!-- 加载中 (此处不能用v-if,否则android小程序快速上拉可能会不断触发上拉回调) -->
  32. <view v-show="upLoadType===1">
  33. <view class="upwarp-progress mescroll-rotate" :style="{'border-color':mescroll.optUp.textColor}"></view>
  34. <view class="upwarp-tip">{{ mescroll.optUp.textLoading }}</view>
  35. </view>
  36. <!-- 无数据 -->
  37. <view v-if="upLoadType===2" class="upwarp-nodata">{{ mescroll.optUp.textNoMore }}</view>
  38. </view>
  39. </view>
  40. <!-- 底部是否偏移TabBar的高度(默认仅在H5端的tab页生效) -->
  41. <!-- #ifdef H5 -->
  42. <view v-if="bottombar && windowBottom>0" class="mescroll-bottombar" :style="{height: windowBottom+'px'}"></view>
  43. <!-- #endif -->
  44. <!-- 适配iPhoneX -->
  45. <view v-if="safearea" class="mescroll-safearea"></view>
  46. <!-- 回到顶部按钮 (fixed元素需写在transform外面,防止降级为absolute)-->
  47. <mescroll-top v-model="isShowToTop" :option="mescroll.optUp.toTop" @click="toTopClick"></mescroll-top>
  48. <!-- #ifdef MP-WEIXIN || MP-QQ || APP-PLUS || H5 -->
  49. <!-- renderjs的数据载体,不可写在mescroll-downwarp内部,避免use为false时,载体丢失,无法更新数据 -->
  50. <view :change:prop="renderBiz.propObserver" :prop="wxsProp"></view>
  51. <!-- #endif -->
  52. </view>
  53. </template>
  54. <!-- 微信小程序, QQ小程序, app, h5使用wxs -->
  55. <!-- #ifdef MP-WEIXIN || MP-QQ || APP-PLUS || H5 -->
  56. <script src="../mescroll-uni/wxs/wxs.wxs" module="wxsBiz" lang="wxs"></script>
  57. <!-- #endif -->
  58. <!-- app, h5使用renderjs -->
  59. <!-- #ifdef APP-PLUS || H5 -->
  60. <script module="renderBiz" lang="renderjs">
  61. import renderBiz from "../mescroll-uni/wxs/renderjs.js";
  62. export default {
  63. mixins: [renderBiz]
  64. }
  65. </script>
  66. <!-- #endif -->
  67. <script>
  68. // 引入mescroll-uni.js,处理核心逻辑
  69. import MeScroll from "../mescroll-uni/mescroll-uni.js";
  70. // 引入全局配置
  71. import GlobalOption from "../mescroll-uni/mescroll-uni-option.js";
  72. // 引入国际化工具类
  73. import mescrollI18n from '../mescroll-uni/mescroll-i18n.js';
  74. // 引入回到顶部组件
  75. import MescrollTop from "../mescroll-uni/components/mescroll-top.vue";
  76. // 引入兼容wxs(含renderjs)写法的mixins
  77. import WxsMixin from "../mescroll-uni/wxs/mixins.js";
  78. /**
  79. * mescroll-body 基于page滚动的下拉刷新和上拉加载组件, 支持嵌套原生组件, 性能好
  80. * @property {Object} down 下拉刷新的参数配置
  81. * @property {Object} up 上拉加载的参数配置
  82. * @property {Object} i18n 国际化的参数配置
  83. * @property {String, Number} top 下拉布局往下的偏移量 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx, 百分比则相对于windowHeight)
  84. * @property {Boolean, String} topbar 偏移量top是否加上状态栏高度, 默认false (使用场景:取消原生导航栏时,配置此项可留出状态栏的占位, 支持传入字符串背景,如色值,背景图,渐变)
  85. * @property {String, Number} bottom 上拉布局往上的偏移量 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx, 百分比则相对于windowHeight)
  86. * @property {Boolean} safearea 偏移量bottom是否加上底部安全区的距离, 默认false (需要适配iPhoneX时使用)
  87. * @property {Boolean} fixed 是否通过fixed固定mescroll的高度, 默认true
  88. * @property {String, Number} height 指定mescroll最小高度,默认windowHeight,使列表不满屏仍可下拉
  89. * @property {Boolean} bottombar 底部是否偏移TabBar的高度 (仅在H5端的tab页生效)
  90. * @property {Boolean} sticky 是否支持sticky,默认false; 当值配置true时,需避免在mescroll-body标签前面加非定位的元素,否则下拉区域无法隐藏
  91. * @event {Function} init 初始化完成的回调
  92. * @event {Function} down 下拉刷新的回调
  93. * @event {Function} up 上拉加载的回调
  94. * @event {Function} emptyclick 点击empty配置的btnText按钮回调
  95. * @event {Function} topclick 点击回到顶部的按钮回调
  96. * @event {Function} scroll 滚动监听 (需在 up 配置 onScroll:true 才生效)
  97. * @example <mescroll-body ref="mescrollRef" @init="mescrollInit" @down="downCallback" @up="upCallback"> ... </mescroll-body>
  98. */
  99. export default {
  100. name: 'mescroll-body',
  101. mixins: [WxsMixin],
  102. components: {
  103. MescrollTop
  104. },
  105. props: {
  106. down: Object,
  107. up: Object,
  108. i18n: Object,
  109. top: [String, Number],
  110. topbar: [Boolean, String],
  111. bottom: [String, Number],
  112. safearea: Boolean,
  113. height: [String, Number],
  114. bottombar:{
  115. type: Boolean,
  116. default: true
  117. },
  118. sticky: Boolean
  119. },
  120. data() {
  121. return {
  122. mescroll: {optDown:{},optUp:{}}, // mescroll实例
  123. downHight: 0, //下拉刷新: 容器高度
  124. downRate: 0, // 下拉比率(inOffset: rate<1; outOffset: rate>=1)
  125. downLoadType: 0, // 下拉刷新状态: 0(loading前), 1(inOffset), 2(outOffset), 3(showLoading), 4(endDownScroll)
  126. upLoadType: 0, // 上拉加载状态:0(loading前),1(loading中),2(没有更多了,显示END文本提示),3(没有更多了,不显示END文本提示)
  127. isShowEmpty: false, // 是否显示空布局
  128. isShowToTop: false, // 是否显示回到顶部按钮
  129. windowHeight: 0, // 可使用窗口的高度
  130. windowBottom: 0, // 可使用窗口的底部位置
  131. statusBarHeight: 0 // 状态栏高度
  132. };
  133. },
  134. computed: {
  135. // mescroll最小高度,默认windowHeight,使列表不满屏仍可下拉
  136. minHeight(){
  137. return this.toPx(this.height || '100%') + 'px'
  138. },
  139. // 下拉布局往下偏移的距离 (px)
  140. numTop() {
  141. return this.toPx(this.top)
  142. },
  143. padTop() {
  144. return this.numTop + 'px';
  145. },
  146. // 上拉布局往上偏移 (px)
  147. numBottom() {
  148. return this.toPx(this.bottom);
  149. },
  150. padBottom() {
  151. return this.numBottom + 'px';
  152. },
  153. // 是否为重置下拉的状态
  154. isDownReset() {
  155. return this.downLoadType === 3 || this.downLoadType === 4;
  156. },
  157. // 过渡
  158. transition() {
  159. return this.isDownReset ? 'transform 300ms' : '';
  160. },
  161. translateY() {
  162. return this.downHight > 0 ? 'translateY(' + this.downHight + 'px)' : ''; // transform会使fixed失效,需注意把fixed元素写在mescroll之外
  163. },
  164. // 是否在加载中
  165. isDownLoading(){
  166. return this.downLoadType === 3
  167. },
  168. // 旋转的角度
  169. downRotate(){
  170. return 'rotate(' + 360 * this.downRate + 'deg)'
  171. },
  172. // 文本提示
  173. downText(){
  174. if(!this.mescroll) return ""; // 避免头条小程序初始化时报错
  175. switch (this.downLoadType){
  176. case 1: return this.mescroll.optDown.textInOffset;
  177. case 2: return this.mescroll.optDown.textOutOffset;
  178. case 3: return this.mescroll.optDown.textLoading;
  179. case 4: return this.mescroll.isDownEndSuccess ? this.mescroll.optDown.textSuccess : this.mescroll.isDownEndSuccess==false ? this.mescroll.optDown.textErr : this.mescroll.optDown.textInOffset;
  180. default: return this.mescroll.optDown.textInOffset;
  181. }
  182. }
  183. },
  184. methods: {
  185. //number,rpx,upx,px,% --> px的数值
  186. toPx(num) {
  187. if (typeof num === 'string') {
  188. if (num.indexOf('px') !== -1) {
  189. if (num.indexOf('rpx') !== -1) {
  190. // "10rpx"
  191. num = num.replace('rpx', '');
  192. } else if (num.indexOf('upx') !== -1) {
  193. // "10upx"
  194. num = num.replace('upx', '');
  195. } else {
  196. // "10px"
  197. return Number(num.replace('px', ''));
  198. }
  199. } else if (num.indexOf('%') !== -1) {
  200. // 传百分比,则相对于windowHeight,传"10%"则等于windowHeight的10%
  201. let rate = Number(num.replace('%', '')) / 100;
  202. return this.windowHeight * rate;
  203. }
  204. }
  205. return num ? uni.upx2px(Number(num)) : 0;
  206. },
  207. // 点击空布局的按钮回调
  208. emptyClick() {
  209. this.$emit('emptyclick', this.mescroll);
  210. },
  211. // 点击回到顶部的按钮回调
  212. toTopClick() {
  213. this.mescroll.scrollTo(0, this.mescroll.optUp.toTop.duration); // 执行回到顶部
  214. this.$emit('topclick', this.mescroll); // 派发点击回到顶部按钮的回调
  215. }
  216. },
  217. // 使用created初始化mescroll对象; 如果用mounted部分css样式编译到H5会失效
  218. created() {
  219. let vm = this;
  220. let diyOption = {
  221. // 下拉刷新的配置
  222. down: {
  223. inOffset() {
  224. vm.downLoadType = 1; // 下拉的距离进入offset范围内那一刻的回调 (自定义mescroll组件时,此行不可删)
  225. },
  226. outOffset() {
  227. vm.downLoadType = 2; // 下拉的距离大于offset那一刻的回调 (自定义mescroll组件时,此行不可删)
  228. },
  229. onMoving(mescroll, rate, downHight) {
  230. // 下拉过程中的回调,滑动过程一直在执行;
  231. vm.downHight = downHight; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  232. vm.downRate = rate; //下拉比率 (inOffset: rate<1; outOffset: rate>=1)
  233. },
  234. showLoading(mescroll, downHight) {
  235. vm.downLoadType = 3; // 显示下拉刷新进度的回调 (自定义mescroll组件时,此行不可删)
  236. vm.downHight = downHight; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  237. },
  238. beforeEndDownScroll(mescroll){
  239. vm.downLoadType = 4;
  240. return mescroll.optDown.beforeEndDelay // 延时结束的时长
  241. },
  242. endDownScroll() {
  243. vm.downLoadType = 4; // 结束下拉 (自定义mescroll组件时,此行不可删)
  244. vm.downHight = 0; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  245. if(vm.downResetTimer) {clearTimeout(vm.downResetTimer); vm.downResetTimer = null} // 移除重置倒计时
  246. vm.downResetTimer = setTimeout(()=>{ // 过渡动画执行完毕后,需重置为0的状态,避免下次inOffset不及时显示textInOffset
  247. if(vm.downLoadType === 4) vm.downLoadType = 0
  248. },300)
  249. },
  250. // 派发下拉刷新的回调
  251. callback: function(mescroll) {
  252. vm.$emit('down', mescroll);
  253. }
  254. },
  255. // 上拉加载的配置
  256. up: {
  257. // 显示加载中的回调
  258. showLoading() {
  259. vm.upLoadType = 1;
  260. },
  261. // 显示无更多数据的回调
  262. showNoMore() {
  263. vm.upLoadType = 2;
  264. },
  265. // 隐藏上拉加载的回调
  266. hideUpScroll(mescroll) {
  267. vm.upLoadType = mescroll.optUp.hasNext ? 0 : 3;
  268. },
  269. // 空布局
  270. empty: {
  271. onShow(isShow) {
  272. // 显示隐藏的回调
  273. vm.isShowEmpty = isShow;
  274. }
  275. },
  276. // 回到顶部
  277. toTop: {
  278. onShow(isShow) {
  279. // 显示隐藏的回调
  280. vm.isShowToTop = isShow;
  281. }
  282. },
  283. // 派发上拉加载的回调
  284. callback: function(mescroll) {
  285. vm.$emit('up', mescroll);
  286. }
  287. }
  288. };
  289. let i18nType = mescrollI18n.getType() // 当前语言类型
  290. let i18nOption = {type: i18nType} // 国际化配置
  291. MeScroll.extend(i18nOption, vm.i18n) // 具体页面的国际化配置
  292. MeScroll.extend(i18nOption, GlobalOption.i18n) // 全局的国际化配置
  293. MeScroll.extend(diyOption, i18nOption[i18nType]); // 混入国际化配置
  294. MeScroll.extend(diyOption, {down:GlobalOption.down, up:GlobalOption.up}); // 混入全局的配置
  295. let myOption = JSON.parse(JSON.stringify({down: vm.down,up: vm.up})); // 深拷贝,避免对props的影响
  296. MeScroll.extend(myOption, diyOption); // 混入具体界面的配置
  297. // 初始化MeScroll对象
  298. vm.mescroll = new MeScroll(myOption, true); // 传入true,标记body为滚动区域
  299. // 挂载语言包
  300. vm.mescroll.i18n = i18nOption;
  301. // init回调mescroll对象
  302. vm.$emit('init', vm.mescroll);
  303. // 设置高度
  304. const sys = uni.getSystemInfoSync();
  305. if (sys.windowHeight) vm.windowHeight = sys.windowHeight;
  306. if (sys.windowBottom) vm.windowBottom = sys.windowBottom;
  307. if (sys.statusBarHeight) vm.statusBarHeight = sys.statusBarHeight;
  308. // 使down的bottomOffset生效
  309. vm.mescroll.setBodyHeight(sys.windowHeight);
  310. // 因为使用的是page的scroll,这里需自定义scrollTo
  311. vm.mescroll.resetScrollTo((y, t) => {
  312. if(typeof y === 'string'){
  313. // 滚动到指定view (y为css选择器)
  314. setTimeout(()=>{ // 延时确保view已渲染; 不使用$nextTick
  315. let selector;
  316. if(y.indexOf('#')==-1 && y.indexOf('.')==-1){
  317. selector = '#'+y // 不带#和. 则默认为id选择器
  318. }else{
  319. selector = y
  320. // #ifdef APP-PLUS || H5 || MP-ALIPAY || MP-DINGTALK
  321. if(y.indexOf('>>>')!=-1){ // 不支持跨自定义组件的后代选择器 (转为普通的选择器即可跨组件查询)
  322. selector = y.split('>>>')[1].trim()
  323. }
  324. // #endif
  325. }
  326. uni.createSelectorQuery().select(selector).boundingClientRect(function(rect){
  327. if (rect) {
  328. let top = rect.top
  329. top += vm.mescroll.getScrollTop()
  330. uni.pageScrollTo({
  331. scrollTop: top,
  332. duration: t
  333. })
  334. } else{
  335. console.error(selector + ' does not exist');
  336. }
  337. }).exec()
  338. },30)
  339. } else{
  340. // 滚动到指定位置 (y必须为数字)
  341. uni.pageScrollTo({
  342. scrollTop: y,
  343. duration: t
  344. })
  345. }
  346. });
  347. // 具体的界面如果不配置up.toTop.safearea,则取本vue的safearea值
  348. if (vm.up && vm.up.toTop && vm.up.toTop.safearea != null) {} else {
  349. vm.mescroll.optUp.toTop.safearea = vm.safearea;
  350. }
  351. // 全局配置监听
  352. uni.$on("setMescrollGlobalOption", options=>{
  353. if(!options) return;
  354. let i18nType = options.i18n ? options.i18n.type : null
  355. if(i18nType && vm.mescroll.i18n.type != i18nType){
  356. vm.mescroll.i18n.type = i18nType
  357. mescrollI18n.setType(i18nType)
  358. MeScroll.extend(options, vm.mescroll.i18n[i18nType])
  359. }
  360. if(options.down){
  361. let down = MeScroll.extend({}, options.down)
  362. vm.mescroll.optDown = MeScroll.extend(down, vm.mescroll.optDown)
  363. }
  364. if(options.up){
  365. let up = MeScroll.extend({}, options.up)
  366. vm.mescroll.optUp = MeScroll.extend(up, vm.mescroll.optUp)
  367. }
  368. })
  369. },
  370. destroyed() {
  371. // 注销全局配置监听
  372. uni.$off("setMescrollGlobalOption")
  373. }
  374. };
  375. </script>
  376. <style>
  377. @import "../mescroll-body/mescroll-body.css";
  378. @import "../mescroll-uni/components/mescroll-down.css";
  379. @import "../mescroll-uni/components/mescroll-up.css";
  380. </style>