mescroll-body.vue 16 KB

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