mescroll-body.vue 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403
  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="./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 './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.js';
  70. // 引入全局配置
  71. import GlobalOption from './mescroll-uni-option.js';
  72. // 引入空布局组件
  73. import MescrollEmpty from './components/mescroll-empty.vue';
  74. // 引入国际化工具类
  75. import mescrollI18n from './mescroll-i18n.js';
  76. // 引入回到顶部组件
  77. import MescrollTop from './components/mescroll-top.vue';
  78. // 引入兼容wxs(含renderjs)写法的mixins
  79. import WxsMixin from './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. MescrollEmpty,
  106. MescrollTop
  107. },
  108. props: {
  109. down: Object,
  110. up: Object,
  111. i18n: Object,
  112. top: [String, Number],
  113. topbar: [Boolean, String],
  114. bottom: [String, Number],
  115. safearea: Boolean,
  116. height: [String, Number],
  117. bottombar:{
  118. type: Boolean,
  119. default: true
  120. },
  121. sticky: Boolean
  122. },
  123. data() {
  124. return {
  125. mescroll: {optDown:{},optUp:{}}, // mescroll实例
  126. downHight: 0, //下拉刷新: 容器高度
  127. downRate: 0, // 下拉比率(inOffset: rate<1; outOffset: rate>=1)
  128. downLoadType: 0, // 下拉刷新状态: 0(loading前), 1(inOffset), 2(outOffset), 3(showLoading), 4(endDownScroll)
  129. upLoadType: 0, // 上拉加载状态:0(loading前),1(loading中),2(没有更多了,显示END文本提示),3(没有更多了,不显示END文本提示)
  130. isShowEmpty: false, // 是否显示空布局
  131. isShowToTop: false, // 是否显示回到顶部按钮
  132. windowHeight: 0, // 可使用窗口的高度
  133. windowBottom: 0, // 可使用窗口的底部位置
  134. statusBarHeight: 0 // 状态栏高度
  135. };
  136. },
  137. computed: {
  138. // mescroll最小高度,默认windowHeight,使列表不满屏仍可下拉
  139. minHeight(){
  140. return this.toPx(this.height || '100%') + 'px'
  141. },
  142. // 下拉布局往下偏移的距离 (px)
  143. numTop() {
  144. return this.toPx(this.top)
  145. },
  146. padTop() {
  147. return this.numTop + 'px';
  148. },
  149. // 上拉布局往上偏移 (px)
  150. numBottom() {
  151. return this.toPx(this.bottom);
  152. },
  153. padBottom() {
  154. return this.numBottom + 'px';
  155. },
  156. // 是否为重置下拉的状态
  157. isDownReset() {
  158. return this.downLoadType === 3 || this.downLoadType === 4;
  159. },
  160. // 过渡
  161. transition() {
  162. return this.isDownReset ? 'transform 300ms' : '';
  163. },
  164. translateY() {
  165. return this.downHight > 0 ? 'translateY(' + this.downHight + 'px)' : ''; // transform会使fixed失效,需注意把fixed元素写在mescroll之外
  166. },
  167. // 是否在加载中
  168. isDownLoading(){
  169. return this.downLoadType === 3
  170. },
  171. // 旋转的角度
  172. downRotate(){
  173. return 'rotate(' + 360 * this.downRate + 'deg)'
  174. },
  175. // 文本提示
  176. downText(){
  177. if(!this.mescroll) return ""; // 避免头条小程序初始化时报错
  178. switch (this.downLoadType){
  179. case 1: return this.mescroll.optDown.textInOffset;
  180. case 2: return this.mescroll.optDown.textOutOffset;
  181. case 3: return this.mescroll.optDown.textLoading;
  182. case 4: return this.mescroll.isDownEndSuccess ? this.mescroll.optDown.textSuccess : this.mescroll.isDownEndSuccess==false ? this.mescroll.optDown.textErr : this.mescroll.optDown.textInOffset;
  183. default: return this.mescroll.optDown.textInOffset;
  184. }
  185. }
  186. },
  187. methods: {
  188. //number,rpx,upx,px,% --> px的数值
  189. toPx(num) {
  190. if (typeof num === 'string') {
  191. if (num.indexOf('px') !== -1) {
  192. if (num.indexOf('rpx') !== -1) {
  193. // "10rpx"
  194. num = num.replace('rpx', '');
  195. } else if (num.indexOf('upx') !== -1) {
  196. // "10upx"
  197. num = num.replace('upx', '');
  198. } else {
  199. // "10px"
  200. return Number(num.replace('px', ''));
  201. }
  202. } else if (num.indexOf('%') !== -1) {
  203. // 传百分比,则相对于windowHeight,传"10%"则等于windowHeight的10%
  204. let rate = Number(num.replace('%', '')) / 100;
  205. return this.windowHeight * rate;
  206. }
  207. }
  208. return num ? uni.upx2px(Number(num)) : 0;
  209. },
  210. // 点击空布局的按钮回调
  211. emptyClick() {
  212. this.$emit('emptyclick', this.mescroll);
  213. },
  214. // 点击回到顶部的按钮回调
  215. toTopClick() {
  216. this.mescroll.scrollTo(0, this.mescroll.optUp.toTop.duration); // 执行回到顶部
  217. this.$emit('topclick', this.mescroll); // 派发点击回到顶部按钮的回调
  218. }
  219. },
  220. // 使用created初始化mescroll对象; 如果用mounted部分css样式编译到H5会失效
  221. created() {
  222. let vm = this;
  223. let diyOption = {
  224. // 下拉刷新的配置
  225. down: {
  226. inOffset() {
  227. vm.downLoadType = 1; // 下拉的距离进入offset范围内那一刻的回调 (自定义mescroll组件时,此行不可删)
  228. },
  229. outOffset() {
  230. vm.downLoadType = 2; // 下拉的距离大于offset那一刻的回调 (自定义mescroll组件时,此行不可删)
  231. },
  232. onMoving(mescroll, rate, downHight) {
  233. // 下拉过程中的回调,滑动过程一直在执行;
  234. vm.downHight = downHight; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  235. vm.downRate = rate; //下拉比率 (inOffset: rate<1; outOffset: rate>=1)
  236. },
  237. showLoading(mescroll, downHight) {
  238. vm.downLoadType = 3; // 显示下拉刷新进度的回调 (自定义mescroll组件时,此行不可删)
  239. vm.downHight = downHight; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  240. },
  241. beforeEndDownScroll(mescroll){
  242. vm.downLoadType = 4;
  243. return mescroll.optDown.beforeEndDelay // 延时结束的时长
  244. },
  245. endDownScroll() {
  246. vm.downLoadType = 4; // 结束下拉 (自定义mescroll组件时,此行不可删)
  247. vm.downHight = 0; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  248. if(vm.downResetTimer) {clearTimeout(vm.downResetTimer); vm.downResetTimer = null} // 移除重置倒计时
  249. vm.downResetTimer = setTimeout(()=>{ // 过渡动画执行完毕后,需重置为0的状态,避免下次inOffset不及时显示textInOffset
  250. if(vm.downLoadType === 4) vm.downLoadType = 0
  251. },300)
  252. },
  253. // 派发下拉刷新的回调
  254. callback: function(mescroll) {
  255. vm.$emit('down', mescroll);
  256. }
  257. },
  258. // 上拉加载的配置
  259. up: {
  260. // 显示加载中的回调
  261. showLoading() {
  262. vm.upLoadType = 1;
  263. },
  264. // 显示无更多数据的回调
  265. showNoMore() {
  266. vm.upLoadType = 2;
  267. },
  268. // 隐藏上拉加载的回调
  269. hideUpScroll(mescroll) {
  270. vm.upLoadType = mescroll.optUp.hasNext ? 0 : 3;
  271. },
  272. // 空布局
  273. empty: {
  274. onShow(isShow) {
  275. // 显示隐藏的回调
  276. vm.isShowEmpty = isShow;
  277. }
  278. },
  279. // 回到顶部
  280. toTop: {
  281. onShow(isShow) {
  282. // 显示隐藏的回调
  283. vm.isShowToTop = isShow;
  284. }
  285. },
  286. // 派发上拉加载的回调
  287. callback: function(mescroll) {
  288. vm.$emit('up', mescroll);
  289. }
  290. }
  291. };
  292. let i18nType = mescrollI18n.getType() // 当前语言类型
  293. let i18nOption = {type: i18nType} // 国际化配置
  294. MeScroll.extend(i18nOption, vm.i18n) // 具体页面的国际化配置
  295. MeScroll.extend(i18nOption, GlobalOption.i18n) // 全局的国际化配置
  296. MeScroll.extend(diyOption, i18nOption[i18nType]); // 混入国际化配置
  297. MeScroll.extend(diyOption, {down:GlobalOption.down, up:GlobalOption.up}); // 混入全局的配置
  298. let myOption = JSON.parse(JSON.stringify({down: vm.down,up: vm.up})); // 深拷贝,避免对props的影响
  299. MeScroll.extend(myOption, diyOption); // 混入具体界面的配置
  300. // 初始化MeScroll对象
  301. vm.mescroll = new MeScroll(myOption, true); // 传入true,标记body为滚动区域
  302. // 挂载语言包
  303. vm.mescroll.i18n = i18nOption;
  304. // init回调mescroll对象
  305. vm.$emit('init', vm.mescroll);
  306. // 设置高度
  307. const sys = uni.getSystemInfoSync();
  308. if (sys.windowHeight) vm.windowHeight = sys.windowHeight;
  309. if (sys.windowBottom) vm.windowBottom = sys.windowBottom;
  310. if (sys.statusBarHeight) vm.statusBarHeight = sys.statusBarHeight;
  311. // 使down的bottomOffset生效
  312. vm.mescroll.setBodyHeight(sys.windowHeight);
  313. // 因为使用的是page的scroll,这里需自定义scrollTo
  314. vm.mescroll.resetScrollTo((y, t) => {
  315. if(typeof y === 'string'){
  316. // 滚动到指定view (y为css选择器)
  317. setTimeout(()=>{ // 延时确保view已渲染; 不使用$nextTick
  318. let selector;
  319. if(y.indexOf('#')==-1 && y.indexOf('.')==-1){
  320. selector = '#'+y // 不带#和. 则默认为id选择器
  321. }else{
  322. selector = y
  323. // #ifdef APP-PLUS || H5 || MP-ALIPAY || MP-DINGTALK
  324. if(y.indexOf('>>>')!=-1){ // 不支持跨自定义组件的后代选择器 (转为普通的选择器即可跨组件查询)
  325. selector = y.split('>>>')[1].trim()
  326. }
  327. // #endif
  328. }
  329. uni.createSelectorQuery().select(selector).boundingClientRect(function(rect){
  330. if (rect) {
  331. let top = rect.top
  332. top += vm.mescroll.getScrollTop()
  333. uni.pageScrollTo({
  334. scrollTop: top,
  335. duration: t
  336. })
  337. } else{
  338. console.error(selector + ' does not exist');
  339. }
  340. }).exec()
  341. },30)
  342. } else{
  343. // 滚动到指定位置 (y必须为数字)
  344. uni.pageScrollTo({
  345. scrollTop: y,
  346. duration: t
  347. })
  348. }
  349. });
  350. // 具体的界面如果不配置up.toTop.safearea,则取本vue的safearea值
  351. if (vm.up && vm.up.toTop && vm.up.toTop.safearea != null) {} else {
  352. vm.mescroll.optUp.toTop.safearea = vm.safearea;
  353. }
  354. // 全局配置监听
  355. uni.$on("setMescrollGlobalOption", options=>{
  356. if(!options) return;
  357. let i18nType = options.i18n ? options.i18n.type : null
  358. if(i18nType && vm.mescroll.i18n.type != i18nType){
  359. vm.mescroll.i18n.type = i18nType
  360. mescrollI18n.setType(i18nType)
  361. MeScroll.extend(options, vm.mescroll.i18n[i18nType])
  362. }
  363. if(options.down){
  364. let down = MeScroll.extend({}, options.down)
  365. vm.mescroll.optDown = MeScroll.extend(down, vm.mescroll.optDown)
  366. }
  367. if(options.up){
  368. let up = MeScroll.extend({}, options.up)
  369. vm.mescroll.optUp = MeScroll.extend(up, vm.mescroll.optUp)
  370. }
  371. })
  372. },
  373. destroyed() {
  374. // 注销全局配置监听
  375. uni.$off("setMescrollGlobalOption")
  376. }
  377. };
  378. </script>
  379. <style>
  380. @import "./mescroll-body.css";
  381. @import "./components/mescroll-down.css";
  382. @import './components/mescroll-up.css';
  383. </style>