You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

437 lines
18 KiB

3 years ago
  1. <template>
  2. <view class="mescroll-uni-warp">
  3. <scroll-view :id="viewId" class="mescroll-uni" :class="{'mescroll-uni-fixed':isFixed}" :style="{'height':scrollHeight,'padding-top':padTop,'padding-bottom':padBottom,'top':fixedTop,'bottom':fixedBottom}" :scroll-top="scrollTop" :scroll-with-animation="scrollAnim" @scroll="scroll" :scroll-y='scrollable' :enable-back-to-top="true" :throttle="false">
  4. <view class="mescroll-uni-content mescroll-render-touch"
  5. @touchstart="wxsBiz.touchstartEvent"
  6. @touchmove="wxsBiz.touchmoveEvent"
  7. @touchend="wxsBiz.touchendEvent"
  8. @touchcancel="wxsBiz.touchendEvent"
  9. :change:prop="wxsBiz.propObserver"
  10. :prop="wxsProp">
  11. <!-- 状态栏 -->
  12. <view v-if="topbar&&statusBarHeight" class="mescroll-topbar" :style="{height: statusBarHeight+'px', background: topbar}"></view>
  13. <view class="mescroll-wxs-content" :style="{'transform': translateY, 'transition': transition}" :change:prop="wxsBiz.callObserver" :prop="callProp">
  14. <!-- 下拉加载区域 (支付宝小程序子组件传参给子子组件仍报单项数据流的异常,暂时不通过mescroll-down组件实现)-->
  15. <!-- <mescroll-down :option="mescroll.optDown" :type="downLoadType"></mescroll-down> -->
  16. <view v-if="mescroll.optDown.use" class="mescroll-downwarp" :style="{'background':mescroll.optDown.bgColor,'color':mescroll.optDown.textColor}">
  17. <view class="downwarp-content">
  18. <image class="downwarp-slogan" src="https://www.mescroll.com/img/beibei/mescroll-slogan.jpg?v=1" mode="widthFix"/>
  19. <view v-if="isDownLoading" class="downwarp-loading mescroll-rotate"></view>
  20. <view v-else class="downwarp-progress" :style="{'transform':downRotate}"></view>
  21. <view class="downwarp-mascot"></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端生效) -->
  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. </view>
  47. </scroll-view>
  48. <!-- 回到顶部按钮 (fixed元素,需写在scroll-view外面,防止滚动的时候抖动)-->
  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. import MeScroll from '../../mescroll-uni/mescroll-uni.js';
  71. import MescrollTop from '../../mescroll-uni/components/mescroll-top.vue';
  72. import WxsMixin from '../../mescroll-uni/wxs/mixins.js';
  73. import mescrollI18n from '../../mescroll-uni/mescroll-i18n.js';
  74. import GlobalOption from './mescroll-uni-option.js';
  75. export default {
  76. mixins: [WxsMixin],
  77. components: {
  78. MescrollTop
  79. },
  80. data() {
  81. return {
  82. mescroll: null, // mescroll实例
  83. viewId: 'id_' + Math.random().toString(36).substr(2,16), // 随机生成mescroll的id(不能数字开头,否则找不到元素)
  84. downHight: 0, //下拉刷新: 容器高度
  85. downLoadType: 0, // 下拉刷新状态: 0(loading前), 1(inOffset), 2(outOffset), 3(showLoading), 4(endDownScroll)
  86. upLoadType: 0, // 上拉加载状态: 0(loading前), 1loading中, 2没有更多了,显示END文本提示, 3(没有更多了,不显示END文本提示)
  87. isShowEmpty: false, // 是否显示空布局
  88. isShowToTop: false, // 是否显示回到顶部按钮
  89. scrollTop: 0, // 滚动条的位置
  90. scrollAnim: false, // 是否开启滚动动画
  91. windowTop: 0, // 可使用窗口的顶部位置
  92. windowBottom: 0, // 可使用窗口的底部位置
  93. windowHeight: 0, // 可使用窗口的高度
  94. statusBarHeight: 0 // 状态栏高度
  95. }
  96. },
  97. props: {
  98. down: Object, // 下拉刷新的参数配置
  99. up: Object, // 上拉加载的参数配置
  100. i18n: Object, // 国际化的参数配置
  101. top: [String, Number], // 下拉布局往下的偏移量 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx, 百分比则相对于windowHeight)
  102. topbar: [Boolean, String], // top的偏移量是否加上状态栏高度, 默认false (使用场景:取消原生导航栏时,配置此项可留出状态栏的占位, 支持传入字符串背景,如色值,背景图,渐变)
  103. bottom: [String, Number], // 上拉布局往上的偏移量 (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx, 百分比则相对于windowHeight)
  104. safearea: Boolean, // bottom的偏移量是否加上底部安全区的距离, 默认false (需要适配iPhoneX时使用)
  105. fixed: { // 是否通过fixed固定mescroll的高度, 默认true
  106. type: Boolean,
  107. default: true
  108. },
  109. height: [String, Number], // 指定mescroll的高度, 此项有值,则不使用fixed. (支持20, "20rpx", "20px", "20%"格式的值, 其中纯数字则默认单位rpx, 百分比则相对于windowHeight)
  110. bottombar:{ // 底部是否偏移TabBar的高度(默认仅在H5端的tab页生效)
  111. type: Boolean,
  112. default: true
  113. },
  114. disableScroll: Boolean // 是否禁止滚动
  115. },
  116. computed: {
  117. // 是否使用fixed定位 (当height有值,则不使用)
  118. isFixed(){
  119. return !this.height && this.fixed
  120. },
  121. // mescroll的高度
  122. scrollHeight(){
  123. if (this.isFixed) {
  124. return "auto"
  125. } else if(this.height){
  126. return this.toPx(this.height) + 'px'
  127. }else{
  128. return "100%"
  129. }
  130. },
  131. // 下拉布局往下偏移的距离 (px)
  132. numTop() {
  133. return this.toPx(this.top)
  134. },
  135. fixedTop() {
  136. return this.isFixed ? (this.numTop + this.windowTop) + 'px' : 0
  137. },
  138. padTop() {
  139. return !this.isFixed ? this.numTop + 'px' : 0
  140. },
  141. // 上拉布局往上偏移 (px)
  142. numBottom() {
  143. return this.toPx(this.bottom)
  144. },
  145. fixedBottom() {
  146. return this.isFixed ? (this.numBottom + this.windowBottom) + 'px' : 0
  147. },
  148. padBottom() {
  149. return !this.isFixed ? this.numBottom + 'px' : 0
  150. },
  151. // 是否为重置下拉的状态
  152. isDownReset(){
  153. return this.downLoadType===3 || this.downLoadType===4
  154. },
  155. // 过渡
  156. transition() {
  157. return this.isDownReset ? 'transform 300ms' : ''
  158. },
  159. translateY() {
  160. return this.downHight > 0 ? 'translateY(' + this.downHight + 'px)' : '' // transform会使fixed失效,需注意把fixed元素写在mescroll之外
  161. },
  162. // 列表是否可滑动
  163. scrollable(){
  164. if(this.disableScroll) return false
  165. return this.downLoadType===0 || this.isDownReset
  166. },
  167. // 是否在加载中
  168. isDownLoading(){
  169. return this.downLoadType === 3
  170. },
  171. // 旋转的角度
  172. downRotate(){
  173. return this.downLoadType === 2 ? 'rotate(180deg)' : 'rotate(0deg)'
  174. }
  175. },
  176. methods: {
  177. //number,rpx,upx,px,% --> px的数值
  178. toPx(num){
  179. if(typeof num === "string"){
  180. if (num.indexOf('px') !== -1) {
  181. if(num.indexOf('rpx') !== -1) { // "10rpx"
  182. num = num.replace('rpx', '');
  183. } else if(num.indexOf('upx') !== -1) { // "10upx"
  184. num = num.replace('upx', '');
  185. } else { // "10px"
  186. return Number(num.replace('px', ''))
  187. }
  188. }else if (num.indexOf('%') !== -1){
  189. // 传百分比,则相对于windowHeight,传"10%"则等于windowHeight的10%
  190. let rate = Number(num.replace("%","")) / 100
  191. return this.windowHeight * rate
  192. }
  193. }
  194. return num ? uni.upx2px(Number(num)) : 0
  195. },
  196. //注册列表滚动事件,用于下拉刷新和上拉加载
  197. scroll(e) {
  198. this.mescroll.scroll(e.detail, () => {
  199. this.$emit('scroll', this.mescroll) // 此时可直接通过 this.mescroll.scrollTop获取滚动条位置; this.mescroll.isScrollUp获取是否向上滑动
  200. })
  201. },
  202. // 点击空布局的按钮回调
  203. emptyClick() {
  204. this.$emit('emptyclick', this.mescroll)
  205. },
  206. // 点击回到顶部的按钮回调
  207. toTopClick() {
  208. this.mescroll.scrollTo(0, this.mescroll.optUp.toTop.duration); // 执行回到顶部
  209. this.$emit('topclick', this.mescroll); // 派发点击回到顶部按钮的回调
  210. },
  211. // 更新滚动区域的高度 (使内容不满屏和到底,都可继续翻页)
  212. setClientHeight() {
  213. if (this.mescroll.getClientHeight(true) === 0 && !this.isExec) {
  214. this.isExec = true; // 避免多次获取
  215. this.$nextTick(() => { // 确保dom已渲染
  216. this.getClientInfo(data=>{
  217. this.isExec = false;
  218. if (data) {
  219. this.mescroll.setClientHeight(data.height);
  220. } else if (this.clientNum != 3) { // 极少部分情况,可能dom还未渲染完毕,递归获取,最多重试3次
  221. this.clientNum = this.clientNum == null ? 1 : this.clientNum + 1;
  222. setTimeout(() => {
  223. this.setClientHeight()
  224. }, this.clientNum * 100)
  225. }
  226. })
  227. })
  228. }
  229. },
  230. // 获取滚动区域的信息
  231. getClientInfo(success){
  232. let query = uni.createSelectorQuery();
  233. // #ifndef MP-ALIPAY || MP-DINGTALK
  234. query = query.in(this) // 支付宝小程序不支持in(this),而字节跳动小程序必须写in(this), 否则都取不到值
  235. // #endif
  236. let view = query.select('#' + this.viewId);
  237. view.boundingClientRect(data => {
  238. success(data)
  239. }).exec();
  240. }
  241. },
  242. // 使用created初始化mescroll对象; 如果用mounted部分css样式编译到H5会失效
  243. created() {
  244. let vm = this;
  245. let diyOption = {
  246. // 下拉刷新的配置
  247. down: {
  248. inOffset() {
  249. vm.downLoadType = 1; // 下拉的距离进入offset范围内那一刻的回调 (自定义mescroll组件时,此行不可删)
  250. },
  251. outOffset() {
  252. vm.downLoadType = 2; // 下拉的距离大于offset那一刻的回调 (自定义mescroll组件时,此行不可删)
  253. },
  254. onMoving(mescroll, rate, downHight) {
  255. // 下拉过程中的回调,滑动过程一直在执行;
  256. vm.downHight = downHight; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  257. },
  258. showLoading(mescroll, downHight) {
  259. vm.downLoadType = 3; // 显示下拉刷新进度的回调 (自定义mescroll组件时,此行不可删)
  260. vm.downHight = downHight; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  261. },
  262. endDownScroll() {
  263. vm.downLoadType = 4; // 结束下拉 (自定义mescroll组件时,此行不可删)
  264. vm.downHight = 0; // 设置下拉区域的高度 (自定义mescroll组件时,此行不可删)
  265. vm.downResetTimer && clearTimeout(vm.downResetTimer)
  266. vm.downResetTimer = setTimeout(()=>{ // 过渡动画执行完毕后,需重置为0的状态,以便置空this.transition,避免iOS小程序列表渲染不完整
  267. if(vm.downLoadType===4) vm.downLoadType = 0
  268. },300)
  269. },
  270. // 派发下拉刷新的回调
  271. callback: function(mescroll) {
  272. vm.$emit('down', mescroll)
  273. }
  274. },
  275. // 上拉加载的配置
  276. up: {
  277. // 显示加载中的回调
  278. showLoading() {
  279. vm.upLoadType = 1;
  280. },
  281. // 显示无更多数据的回调
  282. showNoMore() {
  283. vm.upLoadType = 2;
  284. },
  285. // 隐藏上拉加载的回调
  286. hideUpScroll(mescroll) {
  287. vm.upLoadType = mescroll.optUp.hasNext ? 0 : 3;
  288. },
  289. // 空布局
  290. empty: {
  291. onShow(isShow) { // 显示隐藏的回调
  292. vm.isShowEmpty = isShow;
  293. }
  294. },
  295. // 回到顶部
  296. toTop: {
  297. onShow(isShow) { // 显示隐藏的回调
  298. vm.isShowToTop = isShow;
  299. }
  300. },
  301. // 派发上拉加载的回调
  302. callback: function(mescroll) {
  303. vm.$emit('up', mescroll);
  304. // 更新容器的高度 (多mescroll的情况)
  305. vm.setClientHeight()
  306. }
  307. }
  308. }
  309. let i18nType = mescrollI18n.getType() // 当前语言类型
  310. let i18nOption = {type: i18nType} // 国际化配置
  311. MeScroll.extend(i18nOption, vm.i18n) // 具体页面的国际化配置
  312. MeScroll.extend(i18nOption, GlobalOption.i18n) // 全局的国际化配置
  313. MeScroll.extend(diyOption, i18nOption[i18nType]); // 混入国际化配置
  314. MeScroll.extend(diyOption, {down:GlobalOption.down, up:GlobalOption.up}); // 混入全局的配置
  315. let myOption = JSON.parse(JSON.stringify({'down': vm.down,'up': vm.up})) // 深拷贝,避免对props的影响
  316. MeScroll.extend(myOption, diyOption); // 混入具体界面的配置
  317. // 初始化MeScroll对象
  318. vm.mescroll = new MeScroll(myOption);
  319. vm.mescroll.viewId = vm.viewId; // 附带id
  320. // 挂载语言包
  321. vm.mescroll.i18n = i18nOption;
  322. // init回调mescroll对象
  323. vm.$emit('init', vm.mescroll);
  324. // 设置高度
  325. const sys = uni.getSystemInfoSync();
  326. if(sys.windowTop) vm.windowTop = sys.windowTop;
  327. if(sys.windowBottom) vm.windowBottom = sys.windowBottom;
  328. if(sys.windowHeight) vm.windowHeight = sys.windowHeight;
  329. if(sys.statusBarHeight) vm.statusBarHeight = sys.statusBarHeight;
  330. // 使down的bottomOffset生效
  331. vm.mescroll.setBodyHeight(sys.windowHeight);
  332. // 因为使用的是scrollview,这里需自定义scrollTo
  333. vm.mescroll.resetScrollTo((y, t) => {
  334. vm.scrollAnim = (t !== 0); // t为0,则不使用动画过渡
  335. if(typeof y === 'string'){
  336. // 小程序不支持slot里面的scroll-into-view, 统一使用计算的方式实现
  337. vm.getClientInfo(function(rect){
  338. let mescrollTop = rect.top // mescroll到顶部的距离
  339. let selector;
  340. if(y.indexOf('#')==-1 && y.indexOf('.')==-1){
  341. selector = '#'+y // 不带#和. 则默认为id选择器
  342. }else{
  343. selector = y
  344. // #ifdef APP-PLUS || H5 || MP-ALIPAY || MP-DINGTALK
  345. if(y.indexOf('>>>')!=-1){ // 不支持跨自定义组件的后代选择器 (转为普通的选择器即可跨组件查询)
  346. selector = y.split('>>>')[1].trim()
  347. }
  348. // #endif
  349. }
  350. uni.createSelectorQuery().select(selector).boundingClientRect(function(rect){
  351. if (rect) {
  352. let curY = vm.mescroll.getScrollTop()
  353. let top = rect.top - mescrollTop
  354. top += curY
  355. if(!vm.isFixed) top -= vm.numTop
  356. vm.scrollTop = curY;
  357. vm.$nextTick(function() {
  358. vm.scrollTop = top
  359. })
  360. } else{
  361. console.error(selector + ' does not exist');
  362. }
  363. }).exec()
  364. })
  365. return;
  366. }
  367. let curY = vm.mescroll.getScrollTop()
  368. if (t === 0 || t === 300) { // 当t使用默认配置的300时,则使用系统自带的动画过渡
  369. vm.scrollTop = curY;
  370. vm.$nextTick(function() {
  371. vm.scrollTop = y
  372. })
  373. } else {
  374. vm.mescroll.getStep(curY, y, step => { // 此写法可支持配置t
  375. vm.scrollTop = step
  376. }, t)
  377. }
  378. })
  379. // 具体的界面如果不配置up.toTop.safearea,则取本vue的safearea值
  380. if (vm.up && vm.up.toTop && vm.up.toTop.safearea != null) {} else {
  381. vm.mescroll.optUp.toTop.safearea = vm.safearea;
  382. }
  383. // 全局配置监听
  384. uni.$on("setMescrollGlobalOption", options=>{
  385. if(!options) return;
  386. let i18nType = options.i18n ? options.i18n.type : null
  387. if(i18nType && vm.mescroll.i18n.type != i18nType){
  388. vm.mescroll.i18n.type = i18nType
  389. mescrollI18n.setType(i18nType)
  390. MeScroll.extend(options, vm.mescroll.i18n[i18nType])
  391. }
  392. if(options.down){
  393. let down = MeScroll.extend({}, options.down)
  394. vm.mescroll.optDown = MeScroll.extend(down, vm.mescroll.optDown)
  395. }
  396. if(options.up){
  397. let up = MeScroll.extend({}, options.up)
  398. vm.mescroll.optUp = MeScroll.extend(up, vm.mescroll.optUp)
  399. }
  400. })
  401. },
  402. mounted() {
  403. // 设置容器的高度
  404. this.setClientHeight()
  405. },
  406. destroyed() {
  407. // 注销全局配置监听
  408. uni.$off("setMescrollGlobalOption")
  409. }
  410. }
  411. </script>
  412. <style>
  413. @import "../../mescroll-uni/mescroll-uni.css";
  414. @import "../../mescroll-uni/components/mescroll-down.css";
  415. @import "../../mescroll-uni/components/mescroll-up.css";
  416. @import "./components/mescroll-down.css";
  417. </style>