mescroll-uni.vue 18 KB

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