u-tabs.vue 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369
  1. <template>
  2. <view class="u-tabs" :style="{
  3. background: bgColor
  4. }">
  5. <!-- $u.getRect()对组件根节点无效,因为写了.in(this),故这里获取内层接点尺寸 -->
  6. <view :id="id">
  7. <scroll-view scroll-x class="u-scroll-view" :scroll-left="scrollLeft" scroll-with-animation>
  8. <view class="u-scroll-box" :class="{'u-tabs-scorll-flex': !isScroll}">
  9. <view class="u-tab-item u-line-1" :id="'u-tab-item-' + index" v-for="(item, index) in list" :key="index" @tap="clickTab(index)"
  10. :style="[tabItemStyle(index)]">
  11. <u-badge :count="item[count] || item['count'] || 0" :offset="offset" size="mini"></u-badge>
  12. {{ item[name] || item['name']}}
  13. </view>
  14. <view v-if="showBar" class="u-tab-bar" :style="[tabBarStyle]"></view>
  15. </view>
  16. </scroll-view>
  17. </view>
  18. </view>
  19. </template>
  20. <script>
  21. /**
  22. * tabs 标签
  23. * @description 该组件,是一个tabs标签组件,在标签多的时候,可以配置为左右滑动,标签少的时候,可以禁止滑动。 该组件的一个特点是配置为滚动模式时,激活的tab会自动移动到组件的中间位置。
  24. * @tutorial https://www.uviewui.com/components/tabs.html
  25. * @property {Boolean} is-scroll tabs是否可以左右拖动(默认true)
  26. * @property {Array} list 标签数组,元素为对象,如[{name: '推荐'}]
  27. * @property {String Number} current 指定哪个tab为激活状态(默认0)
  28. * @property {String Number} height 导航栏的高度,单位rpx(默认80)
  29. * @property {String Number} font-size tab文字大小,单位rpx(默认30)
  30. * @property {String Number} duration 滑块移动一次所需的时间,单位秒(默认0.5)
  31. * @property {String} active-color 滑块和激活tab文字的颜色(默认#2979ff)
  32. * @property {String} inactive-color tabs文字颜色(默认#303133)
  33. * @property {String Number} bar-width 滑块宽度,单位rpx(默认40)
  34. * @property {Object} active-item-style 活动tabs item的样式,对象形式
  35. * @property {Object} bar-style 底部滑块的样式,对象形式
  36. * @property {Boolean} show-bar 是否显示底部的滑块(默认true)
  37. * @property {String Number} bar-height 滑块高度,单位rpx(默认6)
  38. * @property {String Number} item-width 标签的宽度(默认auto)
  39. * @property {String Number} gutter 单个tab标签的左右内边距之和,单位rpx(默认40)
  40. * @property {String} bg-color tabs导航栏的背景颜色(默认#ffffff)
  41. * @property {String} name 组件内部读取的list参数中的属性名(tab名称),见官网说明(默认name)
  42. * @property {String} count 组件内部读取的list参数中的属性名(badge徽标数),同name属性的使用,见官网说明(默认count)
  43. * @property {Array} offset 设置badge徽标数的位置偏移,格式为 [x, y],也即设置的为top和right的值,单位rpx(默认[5, 20])
  44. * @property {Boolean} bold 激活选项的字体是否加粗(默认true)
  45. * @event {Function} change 点击标签时触发
  46. * @example <u-tabs ref="tabs" :list="list" :is-scroll="false"></u-tabs>
  47. */
  48. export default {
  49. name: "u-tabs",
  50. props: {
  51. // 导航菜单是否需要滚动,如只有2或者3个的时候,就不需要滚动了,此时使用flex平分tab的宽度
  52. isScroll: {
  53. type: Boolean,
  54. default: true
  55. },
  56. //需循环的标签列表
  57. list: {
  58. type: Array,
  59. default () {
  60. return [];
  61. }
  62. },
  63. // 当前活动tab的索引
  64. current: {
  65. type: [Number, String],
  66. default: 0
  67. },
  68. // 导航栏的高度和行高
  69. height: {
  70. type: [String, Number],
  71. default: 80
  72. },
  73. // 字体大小
  74. fontSize: {
  75. type: [String, Number],
  76. default: 30
  77. },
  78. // 过渡动画时长, 单位ms
  79. duration: {
  80. type: [String, Number],
  81. default: 0.5
  82. },
  83. // 选中项的主题颜色
  84. activeColor: {
  85. type: String,
  86. default: '#2979ff'
  87. },
  88. // 未选中项的颜色
  89. inactiveColor: {
  90. type: String,
  91. default: '#303133'
  92. },
  93. // 菜单底部移动的bar的宽度,单位rpx
  94. barWidth: {
  95. type: [String, Number],
  96. default: 40
  97. },
  98. // 移动bar的高度
  99. barHeight: {
  100. type: [String, Number],
  101. default: 6
  102. },
  103. // 单个tab的左或有内边距(左右相同)
  104. gutter: {
  105. type: [String, Number],
  106. default: 30
  107. },
  108. // 导航栏的背景颜色
  109. bgColor: {
  110. type: String,
  111. default: '#ffffff'
  112. },
  113. // 读取传入的数组对象的属性(tab名称)
  114. name: {
  115. type: String,
  116. default: 'name'
  117. },
  118. // 读取传入的数组对象的属性(徽标数)
  119. count: {
  120. type: String,
  121. default: 'count'
  122. },
  123. // 徽标数位置偏移
  124. offset: {
  125. type: Array,
  126. default: () => {
  127. return [5, 20]
  128. }
  129. },
  130. // 活动tab字体是否加粗
  131. bold: {
  132. type: Boolean,
  133. default: true
  134. },
  135. // 当前活动tab item的样式
  136. activeItemStyle: {
  137. type: Object,
  138. default() {
  139. return {}
  140. }
  141. },
  142. // 是否显示底部的滑块
  143. showBar: {
  144. type: Boolean,
  145. default: true
  146. },
  147. // 底部滑块的自定义样式
  148. barStyle: {
  149. type: Object,
  150. default() {
  151. return {}
  152. }
  153. },
  154. // 标签的宽度
  155. itemWidth: {
  156. type: [Number, String],
  157. default: 'auto'
  158. }
  159. },
  160. data() {
  161. return {
  162. scrollLeft: 0, // 滚动scroll-view的左边滚动距离
  163. tabQueryInfo: [], // 存放对tab菜单查询后的节点信息
  164. componentWidth: 0, // 屏幕宽度,单位为px
  165. scrollBarLeft: 0, // 移动bar需要通过translateX()移动的距离
  166. parentLeft: 0, // 父元素(tabs组件)到屏幕左边的距离
  167. id: this.$u.guid(), // id值
  168. currentIndex: this.current,
  169. barFirstTimeMove: true, // 滑块第一次移动时(页面刚生成时),无需动画,否则给人怪异的感觉
  170. };
  171. },
  172. watch: {
  173. // 监听tab的变化,重新计算tab菜单的布局信息,因为实际使用中菜单可能是通过
  174. // 后台获取的(如新闻app顶部的菜单),获取返回需要一定时间,所以list变化时,重新获取布局信息
  175. list(n, o) {
  176. // list变动时,重制内部索引,否则可能导致超出数组边界的情况
  177. if(n.length !== o.length) this.currentIndex = 0;
  178. // 用$nextTick等待视图更新完毕后再计算tab的局部信息,否则可能因为tab还没生成就获取,就会有问题
  179. this.$nextTick(() => {
  180. this.init();
  181. });
  182. },
  183. current: {
  184. immediate: true,
  185. handler(nVal, oVal) {
  186. // 视图更新后再执行移动操作
  187. this.$nextTick(() => {
  188. this.currentIndex = nVal;
  189. this.scrollByIndex();
  190. });
  191. }
  192. },
  193. },
  194. computed: {
  195. // 移动bar的样式
  196. tabBarStyle() {
  197. let style = {
  198. width: this.barWidth + 'rpx',
  199. transform: `translate(${this.scrollBarLeft}px, -100%)`,
  200. // 滑块在页面渲染后第一次滑动时,无需动画效果
  201. 'transition-duration': `${this.barFirstTimeMove ? 0 : this.duration }s`,
  202. 'background-color': this.activeColor,
  203. height: this.barHeight + 'rpx',
  204. opacity: this.barFirstTimeMove ? 0 : 1,
  205. // 设置一个很大的值,它会自动取能用的最大值,不用高度的一半,是因为高度可能是单数,会有小数出现
  206. 'border-radius': `${this.barHeight / 2}px`
  207. };
  208. Object.assign(style, this.barStyle);
  209. return style;
  210. },
  211. // tab的样式
  212. tabItemStyle() {
  213. return (index) => {
  214. let style = {
  215. height: this.height + 'rpx',
  216. 'line-height': this.height + 'rpx',
  217. 'font-size': this.fontSize + 'rpx',
  218. 'transition-duration': `${this.duration}s`,
  219. padding: this.isScroll ? `0 ${this.gutter}rpx` : '',
  220. flex: this.isScroll ? 'auto' : '1',
  221. width: this.$u.addUnit(this.itemWidth)
  222. };
  223. // 字体加粗
  224. if (index == this.currentIndex && this.bold) style.fontWeight = 'bold';
  225. if (index == this.currentIndex) {
  226. style.color = this.activeColor;
  227. // 给选中的tab item添加外部自定义的样式
  228. style = Object.assign(style, this.activeItemStyle);
  229. } else {
  230. style.color = this.inactiveColor;
  231. }
  232. return style;
  233. }
  234. }
  235. },
  236. methods: {
  237. // 设置一个init方法,方便多处调用
  238. async init() {
  239. // 获取tabs组件的尺寸信息
  240. let tabRect = await this.$uGetRect('#' + this.id);
  241. // tabs组件距离屏幕左边的宽度
  242. this.parentLeft = tabRect.left;
  243. // tabs组件的宽度
  244. this.componentWidth = tabRect.width;
  245. this.getTabRect();
  246. },
  247. // 点击某一个tab菜单
  248. clickTab(index) {
  249. // 点击当前活动tab,不触发事件
  250. if(index == this.currentIndex) return ;
  251. // 发送事件给父组件
  252. this.$emit('change', index);
  253. },
  254. // 查询tab的布局信息
  255. getTabRect() {
  256. // 创建节点查询
  257. let query = uni.createSelectorQuery().in(this);
  258. // 历遍所有tab,这里是执行了查询,最终使用exec()会一次性返回查询的数组结果
  259. for (let i = 0; i < this.list.length; i++) {
  260. // 只要size和rect两个参数
  261. query.select(`#u-tab-item-${i}`).fields({
  262. size: true,
  263. rect: true
  264. });
  265. }
  266. // 执行查询,一次性获取多个结果
  267. query.exec(
  268. function(res) {
  269. this.tabQueryInfo = res;
  270. // 初始化滚动条和移动bar的位置
  271. this.scrollByIndex();
  272. }.bind(this)
  273. );
  274. },
  275. // 滚动scroll-view,让活动的tab处于屏幕的中间位置
  276. scrollByIndex() {
  277. // 当前活动tab的布局信息,有tab菜单的width和left(为元素左边界到父元素左边界的距离)等信息
  278. let tabInfo = this.tabQueryInfo[this.currentIndex];
  279. if (!tabInfo) return;
  280. // 活动tab的宽度
  281. let tabWidth = tabInfo.width;
  282. // 活动item的左边到tabs组件左边的距离,用item的left减去tabs的left
  283. let offsetLeft = tabInfo.left - this.parentLeft;
  284. // 将活动的tabs-item移动到屏幕正中间,实际上是对scroll-view的移动
  285. let scrollLeft = offsetLeft - (this.componentWidth - tabWidth) / 2;
  286. this.scrollLeft = scrollLeft < 0 ? 0 : scrollLeft;
  287. // 当前活动item的中点点到左边的距离减去滑块宽度的一半,即可得到滑块所需的移动距离
  288. let left = tabInfo.left + tabInfo.width / 2 - this.parentLeft;
  289. // 计算当前活跃item到组件左边的距离
  290. this.scrollBarLeft = left - uni.upx2px(this.barWidth) / 2;
  291. // 第一次移动滑块的时候,barFirstTimeMove为true,放到延时中将其设置false
  292. // 延时是因为scrollBarLeft作用于computed计算时,需要一个过程需,否则导致出错
  293. if(this.barFirstTimeMove == true) {
  294. setTimeout(() => {
  295. this.barFirstTimeMove = false;
  296. }, 100)
  297. }
  298. }
  299. },
  300. mounted() {
  301. this.init();
  302. }
  303. };
  304. </script>
  305. <style lang="scss" scoped>
  306. @import "../../libs/css/style.components.scss";
  307. view,
  308. scroll-view {
  309. box-sizing: border-box;
  310. }
  311. /* #ifndef APP-NVUE */
  312. ::-webkit-scrollbar,
  313. ::-webkit-scrollbar,
  314. ::-webkit-scrollbar {
  315. display: none;
  316. width: 0 !important;
  317. height: 0 !important;
  318. -webkit-appearance: none;
  319. background: transparent;
  320. }
  321. /* #endif */
  322. .u-scroll-box {
  323. position: relative;
  324. /* #ifdef MP-TOUTIAO */
  325. white-space: nowrap;
  326. /* #endif */
  327. }
  328. /* #ifdef H5 */
  329. // 通过样式穿透,隐藏H5下,scroll-view下的滚动条
  330. scroll-view ::v-deep ::-webkit-scrollbar {
  331. display: none;
  332. width: 0 !important;
  333. height: 0 !important;
  334. -webkit-appearance: none;
  335. background: transparent;
  336. }
  337. /* #endif */
  338. .u-scroll-view {
  339. width: 100%;
  340. white-space: nowrap;
  341. position: relative;
  342. }
  343. .u-tab-item {
  344. position: relative;
  345. /* #ifndef APP-NVUE */
  346. display: inline-block;
  347. /* #endif */
  348. text-align: center;
  349. transition-property: background-color, color;
  350. }
  351. .u-tab-bar {
  352. position: absolute;
  353. bottom: 0;
  354. }
  355. .u-tabs-scorll-flex {
  356. @include vue-flex;
  357. justify-content: space-between;
  358. }
  359. </style>