u-tabs.vue 12 KB

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