mint-ui 源码学习二 —— picker 选择器组件源码学习

在 mint-ui 中,picker 是很常用也比较复杂的一个组件,让我们拆解这个组件看看它是如何实现的。

整体结构

来看看 picker 的整体结构:

picker.vue

<div class="picker" :class="{ 'picker-3d': rotateEffect }">
  <!-- 顶部工具栏区域 -->
  <div class="picker-toolbar" v-if="showToolbar"><slot></slot></div>
  <div class="picker-items">
    <!-- picker 列 -->
    <picker-slot v-for="slot in slots"></picker-slot>
    <!-- 标识选中区域 -->
    <div class="picker-center-highlight" :style="{ height: itemHeight + 'px', marginTop: -itemHeight / 2 + 'px' }"></div>
  </div>
</div>

从代码中可以发现单个滚动组件其实是 picker-slot 组件,而 picker 只是做了个外部容器并且提供了各种 set 和 get 方法用来操作组件和获取数据。下面是 picker 提供的方法

picker 中的方法

method: {
  slotValueChange () {}, // 触发 picker 的 change 事件
  getSlot (slotIndex) {}, // 过去某一列 slot
  getSlotValue (index) {}, // 获取某一列 slot 的当前值
  setSlotValue (index, value) {}, // 设置某一列 slot 的当前值
  getSlotValues (index) {}, // 获取 slot 的 values
  setSlotValues (index, values) {}, // 设置 slot 的 values
  getValues () {}, // 获取多个组件合成的值
  setValues (values) {} // 同时设置多列 slot 的值
}

然后看下 picker-slot 组件的整体结构~

picker-slot.vue

  <div class="picker-slot" :class="classNames" :style="flexStyle">
    <div v-if="!divider" ref="wrapper" class="picker-slot-wrapper" :class="{ dragging: dragging }" :style="{ height: contentHeight + 'px' }">
      <div class="picker-item" v-for="itemValue in mutatingValues" :key="itemValue" :class="{ 'picker-selected': itemValue === currentValue }" :style="{ height: itemHeight + 'px', lineHeight: itemHeight + 'px' }">
        {{ typeof itemValue === 'object' && itemValue[valueKey] ? itemValue[valueKey] : itemValue }}
      </div>
    </div>
    <div v-if="divider">{{ content }}</div>
  </div>

从 HTML 源码中可以看出:这里使用了 divider 属性来决定显示内容还是分隔符。如果 divider=true 那么直接显示 <div v-if="divider">{{ content }}</div> 分隔符元素,否则显示 picker 选项列表。
而 picker 选项列表其实就是使用 v-for 遍历渲染的一组元素列表,通过 CSS 的 translate 属性偏移元素以达到移动选择器的功能。可以从 dom 结构中找到具体的样式~

结构

所以,小结下:picker 只是容器,而 picker-slot 显示了单列选项列表,并通过 translate 偏移实现选中效果。一个 picker 是由一个或多个 picker-slot 组件组成。

事件监听

picker 组件中只有一个 change 监听事件。看下代码~

picker.vue

  methods: {
    slotValueChange () {
      this.$emit('change', this, this.values)
    },
    ...
  }

从代码中可以看到 picker 的 change 事件传递的值是 this 和 this.values,所以在定义 change 监听事件方法的时候可以获取到到 picker 组件实例本身,通过实例可以使用 picker 实例中的所有方法。

onYearChange(picker, values) {
  picker.setSlotValues(1, address[values[0]]);
},

picker 文档中也有说到这个:

change 事件
在 change 事件中,可以使用注册到 picker 实例上的一些方法:

  • getSlotValue(index):获取给定 slot 目前被选中的值
  • setSlotValue(index, value):设定给定 slot 被选中的值,该值必须>* 存在于该 slot 的备选值数组中
  • getSlotValues(index):获取给定 slot 的备选值数组
  • setSlotValues(index, values):设定给定 slot 的备选值数组
  • getValues():获取所有 slot 目前被选中的值(分隔符 slot 除外)
  • setValues(values):设定所有 slot 被选中的值(分隔符 slot 除外),该值必须存在于对应 slot 的备选值数组中

来看看 change 事件的触发时机,触发条件是组件 create 之后或者 picker-slot 组件的值有变化时。
在 created 时触发的很好理解,直接执行 slotValueChange 方法。而接收 picker-slot 组件的值发生变化用到了 src/mixins/emittier.js 这个文件中的方法。方法有两个,分别是向父级组件传输数据的 dispatch 方法和向子级组件广播数据的 broadcast 方法。这里由于是子组件往父组件发送消息所以是 dispatch 方法~

picker.vue

  created () {
    this.$on('slotValueChange', this.slotValueChange)
    this.slotValueChange()
  },

picker-slot.vue

  watch: {
    currentValue (val) {
      this.doOnValueChange()
      if (this.rotateEffect) {
        this.planUpdateRotate()
      }
      this.$emit('input', val)
      this.dispatch('picker', 'slotValueChange', this)
    }
  }

当某个 picker-slot 组件的当前值有所变化就会向 picker 派发消息,picker 收到消息后触发 change 事件。

dispatch 方法

    dispatch (componentName, eventName, params) {
      var parent = this.$parent
      var name = parent.$options.componentName

      while (parent && (!name || name !== componentName)) {
        parent = parent.$parent

        if (parent) {
          name = parent.$options.componentName
        }
      }
      if (parent) {
        parent.$emit.apply(parent, [eventName].concat(params))
      }
    },

picker-slot 组件的滑动效果实现

基本原理:

  • 使用了 transform: translate3d(0, 0, 0) rotateX(0); 来做选项列表的偏移。
  • 为选中项添加了 .picker-selected 这个 class 来实现选中项的效果。
  • 通过单个选项的高度、选中值的索引、显示选项的数量、选项总数这些属性来计算 translate 偏移值。
  • 如果支持 touch 则使用 touchstarttouchmovetouchendtouchcancel 方法监听手势,否则使用 mousedownmousemovemouseup 方法监听鼠标行为。

下面是 picker-slot 的具体滚动逻辑:

  1. 导入了 draggable.js 文件,这个文件定义了一个拖动元素的方法 draggable(element, options) ,其中 element 是 dom 元素,而 options 对象中有三个方法: start()drag()end() 方法分别对应开始拖拽、拖拽中和结束拖拽。
  2. 在渲染完成后执行了 initEvent() 方法,改方法调用 draggable.js 中的方法。
  mounted () {
    this.ready = true

    if (!this.divider) {
      this.initEvents()
      this.doOnValueChange()
    }

    if (this.rotateEffect) {
      this.doOnValuesChange()
    }
  },
    initEvents () {
      var el = this.$refs.wrapper
      var dragState = {}

      var velocityTranslate, prevTranslate, pickerItems

      draggable(el, { ... })
    }
  1. 选取 this.$ref.wrapper 这个元素(即包裹选项列表的 div 元素),使用 draggable 方法定义拖拽各阶段的行为。
  2. 在 start 方法中记录了开始拖拽时的状态 dragState,取消了正在进行的动画,并记录所有选项元素。
        start: (event) => {
          cancelAnimationFrame(this.animationFrameId)
          this.animationFrameId = null
          dragState = {
            range: this.dragRange,
            start: new Date(),
            startLeft: event.pageX,
            startTop: event.pageY,
            startTranslateTop: translateUtil.getElementTranslate(el).top
          }
          pickerItems = el.querySelectorAll('.picker-item')
        },
  1. 在 drag 方法中不断更新拖拽状态 dragState,通过计算元素的偏移量,通过偏移量 translate 改变 transform:translate() 的偏移位置实现元素列表随手指(鼠标)移动的效果,全局记录这个偏移量,最后如果有滚动效果需要更新滚动效果动画和样式。
        drag: (event) => {
          this.dragging = true

          dragState.left = event.pageX
          dragState.top = event.pageY

          var deltaY = dragState.top - dragState.startTop
          var translate = dragState.startTranslateTop + deltaY
          // 移动整个元素
          translateUtil.translateElement(el, null, translate)

          velocityTranslate = translate - prevTranslate || translate

          prevTranslate = translate

          if (this.rotateEffect) {
            this.updateRotate(prevTranslate, pickerItems)
          }
        },
  1. 在 end 方法中通过拖拽状态 dragState 计算拖拽的时间和拖拽的距离;当记录很小时计算下是否需要移动选项元素;当拖拽时间小于 300 毫秒,计算一个快速拖拽的位移;当 dom 加载完成后计算最后的 translate 偏移量,其中拖拽和快速拖拽的偏移量是不同的;最后,将改变 $el 元素的偏移量实现滚动效果。并且通过偏移量获取当前对应的选项值。如果有滚动效果,还需要进行滚动动画的更新。
        end: (event) => {
          this.dragging = false

          var momentumRatio = 7
          var currentTranslate = translateUtil.getElementTranslate(el).top
          var duration = new Date() - dragState.start
          let distance = Math.abs(dragState.startTranslateTop - currentTranslate)
          var itemHeight = this.itemHeight
          var visibleItemCount = this.visibleItemCount

          let rect, offset
          if (distance < 6) {
            rect = this.$el.getBoundingClientRect()
            offset = Math.floor((event.clientY - (rect.top + (visibleItemCount - 1) * itemHeight / 2)) / itemHeight) * itemHeight

            if (offset > this.maxTranslateY) {
              offset = this.maxTranslateY
            }

            velocityTranslate = 0
            currentTranslate -= offset
          }

          var momentumTranslate
          if (duration < 300) {
            momentumTranslate = currentTranslate + velocityTranslate * momentumRatio
          }

          var dragRange = dragState.range

          this.$nextTick(() => {
            var translate
            if (momentumTranslate) {
              translate = Math.round(momentumTranslate / itemHeight) * itemHeight
            } else {
              translate = Math.round(currentTranslate / itemHeight) * itemHeight
            }
            // translate must in the range
            translate = Math.max(Math.min(translate, dragRange[1]), dragRange[0])
            // translate element
            translateUtil.translateElement(el, null, translate)
            // get current value by translate
            this.currentValue = this.translate2Value(translate)

            if (this.rotateEffect) {
              this.planUpdateRotate()
            }
          })
          // clear dragState
          dragState = {}
        }

隐藏属性 —— 滚动效果

在 picker 中有一个 rotateEffect 属性在文档中没有提及,它的作用是让选择器有圆形滚动效果,如下:

<mt-picker :slots="yearSlot" @change="onYearChange" :visible-item-count="3" rotate-effect></mt-picker>

滚动效果

这是使用的 transform:totateX(45deg) 让元素有一个角度来实现滚动效果。

最后

picker 的源码在此
关于 picker 组件的分析就到这里啦,如果对于 picker 还有任何疑问,可以在评论区留言,共同学习。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,056评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,842评论 2 378
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,938评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,296评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,292评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,413评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,824评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,493评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,686评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,502评论 2 318
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,553评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,281评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,820评论 3 305
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,873评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,109评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,699评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,257评论 2 341

推荐阅读更多精彩内容

  • 1、通过CocoaPods安装项目名称项目信息 AFNetworking网络请求组件 FMDB本地数据库组件 SD...
    X先生_未知数的X阅读 15,967评论 3 119
  • 像脱线的风筝失去了方向。一定会越来越好,一定要越变越好。你要好好爱自己,才更值得被爱。
    雨小默阅读 264评论 0 0
  • 在简书中分享我的心得,经历。。。 分享从此开始!
    爭気阅读 162评论 0 0