ElementUI 源码分析-Scrolllbar组件

发表于 更新于 分类于

scrollbar 组件可以通过设置 native 属性，是否使用自定义的 scrollbar 视图，默认为 undefined 即使用自定义的，下面也是主要分析自定义 scrollbar 的构成。

scrollbar 视图的 html 代码由来年两层元素构成：

  1. 第一层：el-scrollbar，样式设为 overflow: hidden 主要用于隐藏原生 scrollbar；
  2. 第二层：el-scrollbar__wrap，用于存放内容的真实视图。
1
2
3
4
5
nodes = ([
  wrap,
  <Bar move={ this.moveX } size={ this.sizeWidth }></Bar>,
  <Bar vertical move={ this.moveY } size={ this.sizeHeight }></Bar>,
]);

scrollbar的主要逻辑

1
2
3
4
5
6
7
flowchart TD
  A["`scrollbarWidth() <br>计算浏览器默认<br>的 scrollbar 宽度`"]
  B["`根据默认的 scrollbar 添加<br>隐藏默认 scrollbar 样式：<br>给 “el-scrollbar__wrap” 视图<br>添加 margin-right 的负值`"]
  A --> B
  B --> C["注册 onscrollbar 事件，用于更新<br>自定义 scrollbar 的偏移"]
  C --> D["注册 resize 事件，用于更新<br>自定义 scrollbar 的长度"]
  D --> E["组合视图的 JSX 代码"]

计算浏览器scrollbar默认宽度

1
2
3
/ 通过离线创建一个容器，计算浏览器默认的scrollbar宽度
// 计算这个默认宽度是为了当出现默认scrollbar的时候隐藏掉
let gutter = scrollbarWidth();

计算方式是离线创建一个容器，并使之产生 scrollbar，根据产生 scrollbar 前后容器的宽度计算宽度：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
import Vue from 'vue';

let scrollBarWidth;

export default function() {
  if (Vue.prototype.$isServer) return 0;
  // 使用缓存
  if (scrollBarWidth !== undefined) return scrollBarWidth;

  // 外层
  const outer = document.createElement('div');
  outer.className = 'el-scrollbar__wrap';
  outer.style.visibility = 'hidden';
  outer.style.width = '100px';
  outer.style.position = 'absolute';
  outer.style.top = '-9999px';
  document.body.appendChild(outer);

  // 记录产生scrollbar前的视图宽度
  const widthNoScroll = outer.offsetWidth;
  // 强制显示scrollbar
  outer.style.overflow = 'scroll';

  const inner = document.createElement('div');
  inner.style.width = '100%';
  outer.appendChild(inner);

  // 记录产生scrollbar后的视图宽度
  const widthWithScroll = inner.offsetWidth;
  outer.parentNode.removeChild(outer);
  scrollBarWidth = widthNoScroll - widthWithScroll;

  return scrollBarWidth;
};

撑大 el-scrollbar__wrap 容器隐藏原生 scrollbar

1
2
3
4
5
6
7
8
9
10
11
12
13
if (gutter) {
  const gutterWith = `-${gutter}px`;
  const gutterStyle = `margin-bottom: ${gutterWith}; margin-right: ${gutterWith};`;

  if (Array.isArray(this.wrapStyle)) {
    style = toObject(this.wrapStyle);
    style.marginRight = style.marginBottom = gutterWith;
  } else if (typeof this.wrapStyle === 'string') {
    style += gutterStyle;
  } else {
    style = gutterStyle;
  }
}

添加自定义滑块模拟原生 scrollbar

1
2
3
4
5
6
7
8
9
10
nodes = ([
  wrap,
  <Bar
    move={ this.moveX }
    size={ this.sizeWidth }></Bar>,
  <Bar
    vertical
    move={ this.moveY }
    size={ this.sizeHeight }></Bar>
]);

注册 scrollbar 事件

主要用于更新自定义 bar 的偏移位置

1
2
3
4
5
6
7
handleScroll() {
  const wrap = this.wrap;
  // 纵向偏移比例 = 内容纵向偏移量 / 视图高度
  this.moveY = ((wrap.scrollTop * 100) / wrap.clientHeight);
  // 横向偏移比例 = 内容横向偏移量 / 视图宽度
  this.moveX = ((wrap.scrollLeft * 100) / wrap.clientWidth);
},

注册 resize 事件以及初始化滑块宽度

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
methods: {
  // ...

  update() {
    let heightPercentage, widthPercentage;
    const wrap = this.wrap;
    if (!wrap) return;

    // 纵轴滑块的高度 = 元素高度 / 元素内容视图高度
    heightPercentage = (wrap.clientHeight * 100 / wrap.scrollHeight);
    // 纵轴滑块的高度 = 元素宽度 / 元素内容视图宽度
    widthPercentage = (wrap.clientWidth * 100 / wrap.scrollWidth);

    this.sizeHeight = (heightPercentage < 100) ? (heightPercentage + '%') : '';
    this.sizeWidth = (widthPercentage < 100) ? (widthPercentage + '%') : '';
  }
},
mounted() {
  if (this.native) return;
  // 初始化scrollbar的宽度
  this.$nextTick(this.update);
  // 注册resize事件，用于之后更新scrollbar的宽度
  !this.noresize && addResizeListener(this.$refs.resize, this.update);
},

bar组件

bar组件是对原生滑块的模拟，滑块由滑块容器以及滑块本身组成！

bar组件负责的主要功能是：计算滑块的偏移距离与滑块容器高度的比例，以次比例计算 Scrill-view 的偏移值。

实现的交互功能分别有两个：

  1. 点击滑块容器，移动 scroll-view 内容，通过给滑块容器绑定 mousedown 事件触发；
  2. 拖动滑块使移动 scroll-view 内容，通过绑定三个事件实现：mousedown、mousemove、mouseup。

注意：

  1. bar 组建的滑块自身的偏移不是由 bar 组建自身直接改变，而是根据根据传入的两个 props 属性绑定到滑块的 style 上实现的；
1
2
3
4
5
props: {
  vertical: Boolean,
  size: String,       // 滑块的长度
  move: Number        // 话快的偏移值
}
  1. 滑块的偏移有 css3 的 tansfrom: translate() 实现
1
2
3
4
5
6
7
8
9
10
11
export function renderThumbStyle({ move, size, bar }) {
  const style = {};
  const translate = `translate${bar.axis}(${ move }%)`;

  style[bar.size] = size;
  style.transform = translate;
  style.msTransform = translate;
  style.webkitTransform = translate;

  return style;
};
1
2
3
4
5
6
7
8
9
10
<div
     class={ ['el-scrollbar__bar', 'is-' + bar.key] }
     onMousedown={ this.clickTrackHandler } >
  <div
       ref="thumb"
       class="el-scrollbar__thumb"
       onMousedown={ this.clickThumbHandler }
       style={ renderThumbStyle({ size, move, bar }) }>
  </div>
</div>

由滑块容器 el-scrollbar__bar 和滑块 el-scrollbar__thumb 组成。

点击容器移动滑块

容器元素监听 onMousedown

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
// 点击滑块容器，移动父元素的内容移动`$parent.wrap`的scrollTop/scrollLeft
clickTrackHandler(e) {
  // e.target.getBoundingClientRect()：获取元素大小与位置信息，返回一个DOMRect对象
  // x: 390 // 左边距离视窗左边距离
  // y: 91  // 上边距离视窗上边距离
  // width: 240 // 元素宽度
  // height: 26 // 元素高度
  // top: 91  // 上边距离视窗上边距离
  // right: 630 // 右边距离视窗左边距离
  // bottom: 117  // 低边距离视窗上边距离
  // left: 390  // 左边距离视窗左边距离

  // 以纵向滚轴为例子
  // offset：计算点击位置在元素矩形内纵向的偏移数值
  const offset = Math.abs(e.target.getBoundingClientRect()[this.bar.direction] - e[this.bar.client]);   // e[this.bar.client]点击的横纵/坐标值
  // thumbHalf：滑块高度的一半
  const thumbHalf = (this.$refs.thumb[this.bar.offset] / 2);
  const thumbPositionPercentage = ((offset - thumbHalf) * 100 / this.$el[this.bar.offset]);

  // this.wrap: this.$parent.wrap
  this.wrap[this.bar.scroll] = (thumbPositionPercentage * this.wrap[this.bar.scrollSize] / 100);
}

拖动滑块移动父容器内容

涉及到三个事件的监听：

  1. onMousedown 事件：负责触发事件；
  2. mousemove 事件：负责计算滑块移动距离与容器高度的比例，以此更新父容器的 scrollTop；
  3. mouseup 事件：负责移除 mousemove 事件的监听和整个功能结束的收尾。

点击触发，动态绑定 mousemove 和 mouseup 事件

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
clickThumbHandler(e) {
  // e.ctrlKey 
  // 鼠标事件ctrlKey是只读属性，可返回一个布尔值，当ctrl键被按下，返回true，否则返回false
  // 
  // e.button:
  // 0：主按键被按下，通常指鼠标左键 or the un-initialized state
  // 1：辅助按键被按下，通常指鼠标滚轮 or the middle button (if present)
  // 2：次按键被按下，通常指鼠标右键
  // 3：第四个按钮被按下，通常指浏览器后退按钮
  // 4：第五个按钮被按下，通常指浏览器的前进按钮
  // prevent click event of right button
  if (e.ctrlKey || e.button === 2) {
    return;
  }
  this.startDrag(e);
  // 点击位置距离滑块下边的距离
  this[this.bar.axis] = (e.currentTarget[this.bar.offset] - (
    // 1.点击位置的纵坐标：e[this.bar.client]
    // 2.滑块元素上边的纵坐标：e.currentTarget.getBoundingClientRect()[this.bar.direction])
    // 点击位置到滑块上边的高度 = 1 - 2
    e[this.bar.client] - e.currentTarget.getBoundingClientRect()[this.bar.direction])
                        );
},
startDrag(e) {
  e.stopImmediatePropagation();
  this.cursorDown = true;

  // addEventListener监听mousemove事件
  // addEventListener监听mouseup事件
  on(document, 'mousemove', this.mouseMoveDocumentHandler);
  on(document, 'mouseup', this.mouseUpDocumentHandler);
  document.onselectstart = () => false;
},

动态计算父容器内容的偏移

此时鼠标右键已经被按下且未放开

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
// 移动鼠标，同步移动父元素容器的内容
mouseMoveDocumentHandler(e) {
  if (this.cursorDown === false) return;
  const prevPage = this[this.bar.axis];

  if (!prevPage) return;

  // offset：点击位置到滑块容器顶部的距离
  const offset = ((
    // 1.滑块容器上边距离视窗上边距离：this.$el.getBoundingClientRect()[this.bar.direction]
    // 2.当前点击的纵轴坐标
    // 点击位置距离容器上边的长度 = 1 - 2
    this.$el.getBoundingClientRect()[this.bar.direction] - e[this.bar.client]
  ) * -1);
  // 点击位置距离滑块上边的距离
  const thumbClickPosition = (
    // 1.this.$refs.thumb[this.bar.offset]：滑块高度
    // 2.prevPage：点击位置距离下边的距离
    // 点击位置距离滑块上边的距离 = 1 - 2
    this.$refs.thumb[this.bar.offset] - prevPage
  );
  // 计算“滑块上边到容器上边距离”占容器高度的百分比
  const thumbPositionPercentage = ((
    // 计算滑块上边到容器上边的距离
    offset - thumbClickPosition
  ) * 100 / this.$el[this.bar.offset]);
  
  console.log({
  '计算滑块上边到容器上边的距离': offset - thumbClickPosition,
  '容器的高度': this.$el[this.bar.offset]
  });

  // 通过thumbPositionPercentage计算夫容器移动的距离
  this.wrap[this.bar.scroll] = (thumbPositionPercentage * this.wrap[this.bar.scrollSize] / 100);
},

结束滑块移动

鼠标右键放开，结束事件重置基本变量，解绑 mousemove 事件

1
2
3
4
5
6
mouseUpDocumentHandler(e) {
  this.cursorDown = false;
  this[this.bar.axis] = 0;
  off(document, 'mousemove', this.mouseMoveDocumentHandler);
  document.onselectstart = null;
}

组件生命周期结束解绑mouseup事件

1
2
3
destroyed() {
  off(document, 'mouseup', this.mouseUpDocumentHandler);
}

附录

bar 源码注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
import { on, off } from 'zhuiyi-ui/src/utils/dom';
import { renderThumbStyle, BAR_MAP } from './util';

/* istanbul ignore next */
export default {
  name: 'Bar',

  props: {
    vertical: Boolean,
    // 滑块的长度
    size: String,
    // 滑块的偏移量
    move: Number
  },

  computed: {
    bar() {
      return BAR_MAP[this.vertical ? 'vertical' : 'horizontal'];
    },

    wrap() {
      return this.$parent.wrap;
    }
  },

  render(h) {
    const { size, move, bar } = this;

    return (
      <div
        class={ ['el-scrollbar__bar', 'is-' + bar.key] }
        onMousedown={ this.clickTrackHandler } >
        <div
          ref="thumb"
          class="el-scrollbar__thumb"
          onMousedown={ this.clickThumbHandler }
          style={ renderThumbStyle({ size, move, bar }) }>
        </div>
      </div>
    );
  },

  methods: {
    clickThumbHandler(e) {
      // e.ctrlKey 
      // 鼠标事件ctrlKey是只读属性，可返回一个布尔值，当ctrl键被按下，返回true，否则返回false
      // 
      // e.button:
      // 0：主按键被按下，通常指鼠标左键 or the un-initialized state
      // 1：辅助按键被按下，通常指鼠标滚轮 or the middle button (if present)
      // 2：次按键被按下，通常指鼠标右键
      // 3：第四个按钮被按下，通常指浏览器后退按钮
      // 4：第五个按钮被按下，通常指浏览器的前进按钮
      // prevent click event of right button
      if (e.ctrlKey || e.button === 2) {
        return;
      }
      this.startDrag(e);
      // 点击位置距离滑块下边的距离
      this[this.bar.axis] = (e.currentTarget[this.bar.offset] - (
        // 1.点击位置的纵坐标：e[this.bar.client]
        // 2.滑块元素上边的纵坐标：e.currentTarget.getBoundingClientRect()[this.bar.direction])
        // 点击位置到滑块上边的高度 = 1 - 2
        e[this.bar.client] - e.currentTarget.getBoundingClientRect()[this.bar.direction])
      );
    },

    // 点击滑块容器，移动父元素容器的内容（scrollTop/scrollLeft）
    clickTrackHandler(e) {
      // e.target.getBoundingClientRect()：获取元素大小与位置信息，返回一个DOMRect对象
      // x: 390 // 左边距离视窗左边距离
      // y: 91  // 上边距离视窗上边距离
      // width: 240 // 元素宽度
      // height: 26 // 元素高度
      // top: 91  // 上边距离视窗上边距离
      // right: 630 // 右边距离视窗左边距离
      // bottom: 117  // 低边距离视窗上边距离
      // left: 390  // 左边距离视窗左边距离

      // 以纵向滚轴为例子
      // offset：计算点击位置在元素矩形内纵向的偏移数值
      const offset = Math.abs(e.target.getBoundingClientRect()[this.bar.direction] - e[this.bar.client]);   // e[this.bar.client]点击的横纵/坐标值
      // thumbHalf：滑块高度的一半
      const thumbHalf = (this.$refs.thumb[this.bar.offset] / 2);
      const thumbPositionPercentage = ((offset - thumbHalf) * 100 / this.$el[this.bar.offset]);

      this.wrap[this.bar.scroll] = (thumbPositionPercentage * this.wrap[this.bar.scrollSize] / 100);
    },

    startDrag(e) {
      e.stopImmediatePropagation();
      this.cursorDown = true;

      // addEventListener监听mousemove事件
      // addEventListener监听mouseup事件dsfsdf sdfsdfsdfsdfsdfdsfds
      on(document, 'mousemove', this.mouseMoveDocumentHandler);
      on(document, 'mouseup', this.mouseUpDocumentHandler);
      document.onselectstart = () => false;
    },

    // 移动鼠标，同步移动父元素容器的内容
    mouseMoveDocumentHandler(e) {
      if (this.cursorDown === false) return;
      const prevPage = this[this.bar.axis];

      if (!prevPage) return;

      // offset：点击位置到滑块容器顶部的距离
      const offset = ((
        // 1.滑块容器上边距离视窗上边距离：this.$el.getBoundingClientRect()[this.bar.direction]
        // 2.当前点击的纵轴坐标
        // 点击位置距离容器上边的长度 = 1 - 2
        this.$el.getBoundingClientRect()[this.bar.direction] - e[this.bar.client]
      ) * -1);
      // 点击位置距离滑块上边的距离
      const thumbClickPosition = (
        // 1.this.$refs.thumb[this.bar.offset]：滑块高度
        // 2.prevPage：点击位置距离下边的距离
        // 点击位置距离滑块上边的距离 = 1 - 2
        this.$refs.thumb[this.bar.offset] - prevPage
      );
      // 计算“滑块上边到容器上边距离”占容器高度的百分比
      const thumbPositionPercentage = (
        (
          // 计算滑块上边到容器上边的距离
          offset - thumbClickPosition
        ) * 100 / this.$el[this.bar.offset]
      );
      console.log({
        '计算滑块上边到容器上边的距离': offset - thumbClickPosition,
        '容器的高度': this.$el[this.bar.offset]
      });

      // 通过thumbPositionPercentage计算夫容器移动的距离
      this.wrap[this.bar.scroll] = (thumbPositionPercentage * this.wrap[this.bar.scrollSize] / 100);
    },

    mouseUpDocumentHandler(e) {
      this.cursorDown = false;
      this[this.bar.axis] = 0;
      off(document, 'mousemove', this.mouseMoveDocumentHandler);
      document.onselectstart = null;
    }
  },

  destroyed() {
    off(document, 'mouseup', this.mouseUpDocumentHandler);
  }
};