From b93a2e3c009e7d53a8e09f4c402aadc6bfa035c0 Mon Sep 17 00:00:00 2001
From: neverland <chenjiahan@buaa.edu.cn>
Date: Mon, 23 Apr 2018 20:19:41 +0800
Subject: [PATCH] [Improvement] Slider: add step & bar-height prop (#915)

---
 docs/demos/views/slider.vue      |  67 ++++++---------
 docs/markdown/en-US/slider.md    | 111 ++++++++-----------------
 docs/markdown/zh-CN/slider.md    |  97 +++++++---------------
 docs/src/doc.config.js           |  16 ++--
 packages/slider/index.vue        | 135 ++++++++-----------------------
 packages/vant-css/src/slider.css |  44 ++++------
 test/specs/slider.spec.js        |  40 ++++-----
 7 files changed, 160 insertions(+), 350 deletions(-)

diff --git a/docs/demos/views/slider.vue b/docs/demos/views/slider.vue
index 0a0e07b4a..0b64f28b4 100644
--- a/docs/demos/views/slider.vue
+++ b/docs/demos/views/slider.vue
@@ -1,19 +1,15 @@
 <template>
   <demo-section>
     <demo-block :title="$t('title1')">
-      <van-slider v-model="value1"/>
-      <van-row>
-        <van-col span="24">
-          <van-stepper v-model="value1" />
-        </van-col>
-      </van-row>
+      <van-slider v-model="value1" @change="onChange" />
     </demo-block>
 
     <demo-block :title="$t('title2')">
       <van-slider
         v-model="value2"
-        :min="min"
-        :max="max"
+        :min="10"
+        :max="90"
+        @change="onChange"
       />
     </demo-block>
 
@@ -24,17 +20,9 @@
     <demo-block :title="$t('title4')">
       <van-slider
         v-model="value4"
-        @change="handleChange"
-        @after-change="handleAfterChange"
-      />
-    </demo-block>
-
-    <demo-block :title="$t('title5')">
-      <van-slider
-        v-model="value5"
-        pivot-color="#333"
-        loaded-bar-color="red"
-        bar-color="blue"
+        :step="10"
+        bar-height="4px"
+        @change="onChange"
       />
     </demo-block>
   </demo-section>
@@ -45,46 +33,43 @@ export default {
   i18n: {
     'zh-CN': {
       title1: '基本用法',
-      title2: '最大最小值',
+      title2: '指定选择范围',
       title3: '禁用',
-      title4: '事件',
-      title5: '自定义样式'
+      title4: '指定步长',
+      text: '当前值：'
     },
     'en-US': {
       title1: 'Basic Usage',
-      title2: 'Max && Min',
-      title3: 'Disabed',
-      title4: 'Event',
-      title5: 'Customized style'
+      title2: 'Range',
+      title3: 'Disabled',
+      title4: 'Step size',
+      text: 'Current value: '
     }
   },
+
   data() {
     return {
       value1: 50,
       value2: 50,
       value3: 50,
-      value4: 50,
-      value5: 50,
-      min: 10,
-      max: 90
-    }
+      value4: 50
+    };
   },
+
   methods: {
-    handleChange(value) {
-      console.log('handleChange:', value)
-    },
-    handleAfterChange(value) {
-      console.log('handleAfterChange:', value)
+    onChange(value) {
+      this.$toast(this.$t('text') + value);
     }
   }
 };
 </script>
 
 <style lang="postcss">
-  .van-row {
-    padding-top: 20px;
-    .van-col {
-      text-align: center;
-    }
+.demo-slider {
+  user-select: none;
+
+  .van-slider {
+    margin: 0 15px 30px;
   }
+}
 </style>
diff --git a/docs/markdown/en-US/slider.md b/docs/markdown/en-US/slider.md
index 9c6af4378..e1bab3f27 100644
--- a/docs/markdown/en-US/slider.md
+++ b/docs/markdown/en-US/slider.md
@@ -11,99 +11,56 @@ Vue.use(Slider);
 #### Basic Usage
 
 ```html
-<van-slider v-model="value1"/>
-<van-row>
-  <van-col span="12">
-    <van-stepper v-model="value1" />
-  </van-col>
-</van-row>
+<van-slider v-model="value" @change="onChange" />
 ```
 
 ```js
-data() {
-  return {
-    value1: 50
-  }
-}
-```
-
-#### Max && Min
-
-```html
-<van-slider 
-  v-model="value2"
-  :min="min"
-  :max="max"
-/>
-```
-```js
-data() {
-  return {
-    value2: 50,
-    min: 10,
-    max: 90
-  }
-}
-```
-
-#### Disabed
-
-```html
-<van-slider v-model="value3" disabled />
-```
-
-#### Customized style
-
-```html
-<van-slider
-    v-model="value4"
-    @change="handleChange"
-    @after-change="handleAfterChange"
-  />
-```
-
-```js
-data() {
-  return {
-    value4: 50
-  }
-},
-methods: {
-  handleChange(value) {
-    console.log('handleChange:', value)
+export default {
+  data() {
+    return {
+      value: 50
+    };
   },
-  handleAfterChange(value) {
-    console.log('handleAfterChange:', value)
+
+  methods: {
+    onChange(value) {
+      this.$toast('Current value：' + value);
+    }
   }
-}
+};
 ```
 
-### Customized style
+#### Range
 
 ```html
-<van-slider
-  v-model="value5"
-  pivot-color="#333"
-  loaded-bar-color="red"
-  bar-color="blue"
-/>
+<van-slider v-model="value" :min="10" :max="90" />
+```
+
+#### Disabled
+
+```html
+<van-slider v-model="value" disabled />
+```
+
+#### Step size
+
+```html
+<van-slider v-model="value" :step="10" bar-height="4px" />
 ```
 
 ### API
 
-| Attribute | Description | Type | Default | Accepted Values |
+| Attribute | Description | Type | Default |
 |-----------|-----------|-----------|-------------|-------------|
-| value | current value | Number  | 0 |  - |
-| disabled | disabled | Boolean  | false |  - |
-| bar-color | bar-color | string | `#cacaca` | - |
-| loaded-bar-color | loaded-bar-color | string | `#4b0` | - |
-| pivot-color | pivot-color | string  | `#4b0` |  - |
-| max | max | Number | 100 | - |
-| min | min | Number | 0 | - |
+| value | Current value | `Number` | `0` |
+| disabled | Whether to disable slider | `Boolean` | `false` |
+| max | Max value | `Number` | `100` |
+| min | Min value | `Number` | `0` |
+| step | Step size | `Number` | `1` |
+| bar-height | Height of bar | `String` | `2px` |
 
 ### Event
 
 | Event | Description | Arguments |
 |-----------|-----------|-----------|
-| change | touchmove emit | value |
-| after-change | touchend emit | value |
+| change | Triggered after value change | value: current rate |
diff --git a/docs/markdown/zh-CN/slider.md b/docs/markdown/zh-CN/slider.md
index 5cffc243c..b9fae9849 100644
--- a/docs/markdown/zh-CN/slider.md
+++ b/docs/markdown/zh-CN/slider.md
@@ -10,99 +10,56 @@ Vue.use(Slider);
 #### 基本用法
 
 ```html
-<van-slider v-model="value1"/>
-<van-row>
-  <van-col span="12">
-    <van-stepper v-model="value1" />
-  </van-col>
-</van-row>
+<van-slider v-model="value" @change="onChange" />
 ```
 
 ```js
-data() {
-  return {
-    value1: 50
+export default {
+  data() {
+    return {
+      value: 50
+    };
+  },
+
+  methods: {
+    onChange(value) {
+      this.$toast('当前值：' + value);
+    }
   }
-}
+};
 ```
 
-#### 最大最小值
+#### 指定选择范围
 
 ```html
-<van-slider 
-  v-model="value2"
-  :min="min"
-  :max="max"
-/>
-```
-```js
-data() {
-  return {
-    value2: 50,
-    min: 10,
-    max: 90
-  }
-}
+<van-slider v-model="value" :min="10" :max="90" />
 ```
 
 #### 禁用
 
 ```html
-<van-slider v-model="value3" disabled />
+<van-slider v-model="value" disabled />
 ```
 
-#### 事件
+#### 指定步长
 
 ```html
-<van-slider
-    v-model="value4"
-    @change="handleChange"
-    @after-change="handleAfterChange"
-  />
-```
-
-```js
-data() {
-  return {
-    value4: 50
-  }
-},
-methods: {
-  handleChange(value) {
-    console.log('handleChange:', value)
-  },
-  handleAfterChange(value) {
-    console.log('handleAfterChange:', value)
-  }
-}
-```
-
-### 自定义样式
-
-```html
-<van-slider
-  v-model="value5"
-  pivot-color="#333"
-  loaded-bar-color="red"
-  bar-color="blue"
-/>
+<van-slider v-model="value" :step="10" bar-height="4px" />
 ```
 
 ### API
 
-| 参数       | 说明      | 类型       | 默认值       | 必须      |
-|-----------|-----------|-----------|-------------|-------------|
-| value | 当前进度百分比 | Number  | 0 |  否 |
-| disabled | 滑块是否禁用 | Boolean  | false |  否 |
-| bar-color | 进度条颜色 | string | `#cacaca` | 否 |
-| loaded-bar-color | 已加载条颜色 | string | `#4b0` | 否 |
-| pivot-color | 滑块颜色 | string  | `#4b0` |  否 |
-| max | 最大值 | Number | 100 | - |
-| min | 最小值 | Number | 0 | - |
+| 参数       | 说明      | 类型       | 默认值       |
+|-----------|-----------|-----------|-------------|
+| value | 当前进度百分比 | `Number` | `0` |
+| disabled | 是否禁用滑块 | `Boolean` | `false` |
+| max | 最大值 | `Number` | `100` |
+| min | 最小值 | `Number` | `0` |
+| step | 步长 | `Number` | `1` |
+| bar-height | 进度条高度 | `String` | `2px` |
 
 ### Event
 
 | 事件名 | 说明 | 参数 |
 |-----------|-----------|-----------|
-| change | 拖动时触发 | value |
-| after-change | 拖动停止后触发 | value |
+| change | 进度值改变后触发 | value: 当前进度 |
diff --git a/docs/src/doc.config.js b/docs/src/doc.config.js
index 8117af688..3b3282a1e 100644
--- a/docs/src/doc.config.js
+++ b/docs/src/doc.config.js
@@ -136,6 +136,10 @@ module.exports = {
                 path: '/progress',
                 title: 'Progress - 进度条'
               },
+              {
+                path: '/slider',
+                title: 'Slider - 滑块'
+              },
               {
                 path: '/stepper',
                 title: 'Stepper - 步进器'
@@ -148,10 +152,6 @@ module.exports = {
                 path: '/swipe',
                 title: 'Swipe - 轮播'
               },
-              {
-                path: '/slider',
-                title: 'Slider - 滑块'
-              },
               {
                 path: '/tab',
                 title: 'Tab - 标签页'
@@ -434,6 +434,10 @@ module.exports = {
                 path: '/progress',
                 title: 'Progress'
               },
+              {
+                path: '/slider',
+                title: 'Slider'
+              },
               {
                 path: '/stepper',
                 title: 'Stepper'
@@ -446,10 +450,6 @@ module.exports = {
                 path: '/swipe',
                 title: 'Swipe'
               },
-              {
-                path: '/slider',
-                title: 'Slider'
-              },
               {
                 path: '/tab',
                 title: 'Tab'
diff --git a/packages/slider/index.vue b/packages/slider/index.vue
index 2d042cea1..5f3f6ad1a 100644
--- a/packages/slider/index.vue
+++ b/packages/slider/index.vue
@@ -1,22 +1,8 @@
 <template>
-  <div
-    class="van-slider"
-    :class="{ 'van-slider--disabled': disabled }"
-  >
-    <div
-      class="van-slider__bar"
-      ref="bar"
-      :style="barStyle"
-      @click.stop="onSliderClicked"
-    >
+  <div :class="b({ disabled })" @click.stop="onClick">
+    <div :class="b('bar')" :style="barStyle">
       <span
-        class="van-slider__finished-portion"
-        :style="finishedStyle"
-      />
-      <span
-        class="van-slider__pivot"
-        ref="pivot"
-        :style="pivotStyle"
+        :class="b('button')"
         @touchstart="onTouchStart"
         @touchmove.prevent.stop="onTouchMove"
         @touchend="onTouchEnd"
@@ -25,145 +11,90 @@
     </div>
   </div>
 </template>
-<script>
 
+<script>
 import create from '../utils/create';
 import Touch from '../mixins/touch';
 
-const DEFAULT_COLOR = '#4b0';
-const DEFAULT_BG = '#cacaca';
-
 export default create({
   name: 'slider',
+
   mixins: [Touch],
 
   props: {
+    disabled: Boolean,
     max: {
       type: Number,
       default: 100
     },
-
     min: {
       type: Number,
       default: 0
     },
-
+    step: {
+      type: Number,
+      default: 1
+    },
     value: {
       type: Number,
-      default: 0,
-      required: true
+      default: 0
     },
-
-    disabled: Boolean,
-
-    pivotColor: {
+    barHeight: {
       type: String,
-      default: DEFAULT_COLOR
-    },
-
-    barColor: {
-      type: String,
-      default: DEFAULT_BG
-    },
-
-    loadedBarColor: {
-      type: String,
-      default: DEFAULT_COLOR
+      default: '2px'
     }
   },
 
-  data() {
-    return {
-      pivotOffset: 0
-    };
-  },
-
   computed: {
-    sliderWidth() {
-      const rect = this.$refs.bar.getBoundingClientRect();
-      return rect['width'];
-    },
-
     barStyle() {
       return {
-        backgroundColor: this.barColor
-      };
-    },
-
-    finishedStyle() {
-      return {
-        backgroundColor: this.loadedBarColor,
-        width: this.format(this.value) + '%'
-      };
-    },
-
-    pivotStyle() {
-      return {
-        backgroundColor: this.pivotColor,
-        left: this.format(this.value) + '%',
-        marginLeft: `-${this.pivotOffset}px`
+        width: this.format(this.value) + '%',
+        height: this.barHeight
       };
     }
   },
 
-  mounted() {
-    this.pivotOffset = parseInt(this.$refs.pivot.getBoundingClientRect().width / 2);
-  },
-
   methods: {
     onTouchStart(event) {
       if (this.disabled) return;
 
-      this.draging = true;
       this.touchStart(event);
       this.startValue = this.format(this.value);
     },
 
     onTouchMove(event) {
-      if (this.draging) {
-        this.touchMove(event);
-        const diff = this.deltaX / this.sliderWidth * 100;
-        this.newValue = this.startValue + diff;
-        this.updateValue(this.newValue);
-      }
+      if (this.disabled) return;
+
+      this.touchMove(event);
+      const rect = this.$el.getBoundingClientRect();
+      const diff = this.deltaX / rect.width * 100;
+      this.updateValue(this.startValue + diff);
     },
 
     onTouchEnd() {
-      if (this.draging) {
-        this.$nextTick(() => {
-          this.draging = false;
-          this.updateValue(this.newValue, true);
-        });
-      }
+      if (this.disabled) return;
+      this.updateValue(this.value, true);
     },
 
-    onSliderClicked(e) {
-      if (this.disabled || this.draging) return;
-
-      const sliderRect = this.$refs.bar.getBoundingClientRect();
-      const sliderOffset = sliderRect.left;
-      this.newValue = Math.round((e.clientX - sliderOffset) / this.sliderWidth * 100);
-      this.updateValue(this.newValue, true);
-    },
-
-    updateValue(value, isFinished) {
+    onClick(event) {
       if (this.disabled) return;
 
+      const rect = this.$el.getBoundingClientRect();
+      const value = (event.clientX - rect.left) / rect.width * 100;
+      this.updateValue(value, true);
+    },
+
+    updateValue(value, end) {
       value = this.format(value);
-      this.$emit('change', value);
       this.$emit('input', value);
 
-      if (isFinished) {
-        this.$emit('after-change', value);
+      if (end) {
+        this.$emit('change', value);
       }
     },
 
     format(value) {
-      return Math.round(this.range(value));
-    },
-
-    range(value) {
-      return Math.max(this.min, Math.min(value, this.max));
+      return (Math.round(Math.max(this.min, Math.min(value, this.max)) / this.step) * this.step);
     }
   }
 });
diff --git a/packages/vant-css/src/slider.css b/packages/vant-css/src/slider.css
index 888afcffd..bb4184df1 100644
--- a/packages/vant-css/src/slider.css
+++ b/packages/vant-css/src/slider.css
@@ -1,41 +1,29 @@
 @import './common/var.css';
 
-$c-slider-background: #cacaca;
-$c-pivot-border: #fff;
-
 .van-slider {
-  &--disabled {
-    opacity: .3;
-    .van-slider__pivot {
-      cursor: not-allowed;
-    }
-  }
+  position: relative;
+  border-radius: 999px;
+  background-color: $border-color;
 
   &__bar {
     position: relative;
-    margin: 0 15px;
-    height: 4px;
-    border-radius: 5px;
-    background: $c-slider-background;
+    border-radius: inherit;
+    background-color: $blue;
   }
 
-  &__loaded-portion,
-  &__finished-portion {
-    border-radius: 5px;
-    height: 100%;
-    position: absolute;
-    left: 0;
-  }
-
-  &__pivot {
+  &__button {
     position: absolute;
     top: 50%;
-    width: 16px;
-    height: 16px;
-    border: 3px solid $c-pivot-border;
-    box-shadow: 0 1px 4px;
+    right: 0;
+    width: 20px;
+    height: 20px;
     border-radius: 50%;
-    background-color: $c-slider-background;
-    transform: translate3d(0, -50%, 0);
+    background-color: $white;
+    transform: translate3d(50%, -50%, 0);
+    box-shadow: 0 1px 2px rgba(0, 0, 0, .5);
+  }
+
+  &--disabled {
+    opacity: .3;
   }
 }
diff --git a/test/specs/slider.spec.js b/test/specs/slider.spec.js
index 8287bca39..62e3fe0fb 100644
--- a/test/specs/slider.spec.js
+++ b/test/specs/slider.spec.js
@@ -19,7 +19,6 @@ describe('Slider', () => {
 
     expect(wrapper.hasClass('van-slider')).to.be.true;
     expect(wrapper.find('.van-slider__bar').length).to.equal(1);
-    expect(wrapper.find('.van-slider__finished-portion').length).to.equal(1);
     expect(wrapper.vm.value).to.equal(50);
     expect(wrapper.hasClass('van-slider--disabled')).to.equal(true);
 
@@ -40,8 +39,17 @@ describe('Slider', () => {
     });
 
     const eventStub = sinon.stub(wrapper.vm, '$emit');
-    const $bar = wrapper.find('.van-slider__bar')[0];
+    const $bar = wrapper.find('.van-slider')[0];
     $bar.trigger('click');
+    const button = wrapper.find('.van-slider__button')[0];
+    triggerTouch(button, 'touchstart', 0, 0);
+    expect(wrapper.vm.startX).to.equal(undefined);
+
+    triggerTouch(button, 'touchmove', 50, 0);
+    expect(wrapper.vm.offsetX).to.equal(undefined);
+
+    triggerTouch(button, 'touchend', 50, 0);
+    expect(wrapper.vm.offsetX).to.equal(undefined);
 
     expect(eventStub.called).to.equal(false);
 
@@ -55,44 +63,28 @@ describe('Slider', () => {
     expect(eventStub.called).to.equal(true);
   });
 
-  it('Customized style', () => {
-    const COLOR = '#123';
-    wrapper = mount(Slider, {
-      propsData: {
-        pivotColor: COLOR,
-        barColor: COLOR,
-        loadedBarColor: COLOR,
-        value: 50
-      }
-    });
-
-    expect(wrapper.vm.barStyle.backgroundColor).to.equal(COLOR);
-    expect(wrapper.vm.pivotStyle.backgroundColor).to.equal(COLOR);
-    expect(wrapper.vm.finishedStyle.backgroundColor).to.equal(COLOR);
-  });
-
-  it('drag pivot', () => {
+  it('drag button', () => {
     wrapper = mount(Slider, {
       propsData: {
         value: 50
       }
     });
 
-    const pivot = wrapper.find('.van-slider__pivot')[0];
-    triggerTouch(pivot, 'touchstart', 0, 0);
+    const button = wrapper.find('.van-slider__button')[0];
+    triggerTouch(button, 'touchstart', 0, 0);
     expect(wrapper.vm.startX).to.equal(0);
 
-    triggerTouch(pivot, 'touchmove', 50, 0);
+    triggerTouch(button, 'touchmove', 50, 0);
     expect(wrapper.vm.offsetX).to.equal(50);
 
-    triggerTouch(pivot, 'touchend', 50, 0);
+    triggerTouch(button, 'touchend', 50, 0);
     expect(wrapper.vm.offsetX).to.equal(50);
 
     wrapper.setData({
       disabled: true
     });
 
-    triggerTouch(pivot, 'touchstart', 0, 0);
+    triggerTouch(button, 'touchstart', 0, 0);
     expect(wrapper.vm.startX).to.equal(0);
   });
 });