Merge pull request #85 from react-component/feat-vertical

feat: vertical slider

HISTORY.md

@@ -1,6 +1,11 @@
 # History
 ----
 
+## 3.6.0 / 2016-04-01
+
+[#18](https://github.com/react-component/slider/issues/18) add `vertical` props ([@wnlee](https://github.com/WNLee))
+
+...
 
 ## 1.2.5 / 2015-07-13
 

README.md

@@ -112,6 +112,12 @@ ReactDOM.render(<Rcslider />, container);
           <td>true</td>
           <td>When `range` is `true`, `allowCross` could be set as `true` to allow those two handles cross.</td>
         </tr>
+        <tr>
+          <td>vertical</td>
+          <td>boolean</td>
+          <td>false</td>
+          <td>If vertical is `true`, the slider will be vertical.</td>
+        </tr>
         <tr>
           <td>defaultValue</td>
           <td>number or [number, number]</td>

assets/index.less

@@ -94,7 +94,7 @@
 
   &-dot {
     position: absolute;
-    top: -2px;
+    bottom: -2px;
     margin-left: -4px;
     width: 8px;
     height: 8px;
@@ -133,6 +133,45 @@
   }
 }
 
+.@{prefixClass}-vertical {
+  width: 4px;
+  height: 100%;
+  .@{prefixClass} {
+    &-track {
+      bottom: 0;
+      width: 4px;
+    }
+
+    &-handle {
+      position: absolute;
+      margin-left: -5px;
+      margin-bottom: -7px;
+    }
+
+    &-mark {
+      top: 0;
+      left: 10px;
+      height: 100%;
+    }
+
+    &-step {
+      height: 100%;
+      width: 4px;
+    }
+
+    &-dot {
+      left: 2px;
+      margin-bottom: -4px;
+      &:first-child {
+        margin-bottom: -4px;
+      }
+      &:last-child {
+        margin-bottom: -4px;
+      }
+    }
+  }
+}
+
 .motion-common() {
   animation-duration: .3s;
   animation-fill-mode: both;

examples/v-marks.html

@@ -0,0 +1 @@
+placeholder

examples/v-marks.js

@@ -0,0 +1,55 @@
+require('rc-slider/assets/index.less');
+
+const React = require('react');
+const ReactDOM = require('react-dom');
+const Slider = require('rc-slider');
+
+const style = {float: 'left', width: 160, height: 400, marginBottom: 160, marginLeft: 50};
+const parentStyle = {overflow: 'hidden'};
+
+const marks = {
+  '-10': '-10°C',
+  0: <strong>0°C</strong>,
+  26: '26°C',
+  37: '37°C',
+  50: '50°C',
+  100: {
+    style: {
+      color: 'red',
+    },
+    label: <strong>100°C</strong>,
+  },
+};
+
+function log(value) {
+  console.log(value);
+}
+
+ReactDOM.render(
+  <div style={parentStyle}>
+    <div style={style}>
+      <p>Slider with marks, `step=null`</p>
+      <Slider vertical min={-10} marks={marks} step={null} onChange={log} defaultValue={20} />
+    </div>
+    <div style={style}>
+       <p>Slider with marks and steps</p>
+      <Slider vertical dots min={-10} marks={marks} step={10} onChange={log} defaultValue={20} />
+    </div>
+    <div style={style}>
+      <p>Slider with marks, `included=false`</p>
+      <Slider vertical min={-10} marks={marks} included={false} defaultValue={20} />
+    </div>
+    <div style={style}>
+      <p>Slider with marks and steps, `included=false`</p>
+      <Slider vertical min={-10} marks={marks} step={10} included={false} defaultValue={20} />
+    </div>
+    <div style={style}>
+      <p>Range with marks</p>
+      <Slider vertical min={-10} range marks={marks} onChange={log} defaultValue={[20, 40]} />
+    </div>
+    <div style={style}>
+      <p>Range with marks and steps</p>
+      <Slider vertical min={-10} range marks={marks} step={10} onChange={log} defaultValue={[20, 40]} />
+    </div>
+  </div>
+  , document.getElementById('__react-content'));

examples/v-range.js

@@ -0,0 +1,116 @@
+/* eslint react/no-multi-comp: 0 */
+require('rc-slider/assets/index.less');
+
+const React = require('react');
+const ReactDOM = require('react-dom');
+const Slider = require('rc-slider');
+
+const style = {float: 'left', width: 180, height: 400, marginBottom: 160, marginLeft: 50};
+const parentStyle = {overflow: 'hidden'};
+
+function log(value) {
+  console.log(value);
+}
+
+const CustomizedRange = React.createClass({
+  getInitialState: function() {
+    return {
+      lowerBound: 20,
+      upperBound: 40,
+      value: [20, 40],
+    };
+  },
+  onLowerBoundChange: function(e) {
+    this.setState({ lowerBound: +e.target.value });
+  },
+  onUpperBoundChange: function(e) {
+    this.setState({ upperBound: +e.target.value });
+  },
+  onSliderChange: function(value) {
+    log(value);
+    this.setState({
+      value: value,
+    });
+  },
+  handleApply: function() {
+    const { lowerBound, upperBound } = this.state;
+    this.setState({ value: [lowerBound, upperBound]});
+  },
+  render: function() {
+    return (
+      <div style={style}>
+        <Slider range vertical allowCross={false} value={this.state.value} onChange={this.onSliderChange} />
+        <label>LowerBound: </label>
+        <input type="number" value={this.state.lowerBound} onChange={this.onLowerBoundChange} />
+        <br />
+        <label>UpperBound: </label>
+        <input type="number" value={this.state.upperBound} onChange={this.onUpperBoundChange} />
+        <br />
+        <button onClick={this.handleApply}>Apply</button>
+      </div>
+    );
+  },
+});
+
+const DynamicBounds = React.createClass({
+  getInitialState() {
+    return {
+      min: 0,
+      max: 100,
+    };
+  },
+  onSliderChange: function(value) {
+    log(value);
+  },
+  onMinChange: function(e) {
+    this.setState({
+      min: +e.target.value || 0,
+    });
+  },
+  onMaxChange: function(e) {
+    this.setState({
+      max: +e.target.value || 100,
+    });
+  },
+  render: function() {
+    return (
+      <div style={style}>
+        <Slider range vertical defaultValue={[20, 50]} min={this.state.min} max={this.state.max} onChange={this.onSliderChange} />
+        <label>Min: </label>
+        <input type="number" value={this.state.min} onChange={this.onMinChange} />
+        <br />
+        <label>Max: </label>
+        <input type="number" value={this.state.max} onChange={this.onMaxChange} />
+      </div>
+    );
+  },
+});
+
+ReactDOM.render(
+  <div style={parentStyle}>
+    <div style={style}>
+      <p>Basic Range，`allowCross=false`</p>
+      <Slider range vertical allowCross={false} defaultValue={[0, 20]} onChange={log} />
+    </div>
+    <div style={style}>
+      <p>Basic Range，`step=20` </p>
+      <Slider range vertical step={20} defaultValue={[20, 40]} onBeforeChange={log} />
+    </div>
+    <div style={style}>
+      <p>Basic Range，`step=20, dots` </p>
+      <Slider range vertical dots step={20} defaultValue={[20, 40]} onAfterChange={log} />
+    </div>
+    <div style={style}>
+      <p>Controlled Range</p>
+      <Slider range vertical value={[20, 40]} />
+    </div>
+    <div style={style}>
+      <p>Customized Range</p>
+      <CustomizedRange />
+    </div>
+    <div style={style}>
+      <p>Range with dynamic `max` `min`</p>
+      <DynamicBounds />
+    </div>
+  </div>
+  , document.getElementById('__react-content'));

examples/v-slider.html

@@ -0,0 +1 @@
+placeholder

examples/v-slider.js

@@ -0,0 +1,106 @@
+/* eslint react/no-multi-comp: 0 */
+require('rc-slider/assets/index.less');
+
+const React = require('react');
+const ReactDOM = require('react-dom');
+const Slider = require('rc-slider');
+
+const style = {float: 'left', width: 200, height: 400, marginBottom: 160, marginLeft: 50};
+const parentStyle = {overflow: 'hidden'};
+
+function log(value) {
+  console.log(value);
+}
+
+
+function percentFormatter(v) {
+  return v + ' %';
+}
+
+const CustomizedSlider = React.createClass({
+  getInitialState: function() {
+    return {
+      value: 50,
+    };
+  },
+  onSliderChange: function(value) {
+    log(value);
+    this.setState({
+      value: value,
+    });
+  },
+  render: function() {
+    return <Slider vertical value={this.state.value} onChange={this.onSliderChange} />;
+  },
+});
+
+const DynamicBounds = React.createClass({
+  getInitialState: function() {
+    return {
+      min: 0,
+      max: 100,
+    };
+  },
+  onSliderChange: function(value) {
+    log(value);
+  },
+  onMinChange: function(e) {
+    this.setState({
+      min: +e.target.value || 0,
+    });
+  },
+  onMaxChange: function(e) {
+    this.setState({
+      max: +e.target.value || 100,
+    });
+  },
+  render: function() {
+    return (
+      <div style={style}>
+        <p>Slider with dynamic `min` `max`</p>
+        <Slider vertical defaultValue={50} min={this.state.min} max={this.state.max} onChange={this.onSliderChange} />
+        <label>Min: </label>
+        <input type="number" value={this.state.min} onChange={this.onMinChange} />
+        <br />
+        <label>Max: </label>
+        <input type="number" value={this.state.max} onChange={this.onMaxChange} />
+      </div>
+    );
+  },
+});
+
+ReactDOM.render(
+  <div style={parentStyle}>
+    <div style={style}>
+      <p>Basic Slider</p>
+      <Slider vertical tipTransitionName="rc-slider-tooltip-zoom-down" onChange={log} />
+    </div>
+    <div style={style}>
+      <p>Basic Slider，`step=20`</p>
+      <Slider vertical step={20} defaultValue={50} onBeforeChange={log} />
+    </div>
+    <div style={style}>
+      <p>Basic Slider，`step=20, dots`</p>
+      <Slider vertical dots step={20} defaultValue={100} onAfterChange={log} />
+    </div>
+    <div style={style}>
+      <p>Basic Slider with `tipFormatter`</p>
+      <Slider vertical tipFormatter={percentFormatter} tipTransitionName="rc-slider-tooltip-zoom-down" onChange={log} />
+    </div>
+    <div style={style}>
+      <p>Basic Slider without tooltip</p>
+      <Slider vertical tipFormatter={null} onChange={log} />
+    </div>
+    <div style={style}>
+      <p>Controlled Slider</p>
+      <Slider vertical value={50} />
+    </div>
+    <div style={style}>
+      <p>Customized Slider</p>
+      <CustomizedSlider />
+    </div>
+    <div>
+      <DynamicBounds />
+    </div>
+  </div>
+  , document.getElementById('__react-content'));

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rc-slider",
-  "version": "3.5.1",
+  "version": "3.6.0",
   "description": "slider ui component for react",
   "keywords": [
     "react",

src/Handle.jsx

@@ -24,10 +24,10 @@ export default class Handle extends React.Component {
 
   render() {
     const props = this.props;
-    const {className, tipTransitionName, tipFormatter, offset, value} = props;
+    const {className, tipTransitionName, tipFormatter, vertical, offset, value} = props;
     const {dragging, noTip} = props;
 
-    const style = { left: offset + '%' };
+    const style = vertical ? { bottom: offset + '%' } : { left: offset + '%' };
     const handle = (<div className={className} style={style}
                       onMouseUp={this.showTooltip.bind(this)}
                       onMouseEnter={this.showTooltip.bind(this)}
@@ -52,6 +52,7 @@ export default class Handle extends React.Component {
 
 Handle.propTypes = {
   className: React.PropTypes.string,
+  vertical: React.PropTypes.bool,
   offset: React.PropTypes.number,
   tipTransitionName: React.PropTypes.string,
   tipFormatter: React.PropTypes.func,

src/Marks.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import classNames from 'classnames';
 
-const Marks = ({className, marks, included, upperBound, lowerBound, max, min}) => {
+const Marks = ({className, vertical, marks, included, upperBound, lowerBound, max, min}) => {
   const marksKeys = Object.keys(marks);
   const marksCount = marksKeys.length;
   const unit = 100 / (marksCount - 1);
@@ -16,11 +16,19 @@ const Marks = ({className, marks, included, upperBound, lowerBound, max, min}) =
       [className + '-text-active']: isActived,
     });
 
-    const style = {
+    const bottomStyle = {
+      // height: markWidth + '%',
+      marginBottom: '-200' + '%',
+      bottom: (point - min) / range * 100 + '%',
+    };
+
+    const leftStyle = {
       width: markWidth + '%',
       marginLeft: -markWidth / 2 + '%',
+      left: (point - min) / range * 100 + '%',
     };
-    style.left = (point - min) / range * 100 + '%';
+
+    const style = vertical ? bottomStyle : leftStyle;
 
     const markPoint = marks[point];
     const markPointIsObject = typeof markPoint === 'object' &&

src/Slider.jsx

@@ -13,12 +13,12 @@ function isNotTouchEvent(e) {
   return e.touches.length > 1 || (e.type.toLowerCase() === 'touchend' && e.touches.length > 0);
 }
 
-function getTouchPosition(e) {
-  return e.touches[0].pageX;
+function getTouchPosition(vertical, e) {
+  return vertical ? e.touches[0].clientY : e.touches[0].pageX;
 }
 
-function getMousePosition(e) {
-  return e.pageX;
+function getMousePosition(vertical, e) {
+  return vertical ? e.clientY : e.pageX;
 }
 
 function pauseEvent(e) {
@@ -113,7 +113,7 @@ class Slider extends React.Component {
   }
 
   onMouseMove(e) {
-    const position = getMousePosition(e);
+    const position = getMousePosition(this.props.vertical, e);
     this.onMove(e, position);
   }
 
@@ -123,7 +123,7 @@ class Slider extends React.Component {
       return;
     }
 
-    const position = getTouchPosition(e);
+    const position = getTouchPosition(this.props.vertical, e);
     this.onMove(e, position);
   }
 
@@ -132,7 +132,8 @@ class Slider extends React.Component {
     const props = this.props;
     const state = this.state;
 
-    const diffPosition = position - this.startPosition;
+    let diffPosition = position - this.startPosition;
+    diffPosition = this.props.vertical ? -diffPosition : diffPosition;
     const diffValue = diffPosition / this.getSliderLength() * (props.max - props.min);
 
     const value = this.trimAlignValue(this.startValue + diffValue);
@@ -164,14 +165,14 @@ class Slider extends React.Component {
   onTouchStart(e) {
     if (isNotTouchEvent(e)) return;
 
-    const position = getTouchPosition(e);
+    const position = getTouchPosition(this.props.vertical, e);
     this.onStart(position);
     this.addDocumentEvents('touch');
     pauseEvent(e);
   }
 
   onMouseDown(e) {
-    const position = getMousePosition(e);
+    const position = getMousePosition(this.props.vertical, e);
     this.onStart(position);
     this.addDocumentEvents('mouse');
     pauseEvent(e);
@@ -229,14 +230,14 @@ class Slider extends React.Component {
       return 0;
     }
 
-    return slider.clientWidth;
+    return this.props.vertical ? slider.clientHeight : slider.clientWidth;
   }
 
   getSliderStart() {
     const slider = this.refs.slider;
     const rect = slider.getBoundingClientRect();
 
-    return rect.left;
+    return this.props.vertical ? rect.top : rect.left;
   }
 
   getPrecision() {
@@ -291,9 +292,10 @@ class Slider extends React.Component {
   }
 
   calcValue(offset) {
-    const {min, max} = this.props;
-    const ratio = offset / this.getSliderLength();
-    return ratio * (max - min) + min;
+    const {vertical, min, max} = this.props;
+    const ratio = Math.abs(offset / this.getSliderLength());
+    const value = vertical ? (1 - ratio) * (max - min) + min : ratio * (max - min) + min;
+    return value;
   }
 
   calcValueByPos(position) {
@@ -331,7 +333,7 @@ class Slider extends React.Component {
 
   render() {
     const {handle, upperBound, lowerBound} = this.state;
-    const {className, prefixCls, disabled, dots, included, range, step,
+    const {className, prefixCls, disabled, vertical, dots, included, range, step,
       marks, max, min, tipTransitionName, tipFormatter, children} = this.props;
 
     const upperOffset = this.calcOffset(upperBound);
@@ -342,19 +344,20 @@ class Slider extends React.Component {
 
     const upper = (<Handle className={handleClassName}
                            noTip={isNoTip} tipTransitionName={tipTransitionName} tipFormatter={tipFormatter}
-                           offset={upperOffset} value={upperBound} dragging={handle === 'upperBound'}/>);
+                           vertical = {vertical} offset={upperOffset} value={upperBound} dragging={handle === 'upperBound'}/>);
 
     let lower = null;
     if (range) {
       lower = (<Handle className={handleClassName}
                        noTip={isNoTip} tipTransitionName={tipTransitionName} tipFormatter={tipFormatter}
-                       offset={lowerOffset} value={lowerBound} dragging={handle === 'lowerBound'}/>);
+                       vertical = {vertical} offset={lowerOffset} value={lowerBound} dragging={handle === 'lowerBound'}/>);
     }
 
     const sliderClassName = classNames({
       [prefixCls]: true,
       [prefixCls + '-disabled']: disabled,
       [className]: !!className,
+      [prefixCls + '-vertical']: this.props.vertical,
     });
     const isIncluded = included || range;
     return (
@@ -363,12 +366,12 @@ class Slider extends React.Component {
            onMouseDown={disabled ? noop : this.onMouseDown.bind(this)}>
         {upper}
         {lower}
-        <Track className={prefixCls + '-track'} included={isIncluded}
+        <Track className={prefixCls + '-track'} vertical = {vertical} included={isIncluded}
                offset={lowerOffset} length={upperOffset - lowerOffset}/>
-        <Steps prefixCls={prefixCls} marks={marks} dots={dots} step={step}
+        <Steps prefixCls={prefixCls} vertical = {vertical} marks={marks} dots={dots} step={step}
               included={isIncluded} lowerBound={lowerBound}
               upperBound={upperBound} max={max} min={min}/>
-        <Marks className={prefixCls + '-mark'} marks={marks}
+        <Marks className={prefixCls + '-mark'} vertical = {vertical} marks={marks}
                included={isIncluded} lowerBound={lowerBound}
                upperBound={upperBound} max={max} min={min}/>
         {children}
@@ -402,6 +405,7 @@ Slider.propTypes = {
   tipFormatter: React.PropTypes.func,
   dots: React.PropTypes.bool,
   range: React.PropTypes.bool,
+  vertical: React.PropTypes.bool,
   allowCross: React.PropTypes.bool,
 };
 
@@ -421,6 +425,7 @@ Slider.defaultProps = {
   disabled: false,
   dots: false,
   range: false,
+  vertical: false,
   allowCross: true,
 };
 

src/Steps.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import classNames from 'classnames';
 
-function calcPoints(marks, dots, step, min, max) {
+function calcPoints(vertical, marks, dots, step, min, max) {
   const points = Object.keys(marks).map(parseFloat);
   if (dots) {
     for (let i = min; i <= max; i = i + step) {
@@ -12,12 +12,12 @@ function calcPoints(marks, dots, step, min, max) {
   return points;
 }
 
-const Steps = ({prefixCls, marks, dots, step, included,
+const Steps = ({prefixCls, vertical, marks, dots, step, included,
                 lowerBound, upperBound, max, min}) => {
   const range = max - min;
-  const elements = calcPoints(marks, dots, step, min, max).map((point) => {
-    const offset = (point - min) / range * 100 + '%';
-    const style = { left: offset };
+  const elements = calcPoints(vertical, marks, dots, step, min, max).map((point) => {
+    const offset = Math.abs(point - min) / range * 100 + '%';
+    const style = vertical ? { bottom: offset } : { left: offset };
 
     const isActived = (!included && point === upperBound) ||
             (included && point <= upperBound && point >= lowerBound);

src/Track.jsx

@@ -1,11 +1,16 @@
 import React from 'react';
 
-const Track = ({className, included, offset, length}) => {
+const Track = ({className, included, vertical, offset, length}) => {
   const style = {
-    left: offset + '%',
-    width: length + '%',
     visibility: included ? 'visible' : 'hidden',
   };
+  if (vertical) {
+    style.bottom = offset + '%';
+    style.height = length + '%';
+  } else {
+    style.left = offset + '%';
+    style.width = length + '%';
+  }
   return <div className={className} style={style} />;
 };
 

tests/index.spec.js

@@ -6,7 +6,7 @@ const Slider = require('..');
 
 require('../assets/index.less');
 
-describe('rc-slider', function() {
+describe('rc-slider', function test() {
   this.timeout(5000);
   const div = document.createElement('div');
   document.body.appendChild(div);
@@ -140,4 +140,9 @@ describe('rc-slider', function() {
     expect(range.state.upperBound).to.be(90);
     ReactDOM.unmountComponentAtNode(div);
   });
+
+  it('should render a vertical slider, when `vertical` is true', () => {
+    const slider = ReactDOM.render(<Slider vertical />, div);
+    expect(ReactTestUtils.scryRenderedDOMComponentsWithClass(slider, 'rc-slider-vertical').length).to.be(1);
+  });
 });