2.3.2

feat: make range and marks props to work together

README.md

@@ -102,27 +102,15 @@ ReactDOM.render(<Rcslider />, container);
         </tr>
         <tr>
           <td>defaultValue</td>
-          <td>number</td>
-          <td>0</td>
-          <td>If range is `false`, this prop will set the initial position of the handle.</td>
-        </tr>
-        <tr>
-          <td>defaultValues</td>
-          <td>[number, number]</td>
-          <td>[0, 0]</td>
-          <td>If range is `true`, this prop will set initial positions of handles respectively.</td>
+          <td>number or [number, number]</td>
+          <td>0 or [0, 0]</td>
+          <td>Set initial positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number]`</td>
         </tr>
         <tr>
           <td>value</td>
-          <td>number</td>
+          <td>number or [number, number]</td>
           <td></td>
-          <td>If range is `false`, this prop will set the current position of the handle.</td>
-        </tr>
-        <tr>
-          <td>values</td>
-          <td>[number, number]</td>
-          <td></td>
-          <td>If range is `true`, this prop will set current positions of handles respectively.</td>
+          <td>Set current positions of handles. If range is `false`, the type of `defaultValue` should be `number`. Otherwise, `[number, number]`</td>
         </tr>
         <tr>
           <td>marks</td>
@@ -131,7 +119,7 @@ ReactDOM.render(<Rcslider />, container);
           <td>Mark every step for the slider, it will ignore the `step` parameter if it has been defined. Does not work with `range`</td>
         </tr>
         <tr>
-          <td>isIncluded</td>
+          <td>included</td>
           <td>boolean</td>
           <td>true</td>
           <td>If the value is `true`, it means a continuous value interval, otherwise, it is a independent value.</td>
@@ -161,10 +149,16 @@ ReactDOM.render(<Rcslider />, container);
           <td>Set the animation for tooltip if it shows.</td>
         </tr>
         <tr>
-          <td>withDots</td>
+          <td>tipFormatter</td>
+          <td>func</td>
+          <td></td>
+          <td>Format the value of the tooltip if it shows.</td>
+        </tr>
+        <tr>
+          <td>dots</td>
           <td>bool</td>
           <td>false</td>
-          <td>For linear slider, when the `step` value is greater than 1, you can set the `withDots` to  `true` if you want to render the slider bar with dots.</td>
+          <td>For linear slider, when the `step` value is greater than 1, you can set the `dots` to  `true` if you want to render the slider bar with dots.</td>
         </tr>
     </tbody>
 </table>

assets/index.less

@@ -146,13 +146,13 @@
       display: none;
     }
 
-    &-placement-points-bc-tc {
+    &-placement-top {
       padding: @tooltip-arrow-width 0 @tooltip-distance 0;
     }
 
     &-inner {
-      padding: 6px 0;
-      width: 24px;
+      padding: 6px 2px;
+      min-width: 24px;
       height: 24px;
       font-size: 12px;
       line-height: 1;
@@ -172,7 +172,7 @@
       border-style: solid;
     }
 
-    &-placement-points-bc-tc &-arrow {
+    &-placement-top &-arrow {
       bottom: @tooltip-distance - @tooltip-arrow-width;
       left: 50%;
       margin-left: -@tooltip-arrow-width;

examples/simple.js

@@ -3,42 +3,56 @@
 require('rc-slider/assets/index.less');
 
 var React = require('react');
+var ReactDOM = require('react-dom');
 var Slider = require('rc-slider');
 var style = {width:400,margin:50};
 
-function onChange(v) {
-  console.log(v);
+var log = console.log.bind(console);
+
+
+var marks = ["状态1","状态2","状态3","状态4"];
+
+function percentFormatter(v) {
+  return v + " %";
 }
 
-React.render(
+ReactDOM.render(
   <div>
     <div style={style}>
       <p>基础滑块</p>
-      <Slider onChange={onChange} tipTransitionName='rc-slider-tooltip-zoom-down' />
+      <Slider onChange={log} tipTransitionName='rc-slider-tooltip-zoom-down' />
     </div>
     <div style={style}>
       <p>基础滑块，step=20</p>
       <Slider step={20} />
     </div>
     <div style={style}>
-      <p>基础滑块，step=20 带原点</p>
-      <Slider withDots step={20} />
+      <p>基础滑块，step=20 带圆点</p>
+      <Slider dots step={20} />
     </div>
     <div style={style}>
       <p>双滑块</p>
-      <Slider range={true} min={10} max={90} values={[0, 30]} onChange={onChange} />
+      <Slider range min={10} max={90} defaultValue={[0, 30]} onChange={log} />
     </div>
     <div style={style}>
       <p>双滑块，step=20 </p>
-      <Slider range={true} withDots step={20} values={[0, 30]} onChange={onChange} isIncluded={false} />
+      <Slider range dots step={20} defaultValue={[0, 30]} onAfterChange={log} included={false} />
     </div>
     <div style={style}>
       <p>分段式滑块（包含关系）</p>
-      <Slider marks={["状态1","状态2","状态3","状态4"]} defaultIndex={1} />
+      <Slider marks={marks} defaultIndex={1} />
+    </div>
+    <div style={style}>
+      <p>分段式滑块 (双)</p>
+      <Slider range marks={marks} onChange={log} defaultIndex={[1,2]} />
     </div>
     <div style={style}>
       <p>分段式滑块（并列关系）</p>
-      <Slider marks={["状态1","状态2","状态3","状态4"]} isIncluded={false} defaultIndex={1} />
+      <Slider marks={marks} included={false} defaultIndex={1} />
+    </div>
+    <div style={style}>
+      <p>基础滑块</p>
+      <Slider onChange={log} tipFormatter={percentFormatter} tipTransitionName='rc-slider-tooltip-zoom-down' />
     </div>
   </div>
   , document.getElementById('__react-content'));

package.json

@@ -1,6 +1,6 @@
 {
   "name": "rc-slider",
-  "version": "1.6.0",
+  "version": "2.3.2",
   "description": "slider ui component for react",
   "keywords": [
     "react",
@@ -40,18 +40,18 @@
   "devDependencies": {
     "expect.js": "0.3.x",
     "jquery": "^1.11.2",
-    "precommit-hook": "^1.0.7",
+    "pre-commit": "1.x",
     "rc-server": "3.x",
     "rc-tools": "4.x",
     "react": "~0.14.0",
     "react-addons-test-utils": "^0.14.0",
     "react-dom": "~0.14.0"
   },
-  "precommit": [
+  "pre-commit": [
     "lint"
   ],
   "dependencies": {
-    "rc-tooltip": "2.x",
-    "rc-util": "2.x"
+    "rc-tooltip": "3.x",
+    "rc-util": "3.x"
   }
 }

src/Handle.jsx

@@ -24,7 +24,7 @@ export default class Handle extends React.Component {
 
   render() {
     const props = this.props;
-    const {className, tipTransitionName, offset, value} = props;
+    const {className, tipTransitionName, tipFormatter, offset, value} = props;
     const {dragging, noTip} = props;
 
     const style = { left: offset + '%' };
@@ -40,9 +40,9 @@ export default class Handle extends React.Component {
     const isTooltipVisible = dragging || this.state.isTooltipVisible;
     return (<Tooltip
               prefixCls={className.replace('handle', 'tooltip')}
-              placement={{points: ['bc', 'tc']}}
+              placement="top"
               visible={isTooltipVisible}
-              overlay={<span>{value}</span>}
+              overlay={<span>{tipFormatter ? tipFormatter(value) : value}</span>}
               delay={0}
               transitionName={tipTransitionName}>
               {handle}
@@ -54,6 +54,7 @@ Handle.propTypes = {
   className: React.PropTypes.string,
   offset: React.PropTypes.number,
   tipTransitionName: React.PropTypes.string,
+  tipFormatter: React.PropTypes.func,
   value: React.PropTypes.number,
   dragging: React.PropTypes.bool,
   noTip: React.PropTypes.bool,

src/Marks.jsx

@@ -1,14 +1,14 @@
 import React from 'react';
 import rcUtil from 'rc-util';
 
-const Marks = ({className, marks, index, isIncluded}) => {
+const Marks = ({className, marks, index, included}) => {
   const marksLen = marks.length;
   const unit = 100 / (marksLen - 1);
   const markWidth = unit / 2 + '%';
 
   const elements = [];
   for (let i = 0; i < marksLen; i++) {
-    const isActived = (isIncluded && i <= index) || (!isIncluded && i === index);
+    const isActived = (included && i <= index) || (!included && i === index);
     const markClassName = rcUtil.classSet({
       [className + '-text']: true,
       [className + '-text-active']: isActived,

src/Slider.jsx

@@ -1,11 +1,12 @@
 import React from 'react';
-import rcUtil, {Dom as DomUtils} from 'rc-util';
+import {Dom as DomUtils, classSet} from 'rc-util';
 import Track from './Track';
 import Handle from './Handle';
 import Steps from './Steps';
 import Marks from './Marks';
 
-function noop() {}
+function noop() {
+}
 
 function isNotTouchEvent(e) {
   return e.touches.length > 1 || (e.type.toLowerCase() === 'touchend' && e.touches.length > 0);
@@ -16,18 +17,20 @@ function getTouchPosition(e) {
 }
 
 function getMousePosition(e) {
-  return e.pageX || (e.clientX + document.documentElement.scrollLeft); // to compat ie8
+  return e.pageX;
 }
 
 function pauseEvent(e) {
-  e.cancelBubble = true;
-  e.returnValue = false;
-  if (e.stopPropagation) {
-    e.stopPropagation();
-  }
-  if (e.preventDefault) {
-    e.preventDefault();
-  }
+  e.stopPropagation();
+  e.preventDefault();
+}
+
+// This is an utility method, tries to get property, then defaultPropery with
+// special check using 'in', because propery can be '0'
+function propOrDefault(props, name, fallback) {
+  const defaultName = 'default' + name.charAt(0).toUpperCase() + name.substring(1);
+  const defaultValue = (defaultName in props ? props[defaultName] : fallback);
+  return (name in props ? props[name] : defaultValue);
 }
 
 class Slider extends React.Component {
@@ -36,17 +39,18 @@ class Slider extends React.Component {
 
     let upperBound;
     let lowerBound;
-    if (props.range) {
-      const values = (props.values || props.defaultValues);
-      upperBound = this.trimAlignValue(values[1]);
-      lowerBound = this.trimAlignValue(values[0]);
-    } else if (props.marks.length > 0) {
-      upperBound = this.calcValueFromProps(props);
+    const initialValue = props.range ? [0, 0] : 0;
+    if (props.marks.length > 0) {
+      const index = propOrDefault(props, 'index', initialValue);
+      ({lowerBound, upperBound} = this.getBoundsFromIndex(index, props));
     } else {
-      // Note: Maybe `value` is `0`.
-      //       So, check the existence of `value` with `in`.
-      const value = ('value' in props ? props.value : props.defaultValue);
-      upperBound = this.trimAlignValue(value);
+      const value = propOrDefault(props, 'value', initialValue);
+      if (props.range) {
+        lowerBound = this.trimAlignValue(value[0]);
+        upperBound = this.trimAlignValue(value[1]);
+      } else {
+        upperBound = this.trimAlignValue(value);
+      }
     }
 
     let recent;
@@ -72,11 +76,11 @@ class Slider extends React.Component {
 
   componentWillReceiveProps(nextProps) {
     if (nextProps.range) {
-      const values = nextProps.values;
-      if (values) {
+      const value = nextProps.value;
+      if (value) {
         this.setState({
-          upperBound: values[1],
-          lowerBound: values[0],
+          upperBound: value[1],
+          lowerBound: value[0],
         });
       }
     } else if ('value' in nextProps) {
@@ -84,9 +88,8 @@ class Slider extends React.Component {
         upperBound: nextProps.value,
       });
     } else if ('index' in nextProps) {
-      this.setState({
-        upperBound: this.calcValueFromProps(nextProps),
-      });
+      const index = ('index' in nextProps ? nextProps.index : nextProps.defaultIndex);
+      this.setState(this.getBoundsFromIndex(index, nextProps));
     }
   }
 
@@ -118,16 +121,9 @@ class Slider extends React.Component {
     if (value === oldValue) return;
 
     if (!('value' in props) && !('index' in props)) {
-      this.setState({[state.handle]: value});
-    }
-
-    if (props.range) {
-      // `this.state` will not be updated immediately after `this.setState`.
-      // So, create a similar object.
-      const data = Object.assign({}, state, {[state.handle]: value});
-      this.triggerEvents('onChange', [data.lowerBound, data.upperBound]);
-    } else {
-      this.triggerEvents('onChange', value);
+      this.setState({[state.handle]: value}, () => {
+        this.triggerEvents('onChange', this.getValue());
+      });
     }
   }
 
@@ -154,24 +150,38 @@ class Slider extends React.Component {
     this.startValue = value;
     this.startPosition = position;
 
-    const {upperBound, lowerBound} = this.state;
-    const isUpperBoundCloser = Math.abs(upperBound - value) < Math.abs(lowerBound - value);
-    let valueNeedChanging = (!this.props.range || isUpperBoundCloser) ? 'upperBound' : 'lowerBound';
-    const isAtTheSamePoint = (upperBound === lowerBound);
-    valueNeedChanging = isAtTheSamePoint ? this.state.recent : valueNeedChanging;
+    const state = this.state;
+    const {upperBound, lowerBound} = state;
+
+    let valueNeedChanging = 'upperBound';
+    if (this.props.range) {
+      const isLowerBoundCloser = Math.abs(upperBound - value) > Math.abs(lowerBound - value);
+      if (isLowerBoundCloser) {
+        valueNeedChanging = 'lowerBound';
+      }
+
+      const isAtTheSamePoint = (upperBound === lowerBound);
+      if (isAtTheSamePoint) {
+        valueNeedChanging = state.recent;
+      }
+
+      if (isAtTheSamePoint && (value !== upperBound)) {
+        valueNeedChanging = value < upperBound ? 'lowerBound' : 'upperBound';
+      }
+    }
 
     this.setState({
       handle: valueNeedChanging,
       recent: valueNeedChanging,
       [valueNeedChanging]: value,
+    }, () => {
+      this.triggerEvents('onChange', this.getValue());
     });
+  }
 
-    if (this.props.range) {
-      const data = Object.assign({}, this.state, {[valueNeedChanging]: value});
-      this.triggerEvents('onChange', [data.lowerBound, data.upperBound]);
-    } else {
-      this.triggerEvents('onChange', value);
-    }
+  getValue() {
+    const {lowerBound, upperBound} = this.state;
+    return this.props.range ? [lowerBound, upperBound] : upperBound;
   }
 
   getIndex(value) {
@@ -184,6 +194,18 @@ class Slider extends React.Component {
     return Math.round(value / unit);
   }
 
+  getBoundsFromIndex(value, props) {
+    if (props.range) {
+      return {
+        lowerBound: this.calcValueFromIndex(value[0], props),
+        upperBound: this.calcValueFromIndex(value[1], props),
+      };
+    }
+    return {
+      upperBound: this.calcValueFromIndex(value, props),
+    };
+  }
+
   getSliderLength() {
     const slider = this.refs.slider;
     if (!slider) {
@@ -248,10 +270,9 @@ class Slider extends React.Component {
     return nextValue;
   }
 
-  calcValueFromProps(props) {
+  calcValueFromIndex(index, props) {
     const marksLen = props.marks.length;
     if (marksLen > 0) {
-      const index = ('index' in props ? props.index : props.defaultIndex);
       const value = ((props.max - props.min) / (marksLen - 1)) * (index);
       // `'1' / 1 => 1`, to make sure that the returned value is a `Number`.
       return value.toFixed(5) / 1;
@@ -265,7 +286,11 @@ class Slider extends React.Component {
     if (props[event]) {
       let data;
       if (hasMarks) {
-        data = this.getIndex(v);
+        if (props.range) {
+          data = v.map(bound => this.getIndex(bound));
+        } else {
+          data = this.getIndex(v);
+        }
       } else if (v === undefined) {
         data = this.state.value;
       } else {
@@ -298,18 +323,18 @@ class Slider extends React.Component {
 
   end(type) {
     this.removeEventons(type);
-    this.triggerEvents('onAfterChange');
-    this.setState({ handle: null });
+    this.triggerEvents('onAfterChange', this.getValue());
+    this.setState({handle: null});
   }
 
   render() {
     const {handle, upperBound, lowerBound} = this.state;
     const props = this.props;
-    const {className, prefixCls, disabled, isIncluded, withDots, range} = props;
-    const {marks, step, max, min, tipTransitionName, children} = props;
+    const {className, prefixCls, disabled, included, isIncluded, dots, range} = props;
+    const {marks, step, max, min, tipTransitionName, tipFormatter, children} = props;
     const marksLen = marks.length;
 
-    const sliderClassName = rcUtil.classSet({
+    const sliderClassName = classSet({
       [prefixCls]: true,
       [prefixCls + '-disabled']: disabled,
       [className]: !!className,
@@ -319,44 +344,44 @@ class Slider extends React.Component {
     const lowerOffset = this.calcOffset(lowerBound);
 
     let track = null;
-    if (isIncluded || range) {
+    if ((included && isIncluded) || range) {
       const trackClassName = prefixCls + '-track';
-      track = <Track className={trackClassName} offset={lowerOffset} length={upperOffset - lowerOffset} />;
+      track = <Track className={trackClassName} offset={lowerOffset} length={upperOffset - lowerOffset}/>;
     }
 
     const handleClassName = prefixCls + '-handle';
-    const isNoTip = marksLen > 0;
-    const upper = (<Handle className={handleClassName} tipTransitionName={tipTransitionName} noTip={isNoTip}
+    const isNoTip = (marksLen > 0) && !tipFormatter;
+    const upper = (<Handle className={handleClassName} tipTransitionName={tipTransitionName} noTip={isNoTip} tipFormatter={tipFormatter}
                      offset={upperOffset} value={upperBound} dragging={handle === 'upperBound'} />);
 
     let lower = null;
     if (range) {
-      lower = (<Handle className={handleClassName} tipTransitionName={tipTransitionName} noTip={isNoTip}
+      lower = (<Handle className={handleClassName} tipTransitionName={tipTransitionName} noTip={isNoTip} tipFormatter={tipFormatter}
                  offset={lowerOffset} value={lowerBound} dragging={handle === 'lowerBound'} />);
     }
 
     const upperIndex = this.getIndex(upperBound);
 
     let steps = null;
-    if (marksLen > 0 || (step > 1 && withDots)) {
+    if (marksLen > 0 || (step > 1 && dots)) {
       const stepsClassName = prefixCls + '-step';
       const stepNum = marksLen > 0 ? marksLen : Math.floor((max - min) / step) + 1;
       steps = (<Steps className={stepsClassName} stepNum={stepNum}
-                 lowerIndex={this.getIndex(lowerBound)} upperIndex={upperIndex}
-                 isIncluded={isIncluded || range} />);
+                      lowerIndex={this.getIndex(lowerBound)} upperIndex={upperIndex}
+                      included={(included && isIncluded) || range}/>);
     }
 
     let mark = null;
     if (marksLen > 0) {
       const markClassName = prefixCls + '-mark';
       mark = (<Marks className={markClassName} marks={marks}
-                 index={upperIndex} isIncluded={isIncluded} />);
+                     index={upperIndex} included={(included && isIncluded)}/>);
     }
 
     return (
       <div ref="slider" className={sliderClassName}
-        onTouchStart={disabled ? noop : this.onTouchStart.bind(this)}
-        onMouseDown={disabled ? noop : this.onSliderMouseDown.bind(this)}>
+           onTouchStart={disabled ? noop : this.onTouchStart.bind(this)}
+           onMouseDown={disabled ? noop : this.onSliderMouseDown.bind(this)}>
         {track}
         {upper}
         {lower}
@@ -372,14 +397,25 @@ Slider.propTypes = {
   min: React.PropTypes.number,
   max: React.PropTypes.number,
   step: React.PropTypes.number,
-  defaultValue: React.PropTypes.number,
-  defaultValues: React.PropTypes.arrayOf(React.PropTypes.number),
-  defaultIndex: React.PropTypes.number,
-  value: React.PropTypes.number,
-  values: React.PropTypes.arrayOf(React.PropTypes.number),
-  index: React.PropTypes.number,
+  defaultValue: React.PropTypes.oneOfType([
+    React.PropTypes.number,
+    React.PropTypes.arrayOf(React.PropTypes.number),
+  ]),
+  defaultIndex: React.PropTypes.oneOfType([
+    React.PropTypes.number,
+    React.PropTypes.arrayOf(React.PropTypes.number),
+  ]),
+  value: React.PropTypes.oneOfType([
+    React.PropTypes.number,
+    React.PropTypes.arrayOf(React.PropTypes.number),
+  ]),
+  index: React.PropTypes.oneOfType([
+    React.PropTypes.number,
+    React.PropTypes.arrayOf(React.PropTypes.number),
+  ]),
   marks: React.PropTypes.array,
-  isIncluded: React.PropTypes.bool,
+  isIncluded: React.PropTypes.bool, // @Deprecated
+  included: React.PropTypes.bool,
   className: React.PropTypes.string,
   prefixCls: React.PropTypes.string,
   disabled: React.PropTypes.bool,
@@ -388,7 +424,8 @@ Slider.propTypes = {
   onChange: React.PropTypes.func,
   onAfterChange: React.PropTypes.func,
   tipTransitionName: React.PropTypes.string,
-  withDots: React.PropTypes.bool,
+  tipFormatter: React.PropTypes.func,
+  dots: React.PropTypes.bool,
   range: React.PropTypes.bool,
 };
 
@@ -396,16 +433,15 @@ Slider.defaultProps = {
   min: 0,
   max: 100,
   step: 1,
-  defaultValue: 0,
-  defaultValues: [0, 0],
   defaultIndex: 0,
   marks: [],
-  isIncluded: true,
+  isIncluded: true, // @Deprecated
+  included: true,
   className: '',
   prefixCls: 'rc-slider',
   disabled: false,
   tipTransitionName: '',
-  withDots: false,
+  dots: false,
   range: false,
 };
 

src/Steps.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import rcUtil from 'rc-util';
 
-const Steps = ({className, stepNum, isIncluded, lowerIndex, upperIndex}) => {
+const Steps = ({className, stepNum, included, lowerIndex, upperIndex}) => {
   const dotClassName = className.replace('step', 'dot');
   const unit = 100 / (stepNum - 1);
 
@@ -10,8 +10,8 @@ const Steps = ({className, stepNum, isIncluded, lowerIndex, upperIndex}) => {
     const offset = unit * i + '%';
     const style = { left: offset };
 
-    const isActived = (isIncluded && i <= upperIndex && i >= lowerIndex ) ||
-            (!isIncluded && i === upperIndex);
+    const isActived = (included && i <= upperIndex && i >= lowerIndex ) ||
+            (!included && i === upperIndex);
     const stepClassName = rcUtil.classSet({
       [dotClassName]: true,
       [dotClassName + '-active']: isActived,

tests/index.spec.js

@@ -42,8 +42,8 @@ describe('rc-slider', function () {
     expect(node.find('.rc-slider-track').length).to.be(1);
     expect(slider.state.upperBound).to.be(0);
 
-    var sliderWithDots = React.render(
-      <Slider className='rc-slider' step={20} withDots/>,
+    var sliderWithDots = ReactDOM.render(
+      <Slider className='rc-slider' step={20} dots/>,
       div
     );
     var node1 = $(div);