Skip to content

Added interactiveUpdate callback to differentiate between in-progress slider changes (mousemove/touchmove) and final slider value change (mouseup/touchup). #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Added interactiveUpdate callback to differentiate between in-progress slider changes (mousemove/touchmove) and final slider value change (mouseup/touchup). #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,18 @@ If accepting a single value, pass a number to `value` prop, i.e.:
/>
```

To differentiate between an interactive update (eg, an in-progress mousemove of the slider) and a final change, include an onInteractiveUpdate handler. A final change event will be fired when the interactive updated is completed.

```{js}
<InputRange
maxValue={20}
minValue={0}
value={this.state.value}
onInteractiveUpdate={this.handleInteractiveUpdate.bind(this)}
onChange={this.handleValueChange.bind(this)}
/>
```

### Options
Property | Type | Description
:-----------------------|:-----------------------------------|:----------------------------------
Expand All @@ -78,6 +90,7 @@ maxValue |number |Maximum value it c
minValue |number |Minimum value it can accept
name |string |Name of `form` input
onChange |Function |`onChange` callback (required)
onInteractiveUpdate |Function |`onInteractiveUpdate` callback
step |number |Increment/decrement value
value |number &vert; Object.&lt;number&gt; |Current value(s) (required)

Expand Down
54 changes: 40 additions & 14 deletions dist/react-input-range.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,12 @@ function isWithinRange(inputRange, values) {
return values.max >= props.minValue && values.max <= props.maxValue;
}

function isInteractiveUpdateEnd(inputRange, interactiveUpdate) {
var props = inputRange.props;

return interactiveUpdate === false && props.onInteractiveUpdate;
}

function hasStepDifference(inputRange, values) {
var props = inputRange.props;

Expand All @@ -67,8 +73,8 @@ function hasStepDifference(inputRange, values) {
return (0, _util.length)(values.min, currentValues.min) >= props.step || (0, _util.length)(values.max, currentValues.max) >= props.step;
}

function shouldUpdate(inputRange, values) {
return isWithinRange(inputRange, values) && hasStepDifference(inputRange, values);
function shouldUpdate(inputRange, values, interactiveUpdate) {
return isWithinRange(inputRange, values) && (hasStepDifference(inputRange, values) || isInteractiveUpdateEnd(inputRange, interactiveUpdate));
}

function getComponentClassName(inputRange) {
Expand Down Expand Up @@ -150,6 +156,7 @@ function renderSliders(inputRange) {
minValue: minValue,
onSliderKeyDown: inputRange.handleSliderKeyDown,
onSliderMouseMove: inputRange.handleSliderMouseMove,
onSliderMouseUp: inputRange.handleSliderMouseUp,
percentage: percentage,
ref: ref,
type: key,
Expand Down Expand Up @@ -217,22 +224,22 @@ var InputRange = (function (_React$Component) {

_get(Object.getPrototypeOf(InputRange.prototype), 'constructor', this).call(this, props);

(0, _util.autobind)(['handleSliderMouseMove', 'handleSliderKeyDown', 'handleTrackMouseDown'], this);
(0, _util.autobind)(['handleSliderMouseMove', 'handleSliderMouseUp', 'handleSliderKeyDown', 'handleTrackMouseDown'], this);
}

_createClass(InputRange, [{
key: 'updatePosition',
value: function updatePosition(key, position) {
value: function updatePosition(key, position, interactiveUpdate) {
var values = _valueTransformer2['default'].valuesFromProps(this);
var positions = _valueTransformer2['default'].positionsFromValues(this, values);

positions[key] = position;

this.updatePositions(positions);
this.updatePositions(positions, interactiveUpdate);
}
}, {
key: 'updatePositions',
value: function updatePositions(positions) {
value: function updatePositions(positions, interactiveUpdate) {
var values = {
min: _valueTransformer2['default'].valueFromPosition(this, positions.min),
max: _valueTransformer2['default'].valueFromPosition(this, positions.max)
Expand All @@ -243,28 +250,29 @@ var InputRange = (function (_React$Component) {
max: _valueTransformer2['default'].stepValueFromValue(this, values.max)
};

this.updateValues(transformedValues);
this.updateValues(transformedValues, interactiveUpdate);
}
}, {
key: 'updateValue',
value: function updateValue(key, value) {
value: function updateValue(key, value, interactiveUpdate) {
var values = _valueTransformer2['default'].valuesFromProps(this);

values[key] = value;

this.updateValues(values);
this.updateValues(values, interactiveUpdate);
}
}, {
key: 'updateValues',
value: function updateValues(values) {
if (!shouldUpdate(this, values)) {
value: function updateValues(values, interactiveUpdate) {
if (!shouldUpdate(this, values, interactiveUpdate)) {
return;
}

var changeFn = interactiveUpdate && this.props.onInteractiveUpdate ? this.props.onInteractiveUpdate : this.props.onChange;
if (this.isMultiValue) {
this.props.onChange(this, values);
changeFn(this, values);
} else {
this.props.onChange(this, values.max);
changeFn(this, values.max);
}
}
}, {
Expand Down Expand Up @@ -293,7 +301,19 @@ var InputRange = (function (_React$Component) {
var key = getKeyFromSlider(this, slider);
var position = _valueTransformer2['default'].positionFromEvent(this, event);

this.updatePosition(key, position);
this.updatePosition(key, position, true);
}
}, {
key: 'handleSliderMouseUp',
value: function handleSliderMouseUp(slider, event) {
if (this.props.disabled) {
return;
}

var key = getKeyFromSlider(this, slider);
var position = _valueTransformer2['default'].positionFromEvent(this, event);

this.updatePosition(key, position, false);
}
}, {
key: 'handleSliderKeyDown',
Expand Down Expand Up @@ -403,6 +423,7 @@ InputRange.propTypes = {
maxValue: _propTypes.maxMinValuePropType,
minValue: _propTypes.maxMinValuePropType,
name: _react2['default'].PropTypes.string,
onInteractiveUpdate: _react2['default'].PropTypes.func,
onChange: _react2['default'].PropTypes.func.isRequired,
step: _react2['default'].PropTypes.number,
value: _propTypes.maxMinValuePropType
Expand Down Expand Up @@ -558,6 +579,8 @@ var Slider = (function (_React$Component) {
value: function handleMouseUp() {
var document = getDocument(this);

this.props.onSliderMouseUp(this, event);

document.removeEventListener('mousemove', this.handleMouseMove);
document.removeEventListener('mouseup', this.handleMouseUp);
}
Expand Down Expand Up @@ -588,6 +611,8 @@ var Slider = (function (_React$Component) {

event.preventDefault();

this.props.onSliderMouseUp(this, event);

document.removeEventListener('touchmove', this.handleTouchMove);
document.removeEventListener('touchend', this.handleTouchEnd);
}
Expand Down Expand Up @@ -642,6 +667,7 @@ Slider.propTypes = {
minValue: _react2['default'].PropTypes.number,
onSliderKeyDown: _react2['default'].PropTypes.func.isRequired,
onSliderMouseMove: _react2['default'].PropTypes.func.isRequired,
onSliderMouseUp: _react2['default'].PropTypes.func.isRequired,
percentage: _react2['default'].PropTypes.number.isRequired,
type: _react2['default'].PropTypes.string.isRequired,
value: _react2['default'].PropTypes.number.isRequired
Expand Down
Loading