add returnToDefaultPosition

Author: scarfi

build/cjs/Draggable.js

@@ -203,7 +203,7 @@ var Draggable = /*#__PURE__*/function (_React$Component) {
             y = _this$props$position.y;
         newState.x = x;
         newState.y = y;
-      } else {
+      } else if (_this.props.returnToDefaultPosition) {
         var _this$props$defaultPo = _this.props.defaultPosition,
             _x = _this$props$defaultPo.x,
             _y = _this$props$defaultPo.y;
@@ -265,6 +265,7 @@ var Draggable = /*#__PURE__*/function (_React$Component) {
       var _this$props = this.props,
           axis = _this$props.axis,
           bounds = _this$props.bounds,
+          returnToDefaultPosition = _this$props.returnToDefaultPosition,
           children = _this$props.children,
           defaultPosition = _this$props.defaultPosition,
           defaultClassName = _this$props.defaultClassName,
@@ -273,7 +274,7 @@ var Draggable = /*#__PURE__*/function (_React$Component) {
           position = _this$props.position,
           positionOffset = _this$props.positionOffset,
           scale = _this$props.scale,
-          draggableCoreProps = _objectWithoutProperties(_this$props, ["axis", "bounds", "children", "defaultPosition", "defaultClassName", "defaultClassNameDragging", "defaultClassNameDragged", "position", "positionOffset", "scale"]);
+          draggableCoreProps = _objectWithoutProperties(_this$props, ["axis", "bounds", "returnToDefaultPosition", "children", "defaultPosition", "defaultClassName", "defaultClassNameDragging", "defaultClassNameDragged", "position", "positionOffset", "scale"]);
 
       var style = {};
       var svgTransform = null; // If this is controlled, we don't want to move it - unless it's dragging.
@@ -369,6 +370,11 @@ _defineProperty(Draggable, "propTypes", _objectSpread({}, _DraggableCore.default
     top: _propTypes.default.number,
     bottom: _propTypes.default.number
   }), _propTypes.default.string, _propTypes.default.oneOf([false])]),
+
+  /**
+   * `returnToDefaultPosition` Determines if element returns to start position when drag ends.
+   */
+  returnToDefaultPosition: _propTypes.default.bool,
   defaultClassName: _propTypes.default.string,
   defaultClassNameDragging: _propTypes.default.string,
   defaultClassNameDragged: _propTypes.default.string,
@@ -435,6 +441,8 @@ _defineProperty(Draggable, "propTypes", _objectSpread({}, _DraggableCore.default
 _defineProperty(Draggable, "defaultProps", _objectSpread({}, _DraggableCore.default.defaultProps, {
   axis: 'both',
   bounds: false,
+  returnToDefaultPosition: false,
+  dragContainer: null,
   defaultClassName: 'react-draggable',
   defaultClassNameDragging: 'react-draggable-dragging',
   defaultClassNameDragged: 'react-draggable-dragged',

build/module/Draggable.js

@@ -30,6 +30,7 @@ import log from './utils/log';
   ...$Exact<DraggableCoreProps>,
   axis: 'both' | 'x' | 'y' | 'none',
   bounds: DraggableBounds | string | false,
+  returnToDefaultPosition: boolean,
   defaultClassName: string,
   defaultClassNameDragging: string,
   defaultClassNameDragged: string,
@@ -156,7 +157,7 @@ class Draggable extends React.Component
         } = this.props.position;
         newState.x = x;
         newState.y = y;
-      } else {
+      } else if (this.props.returnToDefaultPosition) {
         const {
           x,
           y
@@ -212,6 +213,7 @@ class Draggable extends React.Component
     const {
       axis,
       bounds,
+      returnToDefaultPosition,
       children,
       defaultPosition,
       defaultClassName,
@@ -319,6 +321,11 @@ _defineProperty(Draggable, "propTypes", { // Accepts all props <DraggableCore> a
     top: PropTypes.number,
     bottom: PropTypes.number
   }), PropTypes.string, PropTypes.oneOf([false])]),
+
+  /**
+   * `returnToDefaultPosition` Determines if element returns to start position when drag ends.
+   */
+  returnToDefaultPosition: PropTypes.bool,
   defaultClassName: PropTypes.string,
   defaultClassNameDragging: PropTypes.string,
   defaultClassNameDragged: PropTypes.string,
@@ -385,6 +392,8 @@ _defineProperty(Draggable, "propTypes", { // Accepts all props <DraggableCore> a
 _defineProperty(Draggable, "defaultProps", { ...DraggableCore.defaultProps,
   axis: 'both',
   bounds: false,
+  returnToDefaultPosition: false,
+  dragContainer: null,
   defaultClassName: 'react-draggable',
   defaultClassNameDragging: 'react-draggable-dragging',
   defaultClassNameDragged: 'react-draggable-dragged',

build/web/react-draggable.min.js

@@ -25,6 +25,7 @@ export type DraggableProps = {
   ...$Exact<DraggableCoreProps>,
   axis: 'both' | 'x' | 'y' | 'none',
   bounds: DraggableBounds | string | false,
+  returnToDefaultPosition: boolean,
   defaultClassName: string,
   defaultClassNameDragging: string,
   defaultClassNameDragged: string,
@@ -98,6 +99,11 @@ class Draggable extends React.Component<DraggableProps, DraggableState> {
       PropTypes.oneOf([false])
     ]),
 
+    /**
+     * `returnToDefaultPosition` Determines if element returns to start position when drag ends.
+     */
+    returnToDefaultPosition: PropTypes.bool,
+
     defaultClassName: PropTypes.string,
     defaultClassNameDragging: PropTypes.string,
     defaultClassNameDragged: PropTypes.string,
@@ -165,6 +171,7 @@ class Draggable extends React.Component<DraggableProps, DraggableState> {
     ...DraggableCore.defaultProps,
     axis: 'both',
     bounds: false,
+    returnToDefaultPosition: false,
     defaultClassName: 'react-draggable',
     defaultClassNameDragging: 'react-draggable-dragging',
     defaultClassNameDragged: 'react-draggable-dragged',
@@ -313,7 +320,7 @@ class Draggable extends React.Component<DraggableProps, DraggableState> {
       const {x, y} = this.props.position;
       newState.x = x;
       newState.y = y;
-    } else {
+    } else if (this.props.returnToDefaultPosition) {
       const {x, y} = this.props.defaultPosition;
       newState.x = x;
       newState.y = y;
@@ -326,6 +333,7 @@ class Draggable extends React.Component<DraggableProps, DraggableState> {
     const {
       axis,
       bounds,
+      returnToDefaultPosition,
       children,
       defaultPosition,
       defaultClassName,

build/web/react-draggable.min.js.map

@@ -43,6 +43,7 @@ describe('react-draggable', function () {
       assert(drag.props.handle === null);
       assert(drag.props.cancel === null);
       assert(drag.props.bounds == false);
+      assert(drag.props.returnToDefaultPosition == false);
       assert(typeof drag.props.onStart === 'function');
       assert(typeof drag.props.onDrag === 'function');
       assert(typeof drag.props.onStop === 'function');