@khanacademy/wonder-blocks-clickable 2.4.0 → 2.4.1

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @khanacademy/wonder-blocks-clickable
 
+## 2.4.1
+
+### Patch Changes
+
+-   4c682709: handleClick no longer redundantly triggers on mouseup
+
 ## 2.4.0
 
 ### Minor Changes

package/dist/es/index.js

@@ -41,7 +41,6 @@ const disabledHandlers = {
   onMouseLeave: () => void 0,
   onMouseDown: () => void 0,
   onMouseUp: () => void 0,
-  onDragStart: () => void 0,
   onTouchStart: () => void 0,
   onTouchEnd: () => void 0,
   onTouchCancel: () => void 0,
@@ -91,12 +90,7 @@ class ClickableBehavior extends React.Component {
     };
 
     this.handleMouseEnter = e => {
-      if (e.buttons === 1) {
-        this.dragging = true;
-        this.setState({
-          pressed: true
-        });
-      } else if (!this.waitingForClick) {
+      if (!this.waitingForClick) {
         this.setState({
           hovered: true
         });
@@ -105,7 +99,6 @@ class ClickableBehavior extends React.Component {
 
     this.handleMouseLeave = () => {
       if (!this.waitingForClick) {
-        this.dragging = false;
         this.setState({
           hovered: false,
           pressed: false,
@@ -121,22 +114,12 @@ class ClickableBehavior extends React.Component {
     };
 
     this.handleMouseUp = e => {
-      if (this.dragging) {
-        this.dragging = false;
-        this.handleClick(e);
-      }
-
       this.setState({
         pressed: false,
         focused: false
       });
     };
 
-    this.handleDragStart = e => {
-      this.dragging = true;
-      e.preventDefault();
-    };
-
     this.handleTouchStart = () => {
       this.setState({
         pressed: true
@@ -226,7 +209,6 @@ class ClickableBehavior extends React.Component {
     this.state = startState;
     this.waitingForClick = false;
     this.enterClick = false;
-    this.dragging = false;
   }
 
   navigateOrReset(shouldNavigate) {
@@ -358,7 +340,6 @@ class ClickableBehavior extends React.Component {
       onMouseLeave: this.handleMouseLeave,
       onMouseDown: this.handleMouseDown,
       onMouseUp: this.handleMouseUp,
-      onDragStart: this.handleDragStart,
       onTouchStart: this.handleTouchStart,
       onTouchEnd: this.handleTouchEnd,
       onTouchCancel: this.handleTouchCancel,

package/dist/index.js

@@ -158,7 +158,6 @@ const disabledHandlers = {
   onMouseLeave: () => void 0,
   onMouseDown: () => void 0,
   onMouseUp: () => void 0,
-  onDragStart: () => void 0,
   onTouchStart: () => void 0,
   onTouchEnd: () => void 0,
   onTouchCancel: () => void 0,
@@ -197,7 +196,7 @@ const startState = {
  * 3. Keyup (spacebar/enter) -> focus state
  *
  * Warning: The event handlers returned (onClick, onMouseEnter, onMouseLeave,
- * onMouseDown, onMouseUp, onDragStart, onTouchStart, onTouchEnd, onTouchCancel,
+ * onMouseDown, onMouseUp, onTouchStart, onTouchEnd, onTouchCancel,
  * onKeyDown, onKeyUp, onFocus, onBlur, tabIndex) should be passed on to the
  * component that has the ClickableBehavior. You cannot override these handlers
  * without potentially breaking the functionality of ClickableBehavior.
@@ -293,13 +292,7 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
     };
 
     this.handleMouseEnter = e => {
-      // When the left button is pressed already, we want it to be pressed
-      if (e.buttons === 1) {
-        this.dragging = true;
-        this.setState({
-          pressed: true
-        });
-      } else if (!this.waitingForClick) {
+      if (!this.waitingForClick) {
         this.setState({
           hovered: true
         });
@@ -308,7 +301,6 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
 
     this.handleMouseLeave = () => {
       if (!this.waitingForClick) {
-        this.dragging = false;
         this.setState({
           hovered: false,
           pressed: false,
@@ -324,22 +316,12 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
     };
 
     this.handleMouseUp = e => {
-      if (this.dragging) {
-        this.dragging = false;
-        this.handleClick(e);
-      }
-
       this.setState({
         pressed: false,
         focused: false
       });
     };
 
-    this.handleDragStart = e => {
-      this.dragging = true;
-      e.preventDefault();
-    };
-
     this.handleTouchStart = () => {
       this.setState({
         pressed: true
@@ -435,7 +417,6 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
     this.state = startState;
     this.waitingForClick = false;
     this.enterClick = false;
-    this.dragging = false;
   }
 
   navigateOrReset(shouldNavigate) {
@@ -589,7 +570,6 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
       onMouseLeave: this.handleMouseLeave,
       onMouseDown: this.handleMouseDown,
       onMouseUp: this.handleMouseUp,
-      onDragStart: this.handleDragStart,
       onTouchStart: this.handleTouchStart,
       onTouchEnd: this.handleTouchEnd,
       onTouchCancel: this.handleTouchCancel,
@@ -1136,19 +1116,16 @@ function _extends() {
   module.exports = _extends = Object.assign ? Object.assign.bind() : function (target) {
     for (var i = 1; i < arguments.length; i++) {
       var source = arguments[i];
-
       for (var key in source) {
         if (Object.prototype.hasOwnProperty.call(source, key)) {
           target[key] = source[key];
         }
       }
     }
-
     return target;
   }, module.exports.__esModule = true, module.exports["default"] = module.exports;
   return _extends.apply(this, arguments);
 }
-
 module.exports = _extends, module.exports.__esModule = true, module.exports["default"] = module.exports;
 
 /***/ }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanacademy/wonder-blocks-clickable",
-  "version": "2.4.0",
+  "version": "2.4.1",
   "design": "v1",
   "description": "Clickable component for Wonder-Blocks.",
   "main": "dist/index.js",

package/src/components/__docs__/clickable.stories.js

@@ -66,6 +66,13 @@ export const Default: StoryComponentType = (args) => (
     </Clickable>
 );
 
+Default.args = {
+    onClick: () => {
+        // eslint-disable-next-line no-alert
+        alert("Click!");
+    },
+};
+
 export const Basic: StoryComponentType = () => (
     <View style={styles.centerText}>
         <Clickable

package/src/components/__tests__/clickable-behavior.test.js

@@ -64,7 +64,7 @@ describe("ClickableBehavior", () => {
         expect(onClick).toHaveBeenCalled();
     });
 
-    it("changes only hovered state on mouse enter/leave", () => {
+    it("changes hovered state on mouse enter/leave", () => {
         const onClick = jest.fn();
         render(
             <ClickableBehavior disabled={false} onClick={(e) => onClick(e)}>
@@ -82,7 +82,7 @@ describe("ClickableBehavior", () => {
         expect(button).not.toHaveTextContent("hovered");
     });
 
-    it("changes only pressed state on mouse enter/leave while dragging", () => {
+    it("changes hovered state on mouse enter while dragging", () => {
         const onClick = jest.fn();
         render(
             <ClickableBehavior disabled={false} onClick={(e) => onClick(e)}>
@@ -93,18 +93,34 @@ describe("ClickableBehavior", () => {
             </ClickableBehavior>,
         );
         const button = screen.getByRole("button");
+        expect(button).not.toHaveTextContent("hovered");
+        expect(button).not.toHaveTextContent("pressed");
+
+        fireEvent.mouseEnter(button, {buttons: 1});
+        expect(button).not.toHaveTextContent("pressed");
+        expect(button).toHaveTextContent("hovered");
+    });
+
+    it("changes pressed and hover states on mouse leave while dragging", () => {
+        const onClick = jest.fn();
+        render(
+            <ClickableBehavior disabled={false} onClick={(e) => onClick(e)}>
+                {(state, childrenProps) => {
+                    const label = labelForState(state);
+                    return <button {...childrenProps}>{label}</button>;
+                }}
+            </ClickableBehavior>,
+        );
+        const button = screen.getByRole("button");
+        expect(button).not.toHaveTextContent("hovered");
         expect(button).not.toHaveTextContent("pressed");
 
         fireEvent.mouseDown(button);
-        fireEvent.dragStart(button);
-        fireEvent.mouseMove(button);
         expect(button).toHaveTextContent("pressed");
 
         fireEvent.mouseLeave(button);
+        expect(button).not.toHaveTextContent("hovered");
         expect(button).not.toHaveTextContent("pressed");
-
-        fireEvent.mouseEnter(button, {buttons: 1});
-        expect(button).toHaveTextContent("pressed");
     });
 
     it("changes pressed state on mouse down/up", () => {
@@ -763,7 +779,17 @@ describe("ClickableBehavior", () => {
         expect(onClick).toHaveBeenCalledTimes(expectedNumberTimesCalled);
     });
 
-    it("calls onClick on mouseup when the mouse was dragging", () => {
+    // The following two tests involve click behavior when dragging.
+    // Here are some notable related actions that cannot be tested using
+    // existing jest/RTL events since these click types are handled
+    // by browsers but aren't registered as clicks by RTL/jest:
+    // 1. Mousedown in the button, drag within the button, and mouseup
+    //    in the button (mouse doesn't leave the button at any point).
+    //    This should result in a successful click.
+    // 2. Mouse down in the button, drag out of the button (don't let go),
+    //    drag back into the button, and mouseup inside the button.
+    //    This should result in a successful click.
+    it("does not call onClick on mouseup when the mouse presses inside and drags away", () => {
         const onClick = jest.fn();
         render(
             <ClickableBehavior disabled={false} onClick={(e) => onClick(e)}>
@@ -775,19 +801,25 @@ describe("ClickableBehavior", () => {
 
         const button = screen.getByRole("button");
         fireEvent.mouseDown(button);
-        fireEvent.dragStart(button);
         fireEvent.mouseLeave(button);
         fireEvent.mouseUp(button);
         expect(onClick).toHaveBeenCalledTimes(0);
+    });
 
-        fireEvent.mouseDown(button);
-        fireEvent.dragStart(button);
-        fireEvent.mouseUp(button);
-        expect(onClick).toHaveBeenCalledTimes(1);
+    it("does not call onClick on mouseup when the mouse presses outside and drags in", () => {
+        const onClick = jest.fn();
+        render(
+            <ClickableBehavior disabled={false} onClick={(e) => onClick(e)}>
+                {(state, childrenProps) => {
+                    return <button {...childrenProps}>Label</button>;
+                }}
+            </ClickableBehavior>,
+        );
 
+        const button = screen.getByRole("button");
         fireEvent.mouseEnter(button, {buttons: 1});
         fireEvent.mouseUp(button);
-        expect(onClick).toHaveBeenCalledTimes(2);
+        expect(onClick).toHaveBeenCalledTimes(0);
     });
 
     it("doesn't trigger enter key when browser doesn't stop the click", () => {

package/src/components/clickable-behavior.js

@@ -205,7 +205,6 @@ export type ChildrenProps = {|
     onMouseLeave: () => mixed,
     onMouseDown: () => mixed,
     onMouseUp: (e: SyntheticMouseEvent<>) => mixed,
-    onDragStart: (e: SyntheticMouseEvent<>) => mixed,
     onTouchStart: () => mixed,
     onTouchEnd: () => mixed,
     onTouchCancel: () => mixed,
@@ -223,7 +222,6 @@ const disabledHandlers = {
     onMouseLeave: () => void 0,
     onMouseDown: () => void 0,
     onMouseUp: () => void 0,
-    onDragStart: () => void 0,
     onTouchStart: () => void 0,
     onTouchEnd: () => void 0,
     onTouchCancel: () => void 0,
@@ -265,7 +263,7 @@ const startState: ClickableState = {
  * 3. Keyup (spacebar/enter) -> focus state
  *
  * Warning: The event handlers returned (onClick, onMouseEnter, onMouseLeave,
- * onMouseDown, onMouseUp, onDragStart, onTouchStart, onTouchEnd, onTouchCancel,
+ * onMouseDown, onMouseUp, onTouchStart, onTouchEnd, onTouchCancel,
  * onKeyDown, onKeyUp, onFocus, onBlur, tabIndex) should be passed on to the
  * component that has the ClickableBehavior. You cannot override these handlers
  * without potentially breaking the functionality of ClickableBehavior.
@@ -330,7 +328,6 @@ export default class ClickableBehavior extends React.Component<
 > {
     waitingForClick: boolean;
     enterClick: boolean;
-    dragging: boolean;
 
     static defaultProps: DefaultProps = {
         disabled: false,
@@ -356,7 +353,6 @@ export default class ClickableBehavior extends React.Component<
         this.state = startState;
         this.waitingForClick = false;
         this.enterClick = false;
-        this.dragging = false;
     }
 
     navigateOrReset(shouldNavigate: boolean) {
@@ -513,18 +509,13 @@ export default class ClickableBehavior extends React.Component<
     };
 
     handleMouseEnter: (e: SyntheticMouseEvent<>) => void = (e) => {
-        // When the left button is pressed already, we want it to be pressed
-        if (e.buttons === 1) {
-            this.dragging = true;
-            this.setState({pressed: true});
-        } else if (!this.waitingForClick) {
+        if (!this.waitingForClick) {
             this.setState({hovered: true});
         }
     };
 
     handleMouseLeave: () => void = () => {
         if (!this.waitingForClick) {
-            this.dragging = false;
             this.setState({hovered: false, pressed: false, focused: false});
         }
     };
@@ -534,18 +525,9 @@ export default class ClickableBehavior extends React.Component<
     };
 
     handleMouseUp: (e: SyntheticMouseEvent<>) => void = (e) => {
-        if (this.dragging) {
-            this.dragging = false;
-            this.handleClick(e);
-        }
         this.setState({pressed: false, focused: false});
     };
 
-    handleDragStart: (e: SyntheticMouseEvent<>) => void = (e) => {
-        this.dragging = true;
-        e.preventDefault();
-    };
-
     handleTouchStart: () => void = () => {
         this.setState({pressed: true});
     };
@@ -630,7 +612,6 @@ export default class ClickableBehavior extends React.Component<
                   onMouseLeave: this.handleMouseLeave,
                   onMouseDown: this.handleMouseDown,
                   onMouseUp: this.handleMouseUp,
-                  onDragStart: this.handleDragStart,
                   onTouchStart: this.handleTouchStart,
                   onTouchEnd: this.handleTouchEnd,
                   onTouchCancel: this.handleTouchCancel,