@khanacademy/wonder-blocks-clickable 2.3.3 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @khanacademy/wonder-blocks-clickable
 
+## 2.4.0
+
+### Minor Changes
+
+-   ceb111df: ClickableBehavior no longer has tabIndex 0 by default. It must be passed in.
+
 ## 2.3.3
 
 ### Patch Changes

package/dist/es/index.js

@@ -46,8 +46,7 @@ const disabledHandlers = {
   onTouchEnd: () => void 0,
   onTouchCancel: () => void 0,
   onKeyDown: () => void 0,
-  onKeyUp: () => void 0,
-  tabIndex: 0
+  onKeyUp: () => void 0
 };
 const keyCodes = {
   enter: 13,
@@ -351,7 +350,8 @@ class ClickableBehavior extends React.Component {
   render() {
     const childrenProps = this.props.disabled ? _extends({}, disabledHandlers, {
       onFocus: this.handleFocus,
-      onBlur: this.handleBlur
+      onBlur: this.handleBlur,
+      tabIndex: this.props.tabIndex
     }) : {
       onClick: this.handleClick,
       onMouseEnter: this.handleMouseEnter,
@@ -366,7 +366,7 @@ class ClickableBehavior extends React.Component {
       onKeyUp: this.handleKeyUp,
       onFocus: this.handleFocus,
       onBlur: this.handleBlur,
-      tabIndex: 0
+      tabIndex: this.props.tabIndex
     };
     childrenProps.rel = this.props.rel || (this.props.target === "_blank" ? "noopener noreferrer" : undefined);
     const {

package/dist/index.js

@@ -163,10 +163,7 @@ const disabledHandlers = {
   onTouchEnd: () => void 0,
   onTouchCancel: () => void 0,
   onKeyDown: () => void 0,
-  onKeyUp: () => void 0,
-  // Clickable components should still be tabbable so they can
-  // be used as anchors.
-  tabIndex: 0
+  onKeyUp: () => void 0
 };
 const keyCodes = {
   enter: 13,
@@ -225,7 +222,11 @@ const startState = {
  *   const ClickableBehavior = getClickableBehavior();
  *
  *   return (
- *       <ClickableBehavior disabled={props.disabled} onClick={props.onClick}>
+ *       <ClickableBehavior
+ *           disabled={props.disabled}
+ *           onClick={props.onClick}
+ *           tabIndex={0}
+ *        >
  *           {({hovered}, childrenProps) => (
  *               <RoundRect
  *                   textcolor="white"
@@ -580,7 +581,8 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
     const childrenProps = this.props.disabled ? { ...disabledHandlers,
       // Keep these handlers for keyboard accessibility.
       onFocus: this.handleFocus,
-      onBlur: this.handleBlur
+      onBlur: this.handleBlur,
+      tabIndex: this.props.tabIndex
     } : {
       onClick: this.handleClick,
       onMouseEnter: this.handleMouseEnter,
@@ -595,9 +597,7 @@ class ClickableBehavior extends react__WEBPACK_IMPORTED_MODULE_0__["Component"]
       onKeyUp: this.handleKeyUp,
       onFocus: this.handleFocus,
       onBlur: this.handleBlur,
-      // We set tabIndex to 0 so that users can tab to clickable
-      // things that aren't buttons or anchors.
-      tabIndex: 0
+      tabIndex: this.props.tabIndex
     }; // When the link is set to open in a new window, we want to set some
     // `rel` attributes. This is to ensure that the links we're sending folks
     // to can't hijack the existing page.  These defaults can be overriden

package/package.json

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

package/src/components/__docs__/clickable-behavior.argtypes.js

@@ -14,6 +14,15 @@ export default {
             },
         },
     },
+    tabIndex: {
+        control: {type: "number"},
+        description: `Used to indicate the tab order of an element.
+            Use 0 to make an element focusable, and use -1 to make an
+            element non-focusable via keyboard navigation.`,
+        table: {
+            type: {summary: "number"},
+        },
+    },
     /**
      * States
      */

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

@@ -3,7 +3,7 @@ import * as React from "react";
 import {StyleSheet} from "aphrodite";
 
 import {getClickableBehavior} from "@khanacademy/wonder-blocks-clickable";
-import {View} from "@khanacademy/wonder-blocks-core";
+import {View, addStyle} from "@khanacademy/wonder-blocks-core";
 import Color from "@khanacademy/wonder-blocks-color";
 import Spacing from "@khanacademy/wonder-blocks-spacing";
 
@@ -72,12 +72,98 @@ Default.parameters = {
     },
 };
 
+export const WrappingButton: StoryComponentType = (args) => {
+    const ClickableBehavior = getClickableBehavior();
+    const StyledButton = addStyle("button");
+
+    return (
+        <ClickableBehavior {...args}>
+            {(state, childrenProps) => {
+                const {pressed, hovered, focused} = state;
+                return (
+                    <StyledButton
+                        style={[
+                            styles.clickable,
+                            styles.newButton,
+                            hovered && styles.hovered,
+                            focused && styles.focused,
+                            pressed && styles.pressed,
+                        ]}
+                        {...childrenProps}
+                    >
+                        This is an element wrapped with ClickableBehavior
+                    </StyledButton>
+                );
+            }}
+        </ClickableBehavior>
+    );
+};
+
+WrappingButton.parameters = {
+    chromatic: {
+        // we don't need screenshots because this story only displays the
+        // resting/default state.
+        disableSnapshot: true,
+    },
+    docs: {
+        storyDescription: `This is an example of a \`<ClickableBehavior>\`
+            wrapping a button. Since buttons have a built in tabIndex,
+            a tabIndex does not need to be added to \`<ClickableBehavior>\`
+            here.`,
+    },
+};
+
+export const WithTabIndex: StoryComponentType = () => {
+    const ClickableBehavior = getClickableBehavior();
+
+    return (
+        <ClickableBehavior role="button" tabIndex={0}>
+            {(state, childrenProps) => {
+                const {pressed, hovered, focused} = state;
+                return (
+                    <View
+                        style={[
+                            styles.clickable,
+                            hovered && styles.hovered,
+                            focused && styles.focused,
+                            pressed && styles.pressed,
+                        ]}
+                        {...childrenProps}
+                    >
+                        This is an element wrapped with ClickableBehavior
+                    </View>
+                );
+            }}
+        </ClickableBehavior>
+    );
+};
+
+WithTabIndex.parameters = {
+    chromatic: {
+        // we don't need screenshots because this story only displays the
+        // resting/default state.
+        disableSnapshot: true,
+    },
+    docs: {
+        storyDescription: `A \`<ClickableBehavior>\` element does not have
+            a tabIndex by default, as many elements it could wrap may have
+            their own built in tabIndex attribute, such as buttons. If this
+            is not the case, a tabIndex should be passed in using the
+            \`tabIndex\` prop.`,
+    },
+};
+
 const styles = StyleSheet.create({
     clickable: {
         cursor: "pointer",
         padding: Spacing.medium_16,
         textAlign: "center",
     },
+    newButton: {
+        border: "none",
+        backgroundColor: Color.white,
+        width: "100%",
+    },
     hovered: {
         textDecoration: "underline",
         backgroundColor: Color.blue,

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

@@ -282,7 +282,7 @@ describe("ClickableBehavior", () => {
         expect(button).not.toHaveTextContent("focused");
     });
 
-    test("tabIndex should be 0", () => {
+    test("should not have a tabIndex if one is not passed in", () => {
         // Arrange
         // Act
         render(
@@ -299,14 +299,18 @@ describe("ClickableBehavior", () => {
 
         // Assert
         const button = screen.getByTestId("test-button-1");
-        expect(button).toHaveAttribute("tabIndex", "0");
+        expect(button).not.toHaveAttribute("tabIndex");
     });
 
-    test("tabIndex should be 0 even for disabled components", () => {
+    test("should have the tabIndex that is passed in", () => {
         // Arrange
         // Act
         render(
-            <ClickableBehavior disabled={true} onClick={(e) => {}}>
+            <ClickableBehavior
+                disabled={false}
+                onClick={(e) => {}}
+                tabIndex={1}
+            >
                 {(state, childrenProps) => {
                     return (
                         <button data-test-id="test-button-2" {...childrenProps}>
@@ -319,7 +323,53 @@ describe("ClickableBehavior", () => {
 
         // Assert
         const button = screen.getByTestId("test-button-2");
-        expect(button).toHaveAttribute("tabIndex", "0");
+        expect(button).toHaveAttribute("tabIndex", "1");
+    });
+
+    test("should have the tabIndex that is passed in even if disabled", () => {
+        // Arrange
+        // Act
+        render(
+            <ClickableBehavior disabled={true} onClick={(e) => {}} tabIndex={1}>
+                {(state, childrenProps) => {
+                    return (
+                        <button data-test-id="test-button-3" {...childrenProps}>
+                            Label
+                        </button>
+                    );
+                }}
+            </ClickableBehavior>,
+        );
+
+        // Assert
+        const button = screen.getByTestId("test-button-3");
+        expect(button).toHaveAttribute("tabIndex", "1");
+    });
+
+    test("should make non-interactive children keyboard focusable if tabIndex 0 is passed", () => {
+        // Arrange
+        render(
+            <ClickableBehavior
+                disabled={false}
+                onClick={(e) => {}}
+                tabIndex={1}
+            >
+                {(state, childrenProps) => {
+                    return (
+                        <div data-test-id="test-div-1" {...childrenProps}>
+                            Label
+                        </div>
+                    );
+                }}
+            </ClickableBehavior>,
+        );
+
+        // Act
+        const button = screen.getByTestId("test-div-1");
+        userEvent.tab();
+
+        // Assert
+        expect(button).toHaveFocus();
     });
 
     it("does not change state if disabled", () => {

package/src/components/clickable-behavior.js

@@ -88,6 +88,13 @@ type CommonProps = {|
 
     skipClientNav?: boolean,
 
+    /**
+     * Used to indicate the tab order of an element.
+     * Use 0 to make an element focusable, and use -1 to make an
+     * element non-focusable via keyboard navigation.
+     */
+    tabIndex?: number,
+
     /**
      * A function to be executed `onclick`.
      */
@@ -206,7 +213,7 @@ export type ChildrenProps = {|
     onKeyUp: (e: SyntheticKeyboardEvent<>) => mixed,
     onFocus: (e: SyntheticFocusEvent<>) => mixed,
     onBlur: (e: SyntheticFocusEvent<>) => mixed,
-    tabIndex: number,
+    tabIndex?: number,
     rel?: string,
 |};
 
@@ -222,9 +229,6 @@ const disabledHandlers = {
     onTouchCancel: () => void 0,
     onKeyDown: () => void 0,
     onKeyUp: () => void 0,
-    // Clickable components should still be tabbable so they can
-    // be used as anchors.
-    tabIndex: 0,
 };
 
 const keyCodes = {
@@ -286,7 +290,11 @@ const startState: ClickableState = {
  *   const ClickableBehavior = getClickableBehavior();
  *
  *   return (
- *       <ClickableBehavior disabled={props.disabled} onClick={props.onClick}>
+ *       <ClickableBehavior
+ *           disabled={props.disabled}
+ *           onClick={props.onClick}
+ *           tabIndex={0}
+ *        >
  *           {({hovered}, childrenProps) => (
  *               <RoundRect
  *                   textcolor="white"
@@ -614,6 +622,7 @@ export default class ClickableBehavior extends React.Component<
                   // Keep these handlers for keyboard accessibility.
                   onFocus: this.handleFocus,
                   onBlur: this.handleBlur,
+                  tabIndex: this.props.tabIndex,
               }
             : {
                   onClick: this.handleClick,
@@ -629,9 +638,7 @@ export default class ClickableBehavior extends React.Component<
                   onKeyUp: this.handleKeyUp,
                   onFocus: this.handleFocus,
                   onBlur: this.handleBlur,
-                  // We set tabIndex to 0 so that users can tab to clickable
-                  // things that aren't buttons or anchors.
-                  tabIndex: 0,
+                  tabIndex: this.props.tabIndex,
               };
 
         // When the link is set to open in a new window, we want to set some