@khanacademy/wonder-blocks-dropdown 2.4.4 → 2.6.0

package/src/components/__tests__/dropdown-core.test.js

@@ -2,12 +2,15 @@
 import * as React from "react";
 import * as ReactDOM from "react-dom";
 import {mount} from "enzyme";
+import "jest-enzyme";
 
 import OptionItem from "../option-item.js";
 import SearchTextInput from "../search-text-input.js";
 import DropdownCore from "../dropdown-core.js";
 import {keyCodes} from "../../util/constants.js";
 
+import {unmountAll} from "../../../../../utils/testing/enzyme-shim.js";
+
 jest.mock("../dropdown-core-virtualized.js");
 
 const elementAtIndex = (wrapper, index) =>
@@ -87,6 +90,12 @@ describe("DropdownCore", () => {
     });
 
     afterEach(() => {
+        // We have to explicitly unmount before clearing mocks, otherwise jest
+        // timers will throw because we'll try to clear an animation frame that
+        // we set with a setTimeout but are clearing with clearAnimationFrame
+        // because we restored the clearAnimationFrame mock (and we won't
+        // have cleared the timeout we actually set!)
+        unmountAll();
         jest.restoreAllMocks();
     });
 

package/src/components/__tests__/multi-select.test.js

@@ -2,6 +2,7 @@
 //@flow
 import * as React from "react";
 import {mount} from "enzyme";
+import "jest-enzyme";
 
 import {ClickableBehavior} from "@khanacademy/wonder-blocks-clickable";
 import IconButton from "@khanacademy/wonder-blocks-icon-button";
@@ -14,6 +15,8 @@ import MultiSelect from "../multi-select.js";
 import {keyCodes} from "../../util/constants.js";
 import SearchTextInput from "../search-text-input.js";
 
+import {unmountAll} from "../../../../../utils/testing/enzyme-shim.js";
+
 import type {Labels} from "../multi-select.js";
 
 jest.useFakeTimers();
@@ -68,6 +71,12 @@ describe("MultiSelect", () => {
     });
 
     afterEach(() => {
+        // We have to explicitly unmount before clearing mocks, otherwise jest
+        // timers will throw because we'll try to clear an animation frame that
+        // we set with a setTimeout but are clearing with clearAnimationFrame
+        // because we restored the clearAnimationFrame mock (and we won't
+        // have cleared the timeout we actually set!)
+        unmountAll();
         jest.restoreAllMocks();
     });
 

package/src/components/__tests__/search-text-input.test.js

@@ -1,6 +1,7 @@
 // @flow
 import * as React from "react";
 import {shallow} from "enzyme";
+import "jest-enzyme";
 
 import SearchTextInput from "../search-text-input.js";
 

package/src/components/__tests__/single-select.test.js

@@ -1,8 +1,6 @@
 //@flow
 import * as React from "react";
 import {render, screen} from "@testing-library/react";
-// eslint-disable-next-line import/no-unassigned-import
-import "@testing-library/jest-dom/extend-expect";
 
 import OptionItem from "../option-item.js";
 import SingleSelect from "../single-select.js";
@@ -25,8 +23,7 @@ describe("SingleSelect", () => {
     afterEach(() => {
         window.scrollTo.mockClear();
         onChange.mockReset();
-        // $FlowIgnore[prop-missing]: Flow doesn't understand that we're mocking console.error
-        console.error.mockReset(); // eslint-disable-line no-console
+        jest.spyOn(console, "error").mockReset();
     });
 
     afterEach(() => {
@@ -52,7 +49,7 @@ describe("SingleSelect", () => {
                 userEvent.click(opener);
 
                 // Assert
-                expect(screen.queryByRole("listbox")).toBeInTheDocument();
+                expect(screen.getByRole("listbox")).toBeInTheDocument();
             });
 
             it("should focus the first item in the dropdown", () => {
@@ -121,9 +118,7 @@ describe("SingleSelect", () => {
                         userEvent.keyboard(key);
 
                         // Assert
-                        expect(
-                            screen.queryByRole("listbox"),
-                        ).toBeInTheDocument();
+                        expect(screen.getByRole("listbox")).toBeInTheDocument();
                     });
 
                     it("should focus the first item in the dropdown", () => {
@@ -152,7 +147,7 @@ describe("SingleSelect", () => {
 
                 // Assert
                 expect(onChange).not.toHaveBeenCalled();
-                expect(screen.queryByRole("listbox")).toBeInTheDocument();
+                expect(screen.getByRole("listbox")).toBeInTheDocument();
             });
 
             it("should select an item when pressing {space}", () => {
@@ -278,7 +273,7 @@ describe("SingleSelect", () => {
             userEvent.click(screen.getByText("Choose"));
 
             // Assert
-            expect(screen.queryByRole("listbox")).toBeInTheDocument();
+            expect(screen.getByRole("listbox")).toBeInTheDocument();
         });
 
         it("closes the menu when the anchor is clicked", () => {
@@ -321,7 +316,7 @@ describe("SingleSelect", () => {
             userEvent.click(opener);
 
             // Assert
-            expect(screen.queryByRole("listbox")).toBeInTheDocument();
+            expect(screen.getByRole("listbox")).toBeInTheDocument();
         });
 
         it("calls the custom onClick handler", () => {

package/src/components/action-item.js

@@ -3,7 +3,7 @@
 import * as React from "react";
 import {StyleSheet} from "aphrodite";
 import {Link} from "react-router-dom";
-import * as PropTypes from "prop-types";
+import {__RouterContext} from "react-router";
 
 import Color, {mix, fade} from "@khanacademy/wonder-blocks-color";
 import Spacing from "@khanacademy/wonder-blocks-spacing";
@@ -38,6 +38,12 @@ type ActionProps = {|
      */
     href?: string,
 
+    /**
+     * Optional attribute to indicate to the Screen Reader which language the
+     * item text is in.
+     */
+    lang?: string,
+
     /**
      * A target destination window for a link to open in.
      */
@@ -103,10 +109,6 @@ type DefaultProps = {|
     role: $PropertyType<ActionProps, "role">,
 |};
 
-type ContextTypes = {|
-    router: $FlowFixMe,
-|};
-
 const StyledAnchor = addStyle("a");
 const StyledButton = addStyle("button");
 const StyledLink = addStyle(Link);
@@ -120,7 +122,6 @@ export default class ActionItem extends React.Component<ActionProps> {
     static isClassOf(instance: React.Element<any>): boolean {
         return instance && instance.type && instance.type.__IS_ACTION_ITEM__;
     }
-    static contextTypes: ContextTypes = {router: PropTypes.any};
     static defaultProps: DefaultProps = {
         disabled: false,
         indent: false,
@@ -128,7 +129,7 @@ export default class ActionItem extends React.Component<ActionProps> {
     };
     static __IS_ACTION_ITEM__: boolean = true;
 
-    render(): React.Node {
+    renderClickableBehavior(router: any): React.Node {
         const {
             skipClientNav,
             disabled,
@@ -136,12 +137,12 @@ export default class ActionItem extends React.Component<ActionProps> {
             target,
             indent,
             label,
+            lang,
             onClick,
             role,
             style,
             testId,
         } = this.props;
-        const {router} = this.context;
 
         const ClickableBehavior = getClickableBehavior(
             href,
@@ -182,6 +183,7 @@ export default class ActionItem extends React.Component<ActionProps> {
                     const children = (
                         <React.Fragment>
                             <LabelMedium
+                                lang={lang}
                                 style={[indent && styles.indent, styles.label]}
                             >
                                 {label}
@@ -220,6 +222,14 @@ export default class ActionItem extends React.Component<ActionProps> {
             </ClickableBehavior>
         );
     }
+
+    render(): React.Node {
+        return (
+            <__RouterContext.Consumer>
+                {(router) => this.renderClickableBehavior(router)}
+            </__RouterContext.Consumer>
+        );
+    }
 }
 
 const styles = StyleSheet.create({

package/src/components/action-menu-opener-core.js

@@ -1,7 +1,6 @@
 // @flow
 import * as React from "react";
 import {StyleSheet} from "aphrodite";
-import * as PropTypes from "prop-types";
 
 import {LabelLarge} from "@khanacademy/wonder-blocks-typography";
 import Color, {SemanticColor, mix} from "@khanacademy/wonder-blocks-color";
@@ -39,10 +38,6 @@ type Props = {|
     opened: boolean,
 |};
 
-type ContextTypes = {|
-    router: $FlowFixMe,
-|};
-
 const StyledButton = addStyle<"button">("button");
 
 /**
@@ -52,8 +47,6 @@ const StyledButton = addStyle<"button">("button");
  * - the down caret icon is smaller that the one that would be used by ButtonCore
  */
 export default class ActionMenuOpenerCore extends React.Component<Props> {
-    static contextTypes: ContextTypes = {router: PropTypes.any};
-
     render(): React.Node {
         const {
             children,

package/src/components/action-menu.stories.js

@@ -0,0 +1,48 @@
+// @flow
+import * as React from "react";
+
+import type {StoryComponentType} from "@storybook/react";
+import ActionMenu from "./action-menu.js";
+import ActionItem from "./action-item.js";
+
+export default {
+    title: "Dropdown / ActionMenu",
+    component: ActionMenu,
+};
+
+export const ActionMenuWithLang: StoryComponentType = () => (
+    <ActionMenu menuText="Locales">
+        {locales.map((locale) => (
+            <ActionItem
+                key={locale.locale}
+                label={locale.localName}
+                lang={locale.locale}
+                testId={"language_picker_" + locale.locale}
+            />
+        ))}
+    </ActionMenu>
+);
+
+ActionMenuWithLang.storyName = "Using the ActionMenu with the lang attribute";
+
+ActionMenuWithLang.parameters = {
+    docs: {
+        storyDescription:
+            "You can use the `lang` attribute to specify the language of the action item(s). This is useful if you want to avoid issues with Screen Readers trying to read the proper language for the rendered text.",
+    },
+    chromatic: {
+        disableSnapshot: true,
+    },
+};
+
+const locales = [
+    {id: "az", locale: "az", localName: "Azərbaycanca"},
+    {id: "id", locale: "id", localName: "Bahasa Indonesia"},
+    {id: "cs", locale: "cs", localName: "čeština"},
+    {id: "da", locale: "da", localName: "dansk"},
+    {id: "de", locale: "de", localName: "Deutsch"},
+    {id: "en", locale: "en", localName: "English"},
+    {id: "es", locale: "es", localName: "español"},
+    {id: "fr", locale: "fr", localName: "français"},
+    {id: "it", locale: "it", localName: "italiano"},
+];

package/src/components/checkbox.js

@@ -14,8 +14,7 @@ import type {IconAsset} from "@khanacademy/wonder-blocks-icon";
 // If the intended icon is a check without a checkbox, you should be using
 // icons.check from the Wonder Blocks Icon package.
 const checkboxCheck: IconAsset = {
-    small:
-        "M11.263 4.324a1 1 0 1 1 1.474 1.352l-5.5 6a1 1 0 0 1-1.505-.036l-2.5-3a1 1 0 1 1 1.536-1.28L6.536 9.48l4.727-5.157z",
+    small: "M11.263 4.324a1 1 0 1 1 1.474 1.352l-5.5 6a1 1 0 0 1-1.505-.036l-2.5-3a1 1 0 1 1 1.536-1.28L6.536 9.48l4.727-5.157z",
 };
 const {blue, white, offBlack16, offBlack32, offBlack50, offWhite} = Color;
 

package/src/components/dropdown-core.js

@@ -522,9 +522,8 @@ class DropdownCore extends React.Component<Props, State> {
         // appropriate item in handleKeyDown
         this.itemsClicked = true;
         this.focusedIndex = index;
-        this.focusedOriginalIndex = this.state.itemRefs[
-            this.focusedIndex
-        ].originalIndex;
+        this.focusedOriginalIndex =
+            this.state.itemRefs[this.focusedIndex].originalIndex;
     };
 
     handleDropdownMouseUp: (event: SyntheticMouseEvent<>) => void = (event) => {

package/src/components/multi-select.stories.js

@@ -79,20 +79,18 @@ class MultiSelectWithCustomStyles extends React.Component<Props, State> {
     }
 }
 
-export const customStyles: StoryComponentType = () => (
+export const CustomStyles: StoryComponentType = () => (
     <MultiSelectWithCustomStyles />
 );
 
-customStyles.story = {
-    parameters: {
-        chromatic: {
-            // we don't need screenshots because this story only tests behavior.
-            disable: true,
-        },
+CustomStyles.parameters = {
+    chromatic: {
+        // we don't need screenshots because this story only tests behavior.
+        disableSnapshot: true,
     },
 };
 
-export const customStylesOpened: StoryComponentType = () => (
+export const CustomStylesOpened: StoryComponentType = () => (
     <MultiSelectWithCustomStyles opened={true} />
 );
 

package/src/components/option-item.js

@@ -2,7 +2,6 @@
 
 import * as React from "react";
 import {StyleSheet} from "aphrodite";
-import * as PropTypes from "prop-types";
 
 import Color, {mix, fade} from "@khanacademy/wonder-blocks-color";
 import Spacing from "@khanacademy/wonder-blocks-spacing";
@@ -79,10 +78,6 @@ type OptionProps = {|
     style?: StyleType,
 |};
 
-type ContextTypes = {|
-    router: $FlowFixMe,
-|};
-
 type DefaultProps = {|
     disabled: $PropertyType<OptionProps, "disabled">,
     onToggle: $PropertyType<OptionProps, "onToggle">,
@@ -99,7 +94,6 @@ export default class OptionItem extends React.Component<OptionProps> {
     static isClassOf(instance: React.Element<any>): boolean {
         return instance && instance.type && instance.type.__IS_OPTION_ITEM__;
     }
-    static contextTypes: ContextTypes = {router: PropTypes.any};
     static defaultProps: DefaultProps = {
         disabled: false,
         onToggle: () => void 0,

package/src/components/select-opener.js

@@ -2,7 +2,7 @@
 
 import * as React from "react";
 import {StyleSheet} from "aphrodite";
-import * as PropTypes from "prop-types";
+import {__RouterContext} from "react-router";
 
 import type {AriaProps} from "@khanacademy/wonder-blocks-core";
 
@@ -16,15 +16,8 @@ import {DROPDOWN_ITEM_HEIGHT} from "../util/constants.js";
 
 const StyledButton = addStyle("button");
 
-const {
-    blue,
-    white,
-    white50,
-    offBlack,
-    offBlack16,
-    offBlack32,
-    offBlack64,
-} = Color;
+const {blue, white, white50, offBlack, offBlack16, offBlack32, offBlack64} =
+    Color;
 
 type SelectOpenerProps = {|
     ...AriaProps,
@@ -77,10 +70,6 @@ type SelectOpenerProps = {|
     open: boolean,
 |};
 
-type ContextTypes = {|
-    router: $FlowFixMe,
-|};
-
 type DefaultProps = {|
     disabled: $PropertyType<SelectOpenerProps, "disabled">,
     light: $PropertyType<SelectOpenerProps, "light">,
@@ -91,7 +80,6 @@ type DefaultProps = {|
  * An opener that opens select boxes.
  */
 export default class SelectOpener extends React.Component<SelectOpenerProps> {
-    static contextTypes: ContextTypes = {router: PropTypes.any};
     static defaultProps: DefaultProps = {
         disabled: false,
         light: false,
@@ -103,7 +91,7 @@ export default class SelectOpener extends React.Component<SelectOpenerProps> {
         this.props.onOpenChanged(!open);
     };
 
-    render(): React.Node {
+    renderClickableBehavior(router: any): React.Node {
         const {
             children,
             disabled,
@@ -117,7 +105,7 @@ export default class SelectOpener extends React.Component<SelectOpenerProps> {
             ...sharedProps
         } = this.props;
 
-        const ClickableBehavior = getClickableBehavior(this.context.router);
+        const ClickableBehavior = getClickableBehavior(router);
 
         return (
             <ClickableBehavior disabled={disabled} onClick={this.handleClick}>
@@ -173,6 +161,14 @@ export default class SelectOpener extends React.Component<SelectOpenerProps> {
             </ClickableBehavior>
         );
     }
+
+    render(): React.Node {
+        return (
+            <__RouterContext.Consumer>
+                {(router) => this.renderClickableBehavior(router)}
+            </__RouterContext.Consumer>
+        );
+    }
 }
 
 const buttonRadius = 4;

package/src/components/single-select.stories.js

@@ -106,12 +106,10 @@ const styles = StyleSheet.create({
 
 export const WithFilter: StoryComponentType = () => <SingleSelectWithFilter />;
 
-WithFilter.story = {
-    parameters: {
-        chromatic: {
-            // we don't need screenshots because this story only tests behavior.
-            disable: true,
-        },
+WithFilter.parameters = {
+    chromatic: {
+        // we don't need screenshots because this story only tests behavior.
+        disableSnapshot: true,
     },
 };
 
@@ -163,13 +161,12 @@ export const DropdownInModal: StoryComponentType = () => {
     );
 };
 
-DropdownInModal.story = {
-    name: "Dropdown in a modal",
-    parameters: {
-        chromatic: {
-            // We don't need screenshots because this story can be tested after
-            // the modal is opened.
-            disable: true,
-        },
+DropdownInModal.storyName = "Dropdown in a modal";
+
+DropdownInModal.parameters = {
+    chromatic: {
+        // We don't need screenshots because this story can be tested after
+        // the modal is opened.
+        disableSnapshot: true,
     },
 };

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2018 Khan Academy
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/src/components/__tests__/__snapshots__/action-item.test.js.snap

@@ -1,63 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`ActionItem should render with disabled styles 1`] = `
-<button
-  className=""
-  disabled={true}
-  onBlur={[Function]}
-  onClick={[Function]}
-  onDragStart={[Function]}
-  onFocus={[Function]}
-  onKeyDown={[Function]}
-  onKeyUp={[Function]}
-  onMouseDown={[Function]}
-  onMouseEnter={[Function]}
-  onMouseLeave={[Function]}
-  onMouseUp={[Function]}
-  onTouchCancel={[Function]}
-  onTouchEnd={[Function]}
-  onTouchStart={[Function]}
-  role="menuitem"
-  style={
-    Object {
-      "::MozFocusInner": Object {
-        "border": 0,
-      },
-      "alignItems": "center",
-      "background": "#ffffff",
-      "border": "none",
-      "color": "rgba(33,36,44,0.32)",
-      "cursor": "default",
-      "display": "flex",
-      "flexDirection": "row",
-      "height": 40,
-      "margin": 0,
-      "minHeight": 40,
-      "outline": "none",
-      "paddingLeft": 16,
-      "paddingRight": 16,
-      "textDecoration": "none",
-      "touchAction": "manipulation",
-    }
-  }
-  tabIndex={-1}
-  type="button"
->
-  <span
-    className=""
-    style={
-      Object {
-        "MozOsxFontSmoothing": "grayscale",
-        "WebkitFontSmoothing": "antialiased",
-        "display": "block",
-        "fontFamily": "Lato, \\"Noto Sans\\", sans-serif",
-        "fontSize": 16,
-        "fontWeight": 400,
-        "lineHeight": "20px",
-        "userSelect": "none",
-        "whiteSpace": "nowrap",
-      }
-    }
-  />
-</button>
-`;