@khanacademy/wonder-blocks-button 6.0.0 → 6.1.0

package/src/components/__tests__/button-with-icon.test.tsx

@@ -0,0 +1,274 @@
+/**
+ * Tests for Wonder Blocks Button with icons.
+ * The rest of the button tests can be found in button.test.tsx.
+ */
+
+import * as React from "react";
+import {render, screen} from "@testing-library/react";
+import userEvent from "@testing-library/user-event";
+import plus from "@phosphor-icons/core/regular/plus.svg";
+
+import {ThemeSwitcherContext, tokens} from "@khanacademy/wonder-blocks-theming";
+
+import Button from "../button";
+
+describe("button with icon", () => {
+    test("start icon should be hidden from Screen Readers", () => {
+        // Arrange
+        render(
+            <Button testId={"button-focus-test"} startIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-focus-test-start-icon");
+
+        // Assert
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("end icon should be hidden from Screen Readers", () => {
+        // Arrange
+        render(
+            <Button testId={"button-focus-test"} endIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-focus-test-end-icon");
+
+        // Assert
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    /**
+     * Primary button
+     */
+
+    test("icon is displayed when button contains startIcon", () => {
+        // Arrange
+        render(
+            <Button testId={"button-focus-test"} startIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-focus-test-start-icon");
+
+        // Assert
+        expect(icon).toBeInTheDocument();
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("icon is displayed when button contains endIcon", () => {
+        // Arrange
+        render(
+            <Button testId={"button-focus-test"} endIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-focus-test-end-icon");
+
+        // Assert
+        expect(icon).toBeInTheDocument();
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("both icons are displayed when button contains startIcon and endIcon", () => {
+        // Arrange
+        render(
+            <Button
+                testId={"button-focus-test"}
+                startIcon={plus}
+                endIcon={plus}
+            >
+                Label
+            </Button>,
+        );
+
+        // Act
+        const startIcon = screen.getByTestId("button-focus-test-start-icon");
+        const endIcon = screen.getByTestId("button-focus-test-end-icon");
+
+        // Assert
+        expect(startIcon).toBeInTheDocument();
+        expect(endIcon).toBeInTheDocument();
+    });
+
+    /**
+     * Secondary button
+     */
+
+    test("icon is displayed when secondary button contains startIcon", () => {
+        // Arrange
+        render(
+            <Button
+                kind="secondary"
+                testId={"button-icon-test"}
+                startIcon={plus}
+            >
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-icon-test-start-icon");
+
+        // Assert
+        expect(icon).toBeInTheDocument();
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("icon is displayed when secondary button contains endIcon", () => {
+        // Arrange
+        render(
+            <Button kind="secondary" testId={"button-icon-test"} endIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-icon-test-end-icon");
+
+        // Assert
+        expect(icon).toBeInTheDocument();
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("default theme secondary button icon has no hover style", () => {
+        // Arrange
+        render(
+            <Button kind="secondary" testId={"button-icon-test"} endIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const button = screen.getByTestId("button-icon-test");
+        const iconWrapper = screen.getByTestId(
+            "button-icon-test-end-icon-wrapper",
+        );
+        userEvent.hover(button);
+
+        // Assert
+        expect(iconWrapper).toHaveStyle(`backgroundColor: transparent`);
+    });
+
+    test("Khanmigo secondary button icon has hover style", () => {
+        // Arrange
+        render(
+            <ThemeSwitcherContext.Provider value="khanmigo">
+                <Button
+                    kind="secondary"
+                    testId={"button-icon-test"}
+                    endIcon={plus}
+                >
+                    Label
+                </Button>
+            </ThemeSwitcherContext.Provider>,
+        );
+
+        // Act
+        const button = screen.getByTestId("button-icon-test");
+        const iconWrapper = screen.getByTestId(
+            "button-icon-test-end-icon-wrapper",
+        );
+        userEvent.hover(button);
+
+        // Assert
+        expect(iconWrapper).toHaveStyle(
+            `backgroundColor: ${tokens.color.fadedBlue16}`,
+        );
+    });
+
+    /**
+     * Tertiary button
+     */
+
+    test("icon is displayed when tertiary button contains startIcon", () => {
+        // Arrange
+        render(
+            <Button
+                kind="tertiary"
+                testId={"button-focus-test"}
+                startIcon={plus}
+            >
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-focus-test-start-icon");
+
+        // Assert
+        expect(icon).toBeInTheDocument();
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("icon is displayed when tertiary button contains endIcon", () => {
+        // Arrange
+        render(
+            <Button kind="tertiary" testId={"button-focus-test"} endIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const icon = screen.getByTestId("button-focus-test-end-icon");
+
+        // Assert
+        expect(icon).toBeInTheDocument();
+        expect(icon).toHaveAttribute("aria-hidden", "true");
+    });
+
+    test("default theme tertiary button icon has no hover style", () => {
+        // Arrange
+        render(
+            <Button kind="tertiary" testId={"button-icon-test"} endIcon={plus}>
+                Label
+            </Button>,
+        );
+
+        // Act
+        const button = screen.getByTestId("button-icon-test");
+        const iconWrapper = screen.getByTestId(
+            "button-icon-test-end-icon-wrapper",
+        );
+        userEvent.hover(button);
+
+        // Assert
+        expect(iconWrapper).toHaveStyle(`backgroundColor: transparent`);
+    });
+
+    test("Khanmigo tertiary button icon has hover style", () => {
+        // Arrange
+        render(
+            <ThemeSwitcherContext.Provider value="khanmigo">
+                <Button
+                    kind="tertiary"
+                    testId={"button-icon-test"}
+                    endIcon={plus}
+                >
+                    Label
+                </Button>
+            </ThemeSwitcherContext.Provider>,
+        );
+
+        // Act
+        const button = screen.getByTestId("button-icon-test");
+        const iconWrapper = screen.getByTestId(
+            "button-icon-test-end-icon-wrapper",
+        );
+        userEvent.hover(button);
+
+        // Assert
+        expect(iconWrapper).toHaveStyle(
+            `backgroundColor: ${tokens.color.fadedBlue16}`,
+        );
+    });
+});

package/src/components/__tests__/button.test.tsx

@@ -1,8 +1,13 @@
+/**
+ * Test for Wonder Blocks Button component.
+ *
+ * The test for buttons with icons are in a separate file
+ * (button-with-icon.test.tsx) since this one is already too long.
+ */
 import * as React from "react";
 import {MemoryRouter, Route, Switch} from "react-router-dom";
 import {render, screen, waitFor} from "@testing-library/react";
 import userEvent from "@testing-library/user-event";
-import plus from "@phosphor-icons/core/regular/plus.svg";
 
 import Button from "../button";
 
@@ -828,91 +833,4 @@ describe("Button", () => {
             }).not.toThrow();
         });
     });
-
-    describe("button with icon", () => {
-        test("icon is displayed when button contains startIcon", () => {
-            // Arrange
-            render(
-                <Button testId={"button-focus-test"} startIcon={plus}>
-                    Label
-                </Button>,
-            );
-
-            // Act
-            const icon = screen.getByTestId("button-focus-test-start-icon");
-
-            // Assert
-            expect(icon).toBeInTheDocument();
-            expect(icon).toHaveAttribute("aria-hidden", "true");
-        });
-
-        test("icon is displayed when button contains endIcon", () => {
-            // Arrange
-            render(
-                <Button testId={"button-focus-test"} endIcon={plus}>
-                    Label
-                </Button>,
-            );
-
-            // Act
-            const icon = screen.getByTestId("button-focus-test-end-icon");
-
-            // Assert
-            expect(icon).toBeInTheDocument();
-            expect(icon).toHaveAttribute("aria-hidden", "true");
-        });
-
-        test("both icons are displayed when button contains startIcon and endIcon", () => {
-            // Arrange
-            render(
-                <Button
-                    testId={"button-focus-test"}
-                    startIcon={plus}
-                    endIcon={plus}
-                >
-                    Label
-                </Button>,
-            );
-
-            // Act
-            const startIcon = screen.getByTestId(
-                "button-focus-test-start-icon",
-            );
-            const endIcon = screen.getByTestId("button-focus-test-end-icon");
-
-            // Assert
-            expect(startIcon).toBeInTheDocument();
-            expect(endIcon).toBeInTheDocument();
-        });
-
-        test("start icon should be hidden from Screen Readers", () => {
-            // Arrange
-            render(
-                <Button testId={"button-focus-test"} startIcon={plus}>
-                    Label
-                </Button>,
-            );
-
-            // Act
-            const icon = screen.getByTestId("button-focus-test-start-icon");
-
-            // Assert
-            expect(icon).toHaveAttribute("aria-hidden", "true");
-        });
-
-        test("end icon should be hidden from Screen Readers", () => {
-            // Arrange
-            render(
-                <Button testId={"button-focus-test"} endIcon={plus}>
-                    Label
-                </Button>,
-            );
-
-            // Act
-            const icon = screen.getByTestId("button-focus-test-end-icon");
-
-            // Assert
-            expect(icon).toHaveAttribute("aria-hidden", "true");
-        });
-    });
 });

package/src/components/button-core.tsx

@@ -4,7 +4,7 @@ import {Link} from "react-router-dom";
 import {__RouterContext} from "react-router";
 
 import {LabelLarge, LabelSmall} from "@khanacademy/wonder-blocks-typography";
-import {addStyle} from "@khanacademy/wonder-blocks-core";
+import {addStyle, View} from "@khanacademy/wonder-blocks-core";
 import {CircularSpinner} from "@khanacademy/wonder-blocks-progress-spinner";
 import {isClientSideUrl} from "@khanacademy/wonder-blocks-clickable";
 import {
@@ -138,12 +138,24 @@ const ButtonCore: React.ForwardRefExoticComponent<
         const contents = (
             <React.Fragment>
                 {startIcon && (
-                    <ButtonIcon
-                        size={iconSize}
-                        icon={startIcon}
-                        style={sharedStyles.startIcon}
-                        testId={testId ? `${testId}-start-icon` : undefined}
-                    />
+                    <View
+                        // The start icon doesn't have the circle around it
+                        // in the Khanmigo theme, but we wrap it with
+                        // iconWrapper anyway to give it the same spacing
+                        // as the end icon so the button is symmetrical.
+                        style={sharedStyles.iconWrapper}
+                    >
+                        <ButtonIcon
+                            size={iconSize}
+                            icon={startIcon}
+                            style={[
+                                sharedStyles.startIcon,
+                                kind === "tertiary" &&
+                                    sharedStyles.tertiaryStartIcon,
+                            ]}
+                            testId={testId ? `${testId}-start-icon` : undefined}
+                        />
+                    </View>
                 )}
                 {label}
                 {spinner && (
@@ -155,12 +167,27 @@ const ButtonCore: React.ForwardRefExoticComponent<
                     />
                 )}
                 {endIcon && (
-                    <ButtonIcon
-                        size={iconSize}
-                        icon={endIcon}
-                        style={sharedStyles.endIcon}
-                        testId={testId ? `${testId}-end-icon` : undefined}
-                    />
+                    <View
+                        testId={
+                            testId ? `${testId}-end-icon-wrapper` : undefined
+                        }
+                        style={[
+                            styles.endIcon,
+                            sharedStyles.iconWrapper,
+                            sharedStyles.endIconWrapper,
+                            kind === "tertiary" &&
+                                sharedStyles.endIconWrapperTertiary,
+                            (focused || hovered) &&
+                                kind !== "primary" &&
+                                sharedStyles.iconWrapperSecondaryHovered,
+                        ]}
+                    >
+                        <ButtonIcon
+                            size={iconSize}
+                            icon={endIcon}
+                            testId={testId ? `${testId}-end-icon` : undefined}
+                        />
+                    </View>
                 )}
             </React.Fragment>
         );
@@ -232,10 +259,6 @@ const themedSharedStyles: ThemedStylesFn<ButtonThemeContract> = (theme) => ({
             WebkitTapHighlightColor: "rgba(0,0,0,0)",
         },
     },
-    withIcon: {
-        // The left padding for the button with icon should have 4px less padding
-        paddingLeft: theme.padding.medium,
-    },
     disabled: {
         cursor: "auto",
     },
@@ -258,7 +281,7 @@ const themedSharedStyles: ThemedStylesFn<ButtonThemeContract> = (theme) => ({
     },
     largeText: {
         fontSize: theme.font.size.large,
-        lineHeight: theme.font.lineHeight.large,
+        lineHeight: `${theme.font.lineHeight.large}px`,
     },
     textWithFocus: {
         position: "relative", // allows the tertiary button border to use the label width
@@ -270,16 +293,42 @@ const themedSharedStyles: ThemedStylesFn<ButtonThemeContract> = (theme) => ({
         position: "absolute",
     },
     startIcon: {
-        marginInlineEnd: theme.padding.small,
+        marginRight: theme.padding.small,
+        marginLeft: theme.margin.icon.offset,
+    },
+    tertiaryStartIcon: {
+        // Undo the negative padding from startIcon since tertiary
+        // buttons don't have extra padding.
+        marginLeft: 0,
     },
     endIcon: {
-        marginInlineStart: theme.padding.small,
+        marginLeft: theme.padding.small,
+    },
+    iconWrapper: {
+        borderRadius: theme.border.radius.icon,
+        padding: theme.padding.xsmall,
+        // View has a default minWidth of 0, which causes the label text
+        // to encroach on the icon when it needs to truncate. We can fix
+        // this by setting the minWidth to auto.
+        minWidth: "auto",
+    },
+    iconWrapperSecondaryHovered: {
+        backgroundColor: theme.color.bg.icon.secondaryHover,
+        color: theme.color.text.icon.secondaryHover,
+    },
+    endIconWrapper: {
+        marginLeft: theme.padding.small,
+        marginRight: theme.margin.icon.offset,
+    },
+    endIconWrapperTertiary: {
+        marginRight: 0,
     },
 });
 
 const styles: Record<string, any> = {};
 
-const _generateStyles = (
+// export for testing only
+export const _generateStyles = (
     buttonColor = "default",
     kind: "primary" | "secondary" | "tertiary",
     light: boolean,

package/src/themes/default.ts

@@ -42,6 +42,13 @@ const theme = {
             tertiary: {
                 hover: tokens.color.white,
             },
+
+            /**
+             * Icons
+             */
+            icon: {
+                secondaryHover: "transparent",
+            },
         },
         text: {
             /**
@@ -51,6 +58,7 @@ const theme = {
             disabled: tokens.color.offBlack32,
             // kind="primary", light=false | kind="secondary, tertiary", light=true
             inverse: tokens.color.white,
+
             /**
              * Kind
              */
@@ -60,6 +68,13 @@ const theme = {
             secondary: {
                 inverse: tokens.color.white50,
             },
+
+            /**
+             * Icons
+             */
+            icon: {
+                secondaryHover: tokens.color.blue,
+            },
         },
         border: {
             /**
@@ -101,6 +116,11 @@ const theme = {
             small: tokens.border.radius.medium_4,
             // large button
             large: tokens.border.radius.large_6,
+
+            /**
+             * Icons
+             */
+            icon: tokens.border.radius.full,
         },
     },
     size: {
@@ -112,8 +132,14 @@ const theme = {
             large: 56,
         },
     },
+    margin: {
+        icon: {
+            offset: -tokens.spacing.xxxxSmall_2,
+        },
+    },
     padding: {
-        small: tokens.spacing.xSmall_8,
+        xsmall: tokens.spacing.xxxxSmall_2,
+        small: tokens.spacing.xxSmall_6,
         medium: tokens.spacing.small_12,
         large: tokens.spacing.medium_16,
         xLarge: tokens.spacing.xLarge_32,

package/src/themes/khanmigo.ts

@@ -15,6 +15,9 @@ const theme = mergeTheme(defaultTheme, {
                 },
                 focus: tokens.color.offWhite,
             },
+            icon: {
+                secondaryHover: tokens.color.fadedBlue16,
+            },
         },
         border: {
             secondary: {
@@ -22,6 +25,11 @@ const theme = mergeTheme(defaultTheme, {
                 critical: tokens.color.fadedRed,
             },
         },
+        text: {
+            icon: {
+                secondaryHover: tokens.color.blue,
+            },
+        },
     },
     border: {
         radius: {
@@ -33,6 +41,12 @@ const theme = mergeTheme(defaultTheme, {
             focused: tokens.border.width.hairline,
         },
     },
+    margin: {
+        icon: {
+            // Bring the icons closer to the edges of the button.
+            offset: -tokens.spacing.xSmall_8,
+        },
+    },
     font: {
         weight: {
             default: tokens.font.weight.regular,

package/src/themes/themed-button.tsx

@@ -1,6 +1,7 @@
 import * as React from "react";
 import {
     createThemeContext,
+    Themes,
     ThemeSwitcherContext,
 } from "@khanacademy/wonder-blocks-theming";
 
@@ -11,16 +12,16 @@ type Props = {
     children: React.ReactNode;
 };
 
+export type ButtonThemeContract = typeof defaultTheme;
+
 /**
  * The themes available to the Button component.
  */
-const themes = {
+const themes: Themes<ButtonThemeContract> = {
     default: defaultTheme,
     khanmigo: khanmigoTheme,
 };
 
-export type ButtonThemeContract = typeof defaultTheme;
-
 /**
  * The context that provides the theme to the Button component.
  * This is generally consumed via the `useScopedTheme` hook.
@@ -33,7 +34,7 @@ export const ButtonThemeContext = createThemeContext(defaultTheme);
 export default function ThemedButton(props: Props) {
     const currentTheme = React.useContext(ThemeSwitcherContext);
 
-    const theme = themes[currentTheme as keyof typeof themes] || defaultTheme;
+    const theme = themes[currentTheme] || defaultTheme;
     return (
         <ButtonThemeContext.Provider value={theme}>
             {props.children}