@mitodl/smoot-design 1.0.0 → 1.0.1

package/dist/cjs/components/Button/ActionButton.stories.d.ts

@@ -0,0 +1,18 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { ActionButton } from "./Button";
+/**
+ * A button that should contain a remixicon icon and nothing else.
+ */
+declare const meta: Meta<typeof ActionButton>;
+export default meta;
+type Story = StoryObj<typeof ActionButton>;
+export declare const VariantsAndEdge: Story;
+export declare const Showcase: Story;
+/**
+ * `ActionButtonLink` is styled as a `ActionButton` that renders an anchor tag.
+ *
+ * To use a custom link component (E.g. `Link` from `react-router` or `next/link`),
+ * pass it as the `Component` prop. Alternatively, customize the project-wide
+ * default link adapter via [Theme's LinkAdapter](../?path=/docs/smoot-design-themeprovider--docs)
+ */
+export declare const Links: Story;

package/dist/cjs/components/Button/ActionButton.stories.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Links = exports.Showcase = exports.VariantsAndEdge = void 0;
+const React = require("react");
+const Button_1 = require("./Button");
+const Grid2_1 = require("@mui/material/Grid2");
+const Stack_1 = require("@mui/material/Stack");
+const react_1 = require("@remixicon/react");
+const test_1 = require("@storybook/test");
+const story_utils_1 = require("@/story-utils");
+const ICONS = {
+    None: undefined,
+    ArrowBackIcon: React.createElement(react_1.RiArrowLeftLine, null),
+    DeleteIcon: React.createElement(react_1.RiDeleteBinLine, null),
+    TestTubeIcon: React.createElement(react_1.RiTestTubeLine, null),
+};
+const VARIANTS = (0, story_utils_1.enumValues)({
+    primary: true,
+    secondary: true,
+    tertiary: true,
+    text: true,
+    unstable_noBorder: true,
+    unstable_inverted: true,
+    unstable_success: true,
+});
+const STABLE_VARIANTS = VARIANTS.filter((v) => !v.startsWith("unstable"));
+const SIZES = (0, story_utils_1.enumValues)({
+    small: true,
+    medium: true,
+    large: true,
+});
+const EDGES = (0, story_utils_1.enumValues)({
+    circular: true,
+    rounded: true,
+    none: true,
+});
+/**
+ * A button that should contain a remixicon icon and nothing else.
+ */
+const meta = {
+    title: "smoot-design/ActionButton",
+    component: Button_1.ActionButton,
+    argTypes: {
+        variant: {
+            options: VARIANTS,
+            control: { type: "select" },
+            table: {
+                type: { summary: (0, story_utils_1.docsEnum)(VARIANTS) },
+                defaultValue: { summary: Button_1.DEFAULT_PROPS.variant },
+            },
+        },
+        size: {
+            options: SIZES,
+            control: { type: "select" },
+            table: {
+                type: { summary: (0, story_utils_1.docsEnum)(SIZES) },
+                defaultValue: { summary: Button_1.DEFAULT_PROPS.size },
+            },
+        },
+        edge: {
+            options: EDGES,
+            control: { type: "select" },
+            table: {
+                type: { summary: (0, story_utils_1.docsEnum)(EDGES) },
+                defaultValue: { summary: Button_1.DEFAULT_PROPS.edge },
+            },
+        },
+    },
+    args: {
+        onClick: (0, test_1.fn)(),
+    },
+    tags: ["autodocs"],
+};
+exports.default = meta;
+exports.VariantsAndEdge = {
+    render: (args) => (React.createElement(React.Fragment, null,
+        React.createElement(Stack_1.default, { direction: "row", gap: 2, sx: { my: 2 } },
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "none", variant: "primary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "none", variant: "secondary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "none", variant: "tertiary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "none", variant: "text" }), ICONS.DeleteIcon)),
+        React.createElement(Stack_1.default, { direction: "row", gap: 2, sx: { my: 2 } },
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "rounded", variant: "primary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "rounded", variant: "secondary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "rounded", variant: "tertiary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "rounded", variant: "text" }), ICONS.DeleteIcon)),
+        React.createElement(Stack_1.default, { direction: "row", gap: 2, sx: { my: 2 } },
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "circular", variant: "primary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "circular", variant: "secondary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "circular", variant: "tertiary" }), ICONS.DeleteIcon),
+            React.createElement(Button_1.ActionButton, Object.assign({}, args, { edge: "circular", variant: "text" }), ICONS.DeleteIcon)))),
+    tags: ["main"],
+};
+exports.Showcase = {
+    render: (args) => (React.createElement(Grid2_1.default, { container: true, sx: { maxWidth: "750px" }, rowGap: 2 }, STABLE_VARIANTS.flatMap((variant) => EDGES.flatMap((edge) => (React.createElement(React.Fragment, { key: `${variant}-${edge}` },
+        React.createElement(Grid2_1.default, { size: { xs: 12, sm: 3 }, alignItems: "center" },
+            React.createElement("code", null,
+                "variant=",
+                variant,
+                React.createElement("br", null),
+                "edge=",
+                edge)),
+        SIZES.flatMap((size) => Object.entries(ICONS)
+            .filter(([_key, icon]) => icon)
+            .map(([iconKey, icon]) => (React.createElement(Grid2_1.default, { size: { xs: 4, sm: 1 }, key: `${size}-${iconKey}` },
+            React.createElement(Button_1.ActionButton, Object.assign({ variant: variant, edge: edge, size: size }, args), icon))))))))))),
+};
+/**
+ * `ActionButtonLink` is styled as a `ActionButton` that renders an anchor tag.
+ *
+ * To use a custom link component (E.g. `Link` from `react-router` or `next/link`),
+ * pass it as the `Component` prop. Alternatively, customize the project-wide
+ * default link adapter via [Theme's LinkAdapter](../?path=/docs/smoot-design-themeprovider--docs)
+ */
+exports.Links = {
+    render: () => (React.createElement(Stack_1.default, { direction: "row", gap: 2, sx: { my: 2 } },
+        React.createElement(Button_1.ActionButtonLink, { href: "#fake", variant: "primary" }, ICONS.DeleteIcon),
+        React.createElement(Button_1.ActionButtonLink, { href: "#fake", variant: "secondary" }, ICONS.DeleteIcon),
+        React.createElement(Button_1.ActionButtonLink, { href: "#fake", variant: "tertiary" }, ICONS.DeleteIcon),
+        React.createElement(Button_1.ActionButtonLink, { href: "#fake", variant: "text" }, ICONS.DeleteIcon))),
+};

package/dist/cjs/components/Button/Button.d.ts

@@ -0,0 +1,70 @@
+import * as React from "react";
+import { LinkAdapterPropsOverrides } from "../LinkAdapter/LinkAdapter";
+type ButtonVariant = "primary" | "secondary" | "tertiary" | "text" | "unstable_noBorder" | "unstable_inverted" | "unstable_success";
+type ButtonSize = "small" | "medium" | "large";
+type ButtonEdge = "circular" | "rounded" | "none";
+type ButtonStyleProps = {
+    variant?: ButtonVariant;
+    size?: ButtonSize;
+    edge?: ButtonEdge;
+    /**
+     * Display an icon before the button text.
+     */
+    startIcon?: React.ReactNode;
+    /**
+     * Display an icon after the button text.
+     */
+    endIcon?: React.ReactNode;
+    /**
+     * If true (default: `false`), the button will become one size smaller at the
+     * `sm` breakpoint.
+     *  - large -> medium
+     *  - medium -> small
+     *  - small -> small
+     */
+    responsive?: boolean;
+    color?: "secondary";
+};
+declare const DEFAULT_PROPS: Required<Omit<ButtonStyleProps, "startIcon" | "endIcon" | "color">>;
+type ButtonProps = ButtonStyleProps & React.ComponentProps<"button">;
+/**
+ * Our standard button component. See [Button Docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs).
+ *
+ * See also:
+ * - [ButtonLink](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs#links)
+ * - [ActionButton](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-actionbutton--docs) for icon-only uses
+ */
+declare const Button: React.ForwardRefExoticComponent<Omit<ButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement>>;
+type ButtonLinkProps = ButtonStyleProps & React.ComponentProps<"a"> & {
+    Component?: React.ElementType;
+} & LinkAdapterPropsOverrides;
+/**
+ * See [ButtonLink docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs#links)
+ */
+declare const ButtonLink: React.ForwardRefExoticComponent<Omit<ButtonLinkProps, "ref"> & React.RefAttributes<HTMLAnchorElement>>;
+type ActionButtonStyleProps = Omit<ButtonStyleProps, "startIcon" | "endIcon">;
+type ActionButtonProps = ActionButtonStyleProps & React.ComponentProps<"button">;
+/**
+ * A button that should contain a remixicon icon and nothing else.
+ * See [ActionButton docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-actionbutton--docs).
+ *
+ * See also:
+ * - [ActionButtonLink](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs#links)
+ * - [Button](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs) for text buttons
+ */
+declare const ActionButton: import("@emotion/styled").StyledComponent<Omit<ActionButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement> & {
+    theme?: import("@emotion/react").Theme;
+}, {}, {}>;
+type ActionButtonLinkProps = ActionButtonStyleProps & React.ComponentProps<"a"> & {
+    Component?: React.ElementType;
+} & LinkAdapterPropsOverrides;
+/**
+ * See [ActionButtonLink docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-actionbutton--docs#links)
+ */
+declare const ActionButtonLink: import("@emotion/styled").StyledComponent<Omit<ActionButtonProps, "ref"> & React.RefAttributes<HTMLButtonElement> & {
+    theme?: import("@emotion/react").Theme;
+} & ButtonStyleProps & React.ClassAttributes<HTMLAnchorElement> & React.AnchorHTMLAttributes<HTMLAnchorElement> & {
+    Component?: React.ElementType;
+} & LinkAdapterPropsOverrides, {}, {}>;
+export { Button, ButtonLink, ActionButton, ActionButtonLink, DEFAULT_PROPS };
+export type { ButtonProps, ButtonLinkProps, ActionButtonProps, ActionButtonLinkProps, };

package/dist/cjs/components/Button/Button.js

@@ -0,0 +1,311 @@
+"use strict";
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_PROPS = exports.ActionButtonLink = exports.ActionButton = exports.ButtonLink = exports.Button = void 0;
+const React = require("react");
+const styled_1 = require("@emotion/styled");
+const react_1 = require("@emotion/react");
+const typography_1 = require("../ThemeProvider/typography");
+const LinkAdapter_1 = require("../LinkAdapter/LinkAdapter");
+const styleProps = {
+    variant: true,
+    size: true,
+    edge: true,
+    startIcon: true,
+    endIcon: true,
+    responsive: true,
+    color: true,
+};
+const shouldForwardProp = (prop) => !styleProps[prop];
+const DEFAULT_PROPS = {
+    variant: "primary",
+    size: "medium",
+    edge: "rounded",
+    responsive: false,
+};
+exports.DEFAULT_PROPS = DEFAULT_PROPS;
+const BORDER_WIDTHS = {
+    small: 1,
+    medium: 1,
+    large: 2,
+};
+const RESPONSIVE_SIZES = {
+    small: "small",
+    medium: "small",
+    large: "medium",
+};
+const sizeStyles = (size, hasBorder, theme) => {
+    const paddingAdjust = hasBorder ? BORDER_WIDTHS[size] : 0;
+    return [
+        {
+            boxSizing: "border-box",
+            borderWidth: BORDER_WIDTHS[size],
+        },
+        size === "large" && Object.assign({ padding: `${14 - paddingAdjust}px 24px` }, theme.typography.buttonLarge),
+        size === "medium" && Object.assign({ padding: `${11 - paddingAdjust}px 16px` }, theme.typography.button),
+        size === "small" && Object.assign({ padding: `${8 - paddingAdjust}px 12px` }, theme.typography.buttonSmall),
+    ];
+};
+const buildStyles = (props) => {
+    const { size, variant, edge, theme, color, responsive } = Object.assign(Object.assign({}, DEFAULT_PROPS), props);
+    const { colors } = theme.custom;
+    const hasBorder = variant === "secondary";
+    return (0, react_1.css)([
+        {
+            color: theme.palette.text.primary,
+            textAlign: "center",
+            // display
+            display: "inline-flex",
+            justifyContent: "center",
+            alignItems: "center",
+            // transitions
+            transition: `background ${theme.transitions.duration.short}ms`,
+            // cursor
+            cursor: "pointer",
+            ":disabled": {
+                cursor: "default",
+            },
+            minWidth: "100px",
+        },
+        ...sizeStyles(size, hasBorder, theme),
+        // responsive
+        responsive && {
+            [theme.breakpoints.down("sm")]: sizeStyles(RESPONSIVE_SIZES[size], hasBorder, theme),
+        },
+        // variant
+        variant === "primary" && {
+            backgroundColor: colors.mitRed,
+            color: colors.white,
+            border: "none",
+            /* Shadow/04dp */
+            boxShadow: "0px 2px 4px 0px rgba(37, 38, 43, 0.10), 0px 3px 8px 0px rgba(37, 38, 43, 0.12)",
+            ":hover:not(:disabled)": {
+                backgroundColor: colors.red,
+                boxShadow: "none",
+            },
+            ":disabled": {
+                backgroundColor: colors.silverGray,
+                boxShadow: "none",
+            },
+        },
+        hasBorder && {
+            backgroundColor: "transparent",
+            borderColor: "currentcolor",
+            borderStyle: "solid",
+        },
+        variant === "unstable_success" && {
+            backgroundColor: colors.darkGreen,
+            color: colors.white,
+            border: "none",
+            /* Shadow/04dp */
+            boxShadow: "0px 2px 4px 0px rgba(37, 38, 43, 0.10), 0px 3px 8px 0px rgba(37, 38, 43, 0.12)",
+            ":hover:not(:disabled)": {
+                backgroundColor: colors.darkGreen,
+                boxShadow: "none",
+            },
+            ":disabled": {
+                backgroundColor: colors.silverGray,
+                boxShadow: "none",
+            },
+        },
+        hasBorder && {
+            backgroundColor: "transparent",
+            borderColor: "currentcolor",
+            borderStyle: "solid",
+        },
+        variant === "secondary" && {
+            color: colors.red,
+            ":hover:not(:disabled)": {
+                // brightRed at 0.06 alpha
+                backgroundColor: "rgba(255, 20, 35, 0.06)",
+            },
+            ":disabled": {
+                color: colors.silverGray,
+            },
+        },
+        variant === "text" && {
+            backgroundColor: "transparent",
+            borderStyle: "none",
+            color: colors.darkGray2,
+            ":hover:not(:disabled)": {
+                // darkGray1 at 6% alpha
+                backgroundColor: "rgba(64, 70, 76, 0.06)",
+            },
+            ":disabled": {
+                color: colors.silverGray,
+            },
+        },
+        variant === "unstable_noBorder" && {
+            backgroundColor: colors.white,
+            color: colors.darkGray2,
+            border: "none",
+            ":hover:not(:disabled)": {
+                // darkGray1 at 6% alpha
+                backgroundColor: "rgba(64, 70, 76, 0.06)",
+            },
+            ":disabled": {
+                color: colors.silverGray,
+            },
+        },
+        variant === "tertiary" && {
+            color: colors.darkGray2,
+            border: "none",
+            backgroundColor: colors.lightGray2,
+            ":hover:not(:disabled)": {
+                backgroundColor: colors.white,
+            },
+            ":disabled": {
+                backgroundColor: colors.lightGray2,
+                color: colors.silverGrayLight,
+            },
+        },
+        variant === "unstable_inverted" && {
+            backgroundColor: colors.white,
+            color: colors.mitRed,
+            borderColor: colors.mitRed,
+            borderStyle: "solid",
+        },
+        // edge
+        edge === "rounded" && {
+            borderRadius: "4px",
+        },
+        edge === "circular" && {
+            // Pill-shaped buttons... Overlapping border radius get clipped to pill.
+            borderRadius: "100vh",
+        },
+        // color
+        color === "secondary" && {
+            color: theme.custom.colors.silverGray,
+            borderColor: theme.custom.colors.silverGray,
+            ":hover:not(:disabled)": {
+                backgroundColor: theme.custom.colors.lightGray1,
+            },
+        },
+    ]);
+};
+const ButtonStyled = (0, styled_1.default)("button", { shouldForwardProp })(buildStyles);
+const LinkStyled = (0, styled_1.default)(LinkAdapter_1.LinkAdapter, {
+    shouldForwardProp,
+})(buildStyles);
+const IconContainer = styled_1.default.span(({ size, side }) => [
+    {
+        height: "1em",
+        display: "flex",
+        alignItems: "center",
+    },
+    side === "start" && {
+        /**
+         * The negative margin is to counteract the padding on the button itself.
+         * Without icons, the left space is 24/16/12 px.
+         * With icons, the left space is 20/12/8 px.
+         */
+        marginLeft: "-4px",
+        marginRight: "8px",
+    },
+    side === "end" && {
+        marginLeft: "8px",
+        marginRight: "-4px",
+    },
+    {
+        "& svg, & .MuiSvgIcon-root": {
+            width: "1em",
+            height: "1em",
+            fontSize: (0, typography_1.pxToRem)({
+                small: 16,
+                medium: 20,
+                large: 24,
+            }[size]),
+        },
+    },
+]);
+const ButtonInner = (props) => {
+    const { children, size = DEFAULT_PROPS.size } = props;
+    return (React.createElement(React.Fragment, null,
+        props.startIcon ? (React.createElement(IconContainer, { size: size, side: "start" }, props.startIcon)) : null,
+        children,
+        props.endIcon ? (React.createElement(IconContainer, { size: size, side: "end" }, props.endIcon)) : null));
+};
+/**
+ * Our standard button component. See [Button Docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs).
+ *
+ * See also:
+ * - [ButtonLink](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs#links)
+ * - [ActionButton](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-actionbutton--docs) for icon-only uses
+ */
+const Button = React.forwardRef((_a, ref) => {
+    var { children } = _a, props = __rest(_a, ["children"]);
+    return (React.createElement(ButtonStyled, Object.assign({ ref: ref, type: "button" }, props),
+        React.createElement(ButtonInner, Object.assign({}, props), children)));
+});
+exports.Button = Button;
+/**
+ * See [ButtonLink docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs#links)
+ */
+const ButtonLink = React.forwardRef((_a, ref) => {
+    var { children, Component } = _a, props = __rest(_a, ["children", "Component"]);
+    return (React.createElement(LinkStyled, Object.assign({ Component: Component, ref: ref }, props),
+        React.createElement(ButtonInner, Object.assign({}, props), children)));
+});
+exports.ButtonLink = ButtonLink;
+ButtonLink.displayName = "ButtonLink";
+const actionStyles = (size) => {
+    return {
+        minWidth: "auto",
+        padding: 0,
+        height: {
+            small: "32px",
+            medium: "40px",
+            large: "48px",
+        }[size],
+        width: {
+            small: "32px",
+            medium: "40px",
+            large: "48px",
+        }[size],
+        "& svg, & .MuiSvgIcon-root": {
+            width: "1em",
+            height: "1em",
+            fontSize: (0, typography_1.pxToRem)({
+                small: 20,
+                medium: 24,
+                large: 32,
+            }[size]),
+        },
+    };
+};
+/**
+ * A button that should contain a remixicon icon and nothing else.
+ * See [ActionButton docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-actionbutton--docs).
+ *
+ * See also:
+ * - [ActionButtonLink](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs#links)
+ * - [Button](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-button--docs) for text buttons
+ */
+const ActionButton = (0, styled_1.default)(React.forwardRef((props, ref) => (React.createElement(ButtonStyled, Object.assign({ ref: ref, type: "button" }, props)))))(({ size = DEFAULT_PROPS.size, responsive, theme }) => {
+    return [
+        actionStyles(size),
+        responsive && {
+            [theme.breakpoints.down("sm")]: actionStyles(RESPONSIVE_SIZES[size]),
+        },
+    ];
+});
+exports.ActionButton = ActionButton;
+/**
+ * See [ActionButtonLink docs](https://mitodl.github.io/smoot-design/?path=/docs/smoot-design-actionbutton--docs#links)
+ */
+const ActionButtonLink = ActionButton.withComponent((_a) => {
+    var { Component } = _a, props = __rest(_a, ["Component"]);
+    return React.createElement(LinkStyled, Object.assign({ Component: Component }, props));
+});
+exports.ActionButtonLink = ActionButtonLink;
+ActionButtonLink.displayName = "ActionButtonLink";

package/dist/cjs/components/Button/Button.stories.d.ts

@@ -0,0 +1,17 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import { Button } from "./Button";
+declare const meta: Meta<typeof Button>;
+export default meta;
+type Story = StoryObj<typeof Button>;
+export declare const VariantsAndEdge: Story;
+export declare const Sizes: Story;
+export declare const WithIcons: Story;
+/**
+ * `ButtonLink` is a styled `Button` that renders an anchor tag.
+ *
+ * To use a custom link component (E.g. `Link` from `react-router` or `next/link`),
+ * pass it as the `Component` prop. Alternatively, customize the project-wide
+ * default link adapter via [Theme's LinkAdapter](../?path=/docs/smoot-design-themeprovider--docs)
+ */
+export declare const Links: Story;
+export declare const Showcase: Story;