@nypl/design-system-react-components 0.25.7 → 0.25.10

package/dist/theme/components/toggle.d.ts

@@ -0,0 +1,71 @@
+declare const _default: {
+    Toggle: {
+        parts: string[];
+        baseStyle: {
+            label: {
+                display: string;
+                alignItems: string;
+                width: string;
+            };
+            helper: {
+                marginLeft: string;
+                marginTop: string;
+                marginBottom: string;
+            };
+        };
+        defaultProps: {
+            size: string;
+        };
+    };
+    Switch: {
+        baseStyle: {
+            opacity: number;
+            track: {
+                border: string;
+                borderColor: string;
+                p: string;
+                _checked: {
+                    bg: string;
+                    borderColor: string;
+                    opacity: number;
+                };
+                _invalid: {
+                    bg: string;
+                    borderColor: string;
+                    "> span": {
+                        bg: string;
+                    };
+                };
+                _disabled: {
+                    bg: string;
+                    borderColor: string;
+                    _checked: {
+                        opacity: number;
+                    };
+                };
+                _focus: {
+                    outline: string;
+                    outlineColor: string;
+                    outlineOffset: string;
+                    zIndex: string;
+                };
+            };
+            label: {
+                fontSize: string;
+                marginLeft: string;
+                _disabled: {
+                    fontStyle: string;
+                };
+            };
+            thumb: {
+                _disabled: {
+                    bg: string;
+                };
+            };
+        };
+        defaultProps: {
+            colorScheme: string;
+        };
+    };
+};
+export default _default;

package/dist/theme/foundations/spacing.d.ts

@@ -22,6 +22,7 @@
  *
  * Chakra Number Value | Chakra Name value | DS Variable
  * ------------------- | ----------------- | -----------------
+ *        0.5            |         xxxs       |   --nypl-space-xxxs
  *        1            |         xxs       |   --nypl-space-xxs
  *        2            |         xs        |   --nypl-space-xs
  *        4            |         s         |   --nypl-space-s
@@ -34,6 +35,7 @@
 export declare const spacing: {
     px: string;
     0: string;
+    xxxs: string;
     0.5: string;
     xxs: string;
     1: string;

package/dist/utils/utils.d.ts

@@ -10,3 +10,13 @@ export declare const range: (start: number, stop: number, step?: number) => numb
  * value, if provided, will be used.
  */
 export declare const getVariant: (variant: any, collection: any, fallback?: any) => any;
+/**
+ * Given an enum object and its name, this will return (1) an array `options`
+ * of all values with the enum name as the prefix, and (2) a function that
+ * returns the correct enum value given a string from the `options` array.
+ * @NOTE this is only used for Storybook documentation.
+ */
+export declare const getStorybookEnumValues: (enumObject: any, name: any) => {
+    options: string[];
+    getValue: (key: any) => any;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nypl/design-system-react-components",
-  "version": "0.25.7",
+  "version": "0.25.10",
   "description": "Design System React Components",
   "repository": {
     "type": "git",
@@ -28,7 +28,7 @@
     "test:watch": "tsdx test - --watch",
     "test:generate-output": "tsdx test --json --outputFile=.jest-test-results.json  || true",
     "lint": "tsdx lint",
-    "prepare": "npm run build",
+    "prepare": "npm run build && husky install",
     "size": "size-limit",
     "analyze": "size-limit --why",
     "generate-sass-resources": "gulp",
@@ -36,26 +36,9 @@
     "build-storybook": "npm run prebuild:storybook && build-storybook -c .storybook -o ./storybook-static",
     "prebuild:storybook": "npm run test:generate-output"
   },
-  "dependencies": {
-    "@chakra-ui/react": "1.7.1",
-    "@chakra-ui/system": "1.8.1",
-    "@emotion/react": "11.4.1",
-    "@emotion/styled": "11.3.0",
-    "framer-motion": "4.1.17",
-    "he": "1.2.0",
-    "react-datepicker": "4.1.1",
-    "system-font-css": "2.0.2",
-    "typescript": "4.3.5",
-    "uuid": "8.3.2"
-  },
-  "peerDependencies": {
-    "react": ">=16.13.0",
-    "react-dom": ">=16.13.0"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "pretty-quick --staged"
-    }
+  "lint-staged": {
+    "*.{jsx,ts,tsx}": "eslint src --ext=jsx,ts,tsx --cache --fix",
+    "*.{js,jsx,ts,tsx,css,md}": "prettier --write"
   },
   "prettier": {
     "printWidth": 80,
@@ -73,19 +56,40 @@
       "limit": "300 KB"
     }
   ],
+  "dependencies": {
+    "@chakra-ui/react": ">=1.7.1",
+    "@chakra-ui/system": ">=1.8.1",
+    "@emotion/react": "11.4.1",
+    "@emotion/styled": "11.3.0",
+    "framer-motion": "4.1.17",
+    "he": "1.2.0",
+    "react-datepicker": "4.1.1",
+    "system-font-css": "2.0.2",
+    "typescript": "4.3.5",
+    "uuid": "8.3.2"
+  },
+  "peerDependencies": {
+    "@chakra-ui/react": ">=1.7.1",
+    "@chakra-ui/system": ">=1.8.1",
+    "@emotion/react": ">=11.4.1",
+    "@emotion/styled": ">=11.3.0",
+    "framer-motion": ">=4.1.17",
+    "react": ">=16.13.0",
+    "react-dom": ">=16.13.0"
+  },
   "devDependencies": {
     "@babel/core": "7.14.6",
     "@mdx-js/react": "1.6.22",
     "@size-limit/preset-small-lib": "5.0.1",
-    "@storybook/addon-a11y": "6.4.8",
-    "@storybook/addon-actions": "6.4.8",
-    "@storybook/addon-docs": "6.4.8",
-    "@storybook/addon-essentials": "6.4.8",
-    "@storybook/addon-jest": "6.4.8",
-    "@storybook/addon-links": "6.4.8",
+    "@storybook/addon-a11y": "6.4.19",
+    "@storybook/addon-actions": "6.4.19",
+    "@storybook/addon-docs": "6.4.19",
+    "@storybook/addon-essentials": "6.4.19",
+    "@storybook/addon-jest": "6.4.19",
+    "@storybook/addon-links": "6.4.19",
     "@storybook/addon-queryparams": "6.2.9",
-    "@storybook/addons": "6.4.8",
-    "@storybook/react": "6.4.8",
+    "@storybook/addons": "6.4.19",
+    "@storybook/react": "6.4.19",
     "@svgr/rollup": "5.5.0",
     "@svgr/webpack": "5.5.0",
     "@testing-library/jest-dom": "5.14.1",
@@ -100,7 +104,7 @@
     "@types/testing-library__jest-dom": "5.14.1",
     "@typescript-eslint/eslint-plugin": "4.33.0",
     "@typescript-eslint/parser": "4.33.0",
-    "autoprefixer": "9.8.6",
+    "autoprefixer": "9.8.8",
     "babel-loader": "8.2.2",
     "breakpoint-sass": "2.7.1",
     "css-loader": "5.2.7",
@@ -109,19 +113,18 @@
     "eslint-config-react-app": "6.0.0",
     "eslint-plugin-flowtype": "5.8.2",
     "eslint-plugin-react-hooks": "4.2.0",
+    "eslint-plugin-storybook": "^0.5.6",
     "gulp": "4.0.2",
-    "gulp-scss-combine": "1.0.0",
-    "husky": "4.2.5",
+    "gulp-concat": "^2.6.1",
+    "husky": "^7.0.4",
     "import-glob-loader": "1.1.0",
     "jest": "27.3.1",
     "jest-axe": "5.0.1",
     "jsdom": "15.2.1",
-    "node-sass": "4.14.1",
+    "lint-staged": "10.5.4",
     "node-sass-glob-importer": "5.3.2",
     "normalize.css": "8.0.1",
-    "postcss": "8.3.6",
     "prettier": "2.4.1",
-    "pretty-quick": "3.1.1",
     "react": "16.14.0",
     "react-autosuggest": "10.0.2",
     "react-docgen-typescript-loader": "3.1.0",
@@ -134,7 +137,7 @@
     "sass-loader": "10.0.0",
     "semantic-release-slack-bot": "2.1.0",
     "size-limit": "5.0.1",
-    "storybook-addon-designs": "6.2.0",
+    "storybook-addon-designs": "6.2.1",
     "style-loader": "2.0.0",
     "ts-jest": "27.0.4",
     "tsdx": "0.14.1",

package/src/__tests__/utils/utils.test.ts

@@ -1,4 +1,5 @@
-import { range } from "../../utils/utils";
+import { getStorybookEnumValues, range } from "../../utils/utils";
+import { ButtonTypes } from "../../components/Button/ButtonTypes";
 
 describe("range", () => {
   it("returns an array of values not including the stop argument", () => {
@@ -16,3 +17,24 @@ describe("range", () => {
     expect(range(2, 20, 5)).toEqual([2, 7, 12, 17]);
   });
 });
+
+describe("getStorybookEnumValues", () => {
+  const enumValues = getStorybookEnumValues(ButtonTypes, "ButtonTypes");
+
+  it("returns an array of values from the enum passed", () => {
+    expect(enumValues.options).toEqual([
+      "ButtonTypes.Primary",
+      "ButtonTypes.Secondary",
+      "ButtonTypes.Callout",
+      "ButtonTypes.Pill",
+      "ButtonTypes.Link",
+      "ButtonTypes.NoBrand",
+    ]);
+  });
+
+  it("returns a function with the value of the argument passed", () => {
+    expect(enumValues.getValue("ButtonTypes.Primary")).toEqual("primary");
+    expect(enumValues.getValue("ButtonTypes.Callout")).toEqual("callout");
+    expect(enumValues.getValue("ButtonTypes.NoBrand")).toEqual("noBrand");
+  });
+});

package/src/components/Accordion/Accordion.stories.mdx

@@ -1,18 +1,18 @@
 import {
-  Meta,
-  Story,
   ArgsTable,
   Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
-import Accordion from "./Accordion";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
+import ReactDOMServer from "react-dom/server";
 import { withDesign } from "storybook-addon-designs";
+
+import Accordion from "./Accordion";
 import Card, { CardHeading, CardContent } from "../Card/Card";
 import { CardLayouts } from "../Card/CardTypes";
-import { ImageRatios } from "../Image/ImageTypes";
 import { HeadingLevels } from "../Heading/HeadingTypes";
-import { Source } from "@storybook/addon-docs/blocks";
-import ReactDOMServer from "react-dom/server";
+import { ImageRatios } from "../Image/ImageTypes";
 import { getCategory } from "../../utils/componentCategories";
 
 <Meta
@@ -22,14 +22,14 @@ import { getCategory } from "../../utils/componentCategories";
   parameters={{
     design: {
       type: "figma",
-      url:
-        "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=10734%3A2520",
+      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=10734%3A2520",
     },
     jest: ["Accordion.test.tsx"],
   }}
   argTypes={{
-    contentData: { table: { disable: true } },
-    id: { table: { disable: true } },
+    contentData: { control: false },
+    id: { control: false },
+    isDefaultOpen: { table: { defaultValue: { summary: false } } },
   }}
 />
 
@@ -38,7 +38,7 @@ import { getCategory } from "../../utils/componentCategories";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.1.0`    |
-| Latest            | `0.25.1`   |
+| Latest            | `0.25.10`  |
 
 <Description of={Accordion} />
 
@@ -57,9 +57,8 @@ necessary icon, Chakra components, and styles.
 
 <Canvas withToolbar>
   <Story
-    name="Basic"
+    name="Accordion with Controls"
     args={{
-      isDefaultOpen: false,
       contentData: [
         {
           label: "Tom Nook",
@@ -83,6 +82,8 @@ necessary icon, Chakra components, and styles.
           ),
         },
       ],
+      id: "accordion-id",
+      isDefaultOpen: false,
     }}
   >
     {(args) => <Accordion {...args} />}
@@ -119,7 +120,7 @@ const contentData = [
 <Accordion contentData={contentData} />
 ```
 
-<ArgsTable story="Basic" />
+<ArgsTable story="Accordion with Controls" />
 
 ## FAQ example
 

package/src/components/Accordion/Accordion.test.tsx

@@ -1,9 +1,14 @@
 import * as React from "react";
-import { render, screen } from "@testing-library/react";
 import { axe } from "jest-axe";
+import { render, screen } from "@testing-library/react";
+import renderer from "react-test-renderer";
 import userEvent from "@testing-library/user-event";
 
 import Accordion from "./Accordion";
+import Card, { CardContent, CardHeading } from "../Card/Card";
+import { CardLayouts } from "../Card/CardTypes";
+import { HeadingLevels } from "../Heading/HeadingTypes";
+import { ImageRatios } from "../Image/ImageTypes";
 
 describe("Accordion Accessibility", () => {
   it("passes axe accessibility test for one item", async () => {
@@ -150,4 +155,43 @@ describe("Accordion", () => {
     expect(accordion2).toHaveAttribute("aria-expanded", "true");
     expect(accordion3).toHaveAttribute("aria-expanded", "true");
   });
+
+  it("Renders the UI snapshot correctly", () => {
+    const contentData = [
+      {
+        label: "Gerry Kellman",
+        panel: (
+          <Card
+            center
+            id="card"
+            imageAlt="Alt text"
+            imageAspectRatio={ImageRatios.TwoByOne}
+            imageSrc={`https://cdn.onebauer.media/one/media/6176/76fd/405b/ab5f/f20f/2d52/gerri-1500-1.jpg?format=jpg&quality=80&width=850&ratio=1-1&resize=aspectfit`}
+            layout={CardLayouts.Row}
+          >
+            <CardHeading id="heading1" level={HeadingLevels.Four}>
+              Gerry Kellman
+            </CardHeading>
+            <CardContent>
+              Gerri is <b>one of Logan's most trusted confidantes</b>, one who
+              serves many roles within the company. She's one of the most
+              powerful people at Waystar Royco outside of the family itself.
+            </CardContent>
+          </Card>
+        ),
+      },
+    ];
+
+    const primary = renderer
+      .create(<Accordion contentData={contentData} id="accordian" />)
+      .toJSON();
+    const defaultOpen = renderer
+      .create(
+        <Accordion contentData={contentData} id="accordian" isDefaultOpen />
+      )
+      .toJSON();
+
+    expect(primary).toMatchSnapshot();
+    expect(defaultOpen).toMatchSnapshot();
+  });
 });

package/src/components/Accordion/Accordion.tsx

@@ -29,9 +29,15 @@ export interface AccordionProps {
  * Get the minus or plus icon depending on whether the accordion
  * is open or closed.
  */
-const getIcon = (isExpanded = false) => {
+const getIcon = (isExpanded = false, index, id) => {
   const iconName = isExpanded ? IconNames.Minus : IconNames.Plus;
-  return <Icon name={iconName} size={IconSizes.Small} />;
+  return (
+    <Icon
+      id={`accordion-${id}-icon-${index}`}
+      name={iconName}
+      size={IconSizes.Small}
+    />
+  );
 };
 
 /**
@@ -39,7 +45,7 @@ const getIcon = (isExpanded = false) => {
  * array. This automatically creates the `AccordionButton` and `AccordionPanel`
  * combination that is required for the Chakra `Accordion` component.
  */
-const getElementsFromContentData = (data = []) => {
+const getElementsFromContentData = (data = [], id) => {
   // For FAQ-style multiple accordions, the button should be bigger.
   // Otherwise, use the default.
   const multiplePadding = data?.length > 1 ? 4 : null;
@@ -49,23 +55,29 @@ const getElementsFromContentData = (data = []) => {
     const panel =
       typeof content.panel === "string" ? (
         <AccordionPanel
+          id={`${id}-panel-${index}`}
           key={index}
           dangerouslySetInnerHTML={{ __html: content.panel }}
         />
       ) : (
-        <AccordionPanel key={index}>{content.panel}</AccordionPanel>
+        <AccordionPanel id={`${id}-panel-${index}`} key={index}>
+          {content.panel}
+        </AccordionPanel>
       );
 
     return (
-      <AccordionItem key={index}>
+      <AccordionItem id={`${id}-item-${index}`} key={index}>
         {/* Get the current state to render the correct icon. */}
         {({ isExpanded }) => (
           <>
-            <AccordionButton padding={multiplePadding}>
+            <AccordionButton
+              id={`${id}-button-${index}`}
+              padding={multiplePadding}
+            >
               <Box flex="1" textAlign="left">
                 {content.label}
               </Box>
-              {getIcon(isExpanded)}
+              {getIcon(isExpanded, index, id)}
             </AccordionButton>
             {panel}
           </>
@@ -86,7 +98,7 @@ function Accordion(props: React.PropsWithChildren<AccordionProps>) {
   const openFirstAccordion = isDefaultOpen ? 0 : undefined;
   return (
     <ChakraAccordion id={id} defaultIndex={[openFirstAccordion]} allowMultiple>
-      {getElementsFromContentData(contentData)}
+      {getElementsFromContentData(contentData, id)}
     </ChakraAccordion>
   );
 }