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

package/src/components/Logo/Logo.test.tsx

@@ -0,0 +1,98 @@
+import * as React from "react";
+import { render } from "@testing-library/react";
+import { axe } from "jest-axe";
+import renderer from "react-test-renderer";
+
+import Logo from "./Logo";
+import { LogoNames, LogoSizes } from "./LogoTypes";
+
+describe("Logo Accessibility", () => {
+  it("passes axe accessibility test", async () => {
+    const { container } = render(<Logo name={LogoNames.NYPLBlack} />);
+    expect(await axe(container)).toHaveNoViolations();
+  });
+});
+
+describe("Logo", () => {
+  it("consoles a warning if both name and children are passed to Logo", () => {
+    const warn = jest.spyOn(console, "warn");
+    render(
+      <Logo name={LogoNames.NYPLBlack}>
+        <svg viewBox="0 0 24 14" xmlns="http://www.w3.org/2000/svg">
+          <path
+            fillRule="evenodd"
+            clipRule="evenodd"
+            d="M10.526 12.871L.263 1.676 1.737.324 12 11.52 22.263.324l1.474 1.352L13.474 12.87a2 2 0 01-2.948 0z"
+          />
+        </svg>
+      </Logo>
+    );
+    expect(warn).toHaveBeenCalledWith(
+      "Logo accepts either a `name` prop or an `svg` element child. It can not accept both."
+    );
+  });
+
+  it("consoles a warning if both name and children are not passed", () => {
+    const warn = jest.spyOn(console, "warn");
+    render(<Logo />);
+    expect(warn).toHaveBeenCalledWith(
+      "Pass a logo `name` prop or an SVG child to `Logo` to ensure a logo appears."
+    );
+  });
+
+  it("renders a logo based on the logo `name` prop", () => {
+    const { container } = render(<Logo name={LogoNames.NYPLBlack} />);
+    expect(container.querySelector("svg")).toBeInTheDocument();
+  });
+
+  // NOTE: the svg logo is dynamically generated by the "svgr" package. At build
+  // time, it generate the `title` element but it doesn't generate it for tests.
+  // In order to test this, we can check the `title` attribute in the svg
+  // element itself. Inspect the `Logo` in Storybook to see the `title` element.
+  it("renders a title element", () => {
+    const { container, rerender } = render(<Logo name={LogoNames.NYPLBlack} />);
+    expect(container.querySelector("svg")).toHaveAttribute(
+      "title",
+      "logo_nypl_full_black logo"
+    );
+
+    rerender(<Logo name={LogoNames.NYPLBlack} title="title content" />);
+    expect(container.querySelector("svg")).toHaveAttribute(
+      "title",
+      "title content"
+    );
+  });
+
+  it("renders a logo based on the child", () => {
+    const { container } = render(
+      <Logo>
+        <svg viewBox="0 0 24 14" xmlns="http://www.w3.org/2000/svg">
+          <path
+            fillRule="evenodd"
+            clipRule="evenodd"
+            d="M10.526 12.871L.263 1.676 1.737.324 12 11.52 22.263.324l1.474 1.352L13.474 12.87a2 2 0 01-2.948 0z"
+          />
+        </svg>
+      </Logo>
+    );
+    expect(container.querySelector("svg")).toBeInTheDocument();
+  });
+
+  it("renders the UI snapshot correctly", () => {
+    const standard = renderer
+      .create(<Logo id="test-logo" name={LogoNames.NYPLBlack} />)
+      .toJSON();
+    const withCustomSize = renderer
+      .create(
+        <Logo
+          id="test-logo-size"
+          name={LogoNames.NYPLBlack}
+          size={LogoSizes.Large}
+        />
+      )
+      .toJSON();
+
+    expect(standard).toMatchSnapshot();
+    expect(withCustomSize).toMatchSnapshot();
+  });
+});

package/src/components/Logo/Logo.tsx

@@ -0,0 +1,97 @@
+import * as React from "react";
+import { Icon as ChakraIcon, Box, useStyleConfig } from "@chakra-ui/react";
+
+import generateUUID from "../../helpers/generateUUID";
+import { LogoNames, LogoSizes } from "./LogoTypes";
+import logoSvgs from "./LogoSvgs";
+
+export interface LogoProps {
+  /** Optionally pass in additional Chakra-based styles. */
+  additionalStyles?: { [key: string]: any };
+  /** Optional className that will be added to the parent element */
+  className?: string;
+  /** Logos designated as decorative will be ignored by screenreaders. False
+   * by default. */
+  decorative?: boolean;
+  /** ID that other components can cross reference for accessibility purposes */
+  id?: string;
+  /** The name of the logo you want to use. */
+  name?: LogoNames;
+  /** Sets the logo size. */
+  size?: LogoSizes;
+  /** For accessibility purposes, the text passed in the `title` prop gets
+   * rendered in a `title` element in the SVG. This descriptive text is not
+   * visible but is needed for screenreaders to describe the graphic. */
+  title?: string;
+}
+
+/**
+ * The `Logo` component renders SVG-based logos and color variants that are
+ * commonly used by the New York Public Library.
+ */
+export default function Logo(props: React.PropsWithChildren<LogoProps>) {
+  const {
+    additionalStyles = {},
+    children,
+    className,
+    decorative = false,
+    id = generateUUID(),
+    name,
+    size = LogoSizes.Medium,
+    title = `${name} logo`,
+  } = props;
+  const styles = useStyleConfig("Logo", {
+    size,
+  });
+  const logoProps = {
+    "aria-hidden": decorative,
+    className,
+    id,
+    role: "img",
+    title,
+  };
+  let childSVG = null;
+
+  // Component prop validation
+  if (name && children) {
+    console.warn(
+      "Logo accepts either a `name` prop or an `svg` element child. It can not accept both."
+    );
+    return null;
+  } else if (!name && !children) {
+    console.warn(
+      "Pass a logo `name` prop or an SVG child to `Logo` to ensure a logo appears."
+    );
+    return null;
+  }
+
+  // The user wants to render an existing logo. Load the logo and render it
+  // as a component through Chakra's Icon component. Otherwise, we're going to
+  // render the SVG child with NYPL-theme styling.
+  if (name) {
+    const SvgComponent: any = logoSvgs[name];
+    return (
+      <ChakraIcon
+        as={SvgComponent}
+        {...logoProps}
+        __css={{ ...styles, ...additionalStyles }}
+      />
+    );
+  }
+
+  // If no `name` prop was passed, we expect a child SVG element to be passed.
+  // Apply logo props to the SVG child.
+  if (
+    (children as JSX.Element).type === "svg" ||
+    (children as JSX.Element).props.type === "svg" ||
+    (children as JSX.Element).props.mdxType === "svg"
+  ) {
+    childSVG = React.cloneElement(children as JSX.Element, {
+      ...logoProps,
+    });
+  } else {
+    console.warn("You must pass an `svg` element to the `Logo` component.");
+  }
+
+  return <Box __css={styles}>{childSVG}</Box>;
+}

package/src/components/Logo/LogoSvgs.tsx

@@ -0,0 +1,34 @@
+/* eslint-disable camelcase */
+import logo_bpl_black from "../../../icons/svg/logo_bpl_black.svg";
+import logo_lpa_color from "../../../icons/svg/logo_lpa_color.svg";
+import logo_lpa_white from "../../../icons/svg/logo_lpa_white.svg";
+import logo_nypl_full_black from "../../../icons/svg/logo_nypl_full_black.svg";
+import logo_nypl_full_white from "../../../icons/svg/logo_nypl_full_white.svg";
+import logo_nypl_lion_black from "../../../icons/svg/logo_nypl_lion_black.svg";
+import logo_nypl_lion_white from "../../../icons/svg/logo_nypl_lion_white.svg";
+import logo_qpl_alt_black from "../../../icons/svg/logo_qpl_alt_black.svg";
+import logo_qpl_color from "../../../icons/svg/logo_qpl_color.svg";
+import logo_schomburg_circle_color from "../../../icons/svg/logo_schomburg_circle_color.svg";
+import logo_schomburg_color from "../../../icons/svg/logo_schomburg_color.svg";
+import logo_simplye_black from "../../../icons/svg/logo_simplye_black.svg";
+import logo_simplye_color from "../../../icons/svg/logo_simplye_color.svg";
+import logo_snfl_black from "../../../icons/svg/logo_snfl_black.svg";
+import logo_snfl_white from "../../../icons/svg/logo_snfl_white.svg";
+
+export default {
+  logo_bpl_black,
+  logo_lpa_color,
+  logo_lpa_white,
+  logo_nypl_full_black,
+  logo_nypl_full_white,
+  logo_nypl_lion_white,
+  logo_nypl_lion_black,
+  logo_qpl_alt_black,
+  logo_qpl_color,
+  logo_schomburg_circle_color,
+  logo_schomburg_color,
+  logo_simplye_black,
+  logo_simplye_color,
+  logo_snfl_black,
+  logo_snfl_white,
+};

package/src/components/Logo/LogoTypes.tsx

@@ -0,0 +1,32 @@
+export enum LogoColors {
+  Default = "",
+  UiBlack = "ui.black",
+  UiWhite = "ui.white",
+}
+
+export enum LogoSizes {
+  ExtraExtraSmall = "xxsmall",
+  ExtraSmall = "xsmall",
+  Small = "small",
+  Medium = "medium",
+  Large = "large",
+  Default = "default",
+}
+
+export enum LogoNames {
+  BrooklynPublicLibraryBlack = "logo_bpl_black",
+  LPAColor = "logo_lpa_color",
+  LPAWhite = "logo_lpa_white",
+  NYPLBlack = "logo_nypl_full_black",
+  NYPLWhite = "logo_nypl_full_white",
+  NYPLLionBlack = "logo_nypl_lion_black",
+  NYPLLionWhite = "logo_nypl_lion_white",
+  QueensPublicLibraryColor = "logo_qpl_color",
+  QueensPublicLibraryAltBlack = "logo_qpl_alt_black",
+  SchomburgColor = "logo_schomburg_color",
+  SchomburgCircleColor = "logo_schomburg_circle_color",
+  SimplyEColor = "logo_simplye_color",
+  SimplyEBlack = "logo_simplye_black",
+  SNFLBlack = "logo_snfl_black",
+  SNFLWhite = "logo_snfl_white",
+}

package/src/components/Logo/__snapshots__/Logo.test.tsx.snap

@@ -0,0 +1,71 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Logo renders the UI snapshot correctly 1`] = `
+<svg
+  aria-hidden={false}
+  className="chakra-icon css-onkibi"
+  focusable={false}
+  id="test-logo"
+  role="img"
+  title="logo_nypl_full_black logo"
+  viewBox="0 0 24 24"
+>
+  <g
+    stroke="currentColor"
+    strokeWidth="1.5"
+  >
+    <path
+      d="M9,9a3,3,0,1,1,4,2.829,1.5,1.5,0,0,0-1,1.415V14.25"
+      fill="none"
+      strokeLinecap="round"
+    />
+    <path
+      d="M12,17.25a.375.375,0,1,0,.375.375A.375.375,0,0,0,12,17.25h0"
+      fill="currentColor"
+      strokeLinecap="round"
+    />
+    <circle
+      cx="12"
+      cy="12"
+      fill="none"
+      r="11.25"
+      strokeMiterlimit="10"
+    />
+  </g>
+</svg>
+`;
+
+exports[`Logo renders the UI snapshot correctly 2`] = `
+<svg
+  aria-hidden={false}
+  className="chakra-icon css-onkibi"
+  focusable={false}
+  id="test-logo-size"
+  role="img"
+  title="logo_nypl_full_black logo"
+  viewBox="0 0 24 24"
+>
+  <g
+    stroke="currentColor"
+    strokeWidth="1.5"
+  >
+    <path
+      d="M9,9a3,3,0,1,1,4,2.829,1.5,1.5,0,0,0-1,1.415V14.25"
+      fill="none"
+      strokeLinecap="round"
+    />
+    <path
+      d="M12,17.25a.375.375,0,1,0,.375.375A.375.375,0,0,0,12,17.25h0"
+      fill="currentColor"
+      strokeLinecap="round"
+    />
+    <circle
+      cx="12"
+      cy="12"
+      fill="none"
+      r="11.25"
+      strokeMiterlimit="10"
+    />
+  </g>
+</svg>
+`;

package/src/components/Modal/Modal.stories.mdx

@@ -1,11 +1,12 @@
 import { useState } from "react";
 import {
-  Meta,
-  Story,
   ArgsTable,
   Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
+
 import Modal from "./Modal";
 import Button from "../Button/Button";
 import { getCategory } from "../../utils/componentCategories";
@@ -14,7 +15,12 @@ import { getCategory } from "../../utils/componentCategories";
   title={getCategory("Modal")}
   component={Modal}
   argTypes={{
+    blockName: { control: false },
     children: { table: { disable: true } },
+    className: { control: false },
+    id: { control: false },
+    modifiers: { control: false },
+    open: { description: "Only used in Storybook." },
   }}
   parameters={{
     jest: ["Modal.test.tsx"],
@@ -119,12 +125,21 @@ export const ModalStory = (args) => {
 };
 
 <Canvas withToolbar>
-  <Story name="Basic" args={{ open: false }}>
+  <Story
+    name="Modal"
+    args={{
+      blockName: undefined,
+      className: undefined,
+      id: "modal-id",
+      modifiers: undefined,
+      open: false,
+    }}
+  >
     {(args) => <ModalStory {...args} />}
   </Story>
 </Canvas>
 
-<ArgsTable story="Basic" />
+<ArgsTable story="Modal" />
 
 ## Code Implementation
 

package/src/components/Modal/Modal.tsx

@@ -1,15 +1,10 @@
 import * as React from "react";
-import bem from "../../utils/bem";
 
 export interface ModalProps {
-  /** BlockName for use with BEM. See how to work with blockNames and BEM here: http://getbem.com/introduction/ */
-  blockName?: string;
   /** ClassName that appears in addition to "modal" */
   className?: string;
   /** ID that other components can cross reference for accessibility purposes */
   id?: string;
-  /** Modifiers array for use with BEM. See how to work with modifiers and BEM here: http://getbem.com/introduction/ */
-  modifiers?: string[];
 }
 
 /** Full-screen modal that appears on top of the body of the page. */
@@ -23,14 +18,13 @@ export default class Modal extends React.Component<ModalProps, any> {
   }
 
   render() {
-    const { modifiers = [], blockName, id, className } = this.props;
-    const baseClass = "modal";
+    const { id, className } = this.props;
 
     return (
       <div
         // eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex
         tabIndex={0}
-        className={bem(baseClass, modifiers, blockName, [className])}
+        className={`modal ${className}`}
         id={id}
       >
         {this.props.children}

package/src/components/Notification/Notification.stories.mdx

@@ -1,24 +1,24 @@
 import {
-  Meta,
-  Story,
-  Canvas,
   ArgsTable,
-  Preview,
+  Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
 
+import Icon from "../Icons/Icon";
+import { IconColors, IconNames } from "../Icons/IconTypes";
 import Notification from "./Notification";
 import { NotificationTypes } from "./NotificationTypes";
-import Icon from "../Icons/Icon";
-import {
-  IconSizes,
-  IconColors,
-  IconNames,
-  IconAlign,
-} from "../Icons/IconTypes";
 import { getCategory } from "../../utils/componentCategories";
 import DSProvider from "../../theme/provider";
+import { getStorybookEnumValues } from "../../utils/utils";
+
+export const enumValues = getStorybookEnumValues(
+  NotificationTypes,
+  "NotificationTypes"
+);
 
 <Meta
   title={getCategory("Notification")}
@@ -27,11 +27,29 @@ import DSProvider from "../../theme/provider";
   parameters={{
     design: {
       type: "figma",
-      url:
-        "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/?node-id=10734%3A812",
+      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/?node-id=10734%3A812",
     },
     jest: ["Notification.test.tsx"],
   }}
+  argTypes={{
+    centered: {
+      table: { defaultValue: { summary: false } },
+    },
+    className: { control: false },
+    dismissible: {
+      table: { defaultValue: { summary: false } },
+    },
+    icon: { control: false },
+    id: { control: false },
+    noMargin: {
+      table: { defaultValue: { summary: false } },
+    },
+    notificationType: {
+      control: { type: "select" },
+      table: { defaultValue: { summary: "NotificationTypes.Standard" } },
+      options: enumValues.options,
+    },
+  }}
 />
 
 # Notification
@@ -39,7 +57,7 @@ import DSProvider from "../../theme/provider";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.23.2`   |
-| Latest            | `0.25.4`   |
+| Latest            | `0.25.9`   |
 
 <Description of={Notification} />
 
@@ -52,10 +70,14 @@ within a parent element.
 
 <Canvas>
   <Story
-    name="Notification Props"
+    name="Notification with Controls"
     args={{
-      id: "basic-notification",
-      centered: true,
+      centered: false,
+      className: undefined,
+      dismissible: false,
+      icon: undefined,
+      id: "notification-id",
+      noMargin: false,
       notificationHeading: "Notification Heading",
       notificationContent: (
         <>
@@ -67,17 +89,21 @@ within a parent element.
           nisi erat porttitor ligula.
         </>
       ),
+      showIcon: true,
     }}
   >
     {(args) => (
       <div style={{ border: "1px solid #ccc" }}>
-        <Notification {...args} />
+        <Notification
+          {...args}
+          notificationType={enumValues.getValue(args.notificationType)}
+        />
       </div>
     )}
   </Story>
 </Canvas>
 
-<ArgsTable story="Notification Props" />
+<ArgsTable story="Notification with Controls" />
 
 ## Variants
 
@@ -194,31 +220,61 @@ within a parent element.
   </DSProvider>
 </Canvas>
 
+### Without Icon
+
+The `Notification` icon can be hidden with the `showIcon` prop set to `false`.
+
+<Canvas>
+  <DSProvider>
+    <Notification
+      notificationHeading="Standard Notification without Icon"
+      notificationContent={
+        <>
+          Cras mattis consectetur purus sit amet fermentum. Maecenas faucibus
+          mollis interdum. Morbi leo risus, porta ac consectetur ac, vestibulum
+          at eros. Cum sociis natoque penatibus et magnis dis parturient montes,
+          nascetur ridiculus mus.
+        </>
+      }
+      showIcon={false}
+    />
+    <Notification
+      notificationContent={
+        <>
+          This is an Standard Notification without a heading or icon. Cras
+          mattis consectetur purus sit amet fermentum. Maecenas faucibus mollis
+          interdum. Morbi leo risus, porta ac consectetur ac, vestibulum at
+          eros. Cum sociis natoque penatibus et magnis dis parturient montes,
+          nascetur ridiculus mus.
+        </>
+      }
+      showIcon={false}
+    />
+  </DSProvider>
+</Canvas>
+
 ## Custom Icon
 
 The default icon can be overridden by using the `icon` prop to pass a custom `Icon` component.
 
 <Canvas>
   <Story name="Custom Icons">
-    {(args) => (
-      <Notification
-        icon={
-          <Icon
-            name={IconNames.Check}
-            color={IconColors.SectionResearchSecondary}
-          />
-        }
-        notificationHeading="Custom Icon"
-        notificationContent={
-          <>
-            This is a Notification with a custom icon. Cras mattis consectetur
-            purus sit amet fermentum. Maecenas faucibus mollis interdum. Morbi
-            leo risus, porta ac consectetur ac, vestibulum at eros. Cum sociis
-            natoque penatibus et magnis dis parturient montes, nascetur
-            ridiculus mus.
-          </>
-        }
-      />
-    )}
+    <Notification
+      icon={
+        <Icon
+          name={IconNames.Check}
+          color={IconColors.SectionResearchSecondary}
+        />
+      }
+      notificationHeading="Custom Icon"
+      notificationContent={
+        <>
+          This is a Notification with a custom icon. Cras mattis consectetur
+          purus sit amet fermentum. Maecenas faucibus mollis interdum. Morbi leo
+          risus, porta ac consectetur ac, vestibulum at eros. Cum sociis natoque
+          penatibus et magnis dis parturient montes, nascetur ridiculus mus.
+        </>
+      }
+    />
   </Story>
 </Canvas>