@nypl/design-system-react-components 0.25.8 → 0.25.11

package/src/components/Logo/LogoSvgs.tsx

@@ -0,0 +1,66 @@
+/* eslint-disable camelcase */
+import logo_bpl_black from "../../../icons/svg/logo_bpl_black.svg";
+import logo_bpl_white from "../../../icons/svg/logo_bpl_white.svg";
+import logo_clever_color from "../../../icons/svg/logo_clever_color.svg";
+import logo_clever_white from "../../../icons/svg/logo_clever_white.svg";
+import logo_lpa_color from "../../../icons/svg/logo_lpa_color.svg";
+import logo_lpa_black from "../../../icons/svg/logo_lpa_black.svg";
+import logo_lpa_white from "../../../icons/svg/logo_lpa_white.svg";
+import logo_mln_black from "../../../icons/svg/logo_mln_black.svg";
+import logo_mln_white from "../../../icons/svg/logo_mln_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_alt_white from "../../../icons/svg/logo_qpl_alt_white.svg";
+import logo_qpl_black from "../../../icons/svg/logo_qpl_black.svg";
+import logo_qpl_color from "../../../icons/svg/logo_qpl_color.svg";
+import logo_qpl_white from "../../../icons/svg/logo_qpl_white.svg";
+import logo_schomburg_black from "../../../icons/svg/logo_schomburg_black.svg";
+import logo_schomburg_circle_black from "../../../icons/svg/logo_schomburg_circle_black.svg";
+import logo_schomburg_circle_color from "../../../icons/svg/logo_schomburg_circle_color.svg";
+import logo_schomburg_circle_white from "../../../icons/svg/logo_schomburg_circle_white.svg";
+import logo_schomburg_color from "../../../icons/svg/logo_schomburg_color.svg";
+import logo_schomburg_white from "../../../icons/svg/logo_schomburg_white.svg";
+import logo_simplye_black from "../../../icons/svg/logo_simplye_black.svg";
+import logo_simplye_white from "../../../icons/svg/logo_simplye_white.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";
+import logo_treasures_color from "../../../icons/svg/logo_treasures_color.svg";
+import logo_treasures_color_negative from "../../../icons/svg/logo_treasures_color_negative.svg";
+
+export default {
+  logo_bpl_black,
+  logo_bpl_white,
+  logo_clever_color,
+  logo_clever_white,
+  logo_lpa_black,
+  logo_lpa_color,
+  logo_lpa_white,
+  logo_mln_black,
+  logo_mln_white,
+  logo_nypl_full_black,
+  logo_nypl_full_white,
+  logo_nypl_lion_black,
+  logo_nypl_lion_white,
+  logo_qpl_alt_black,
+  logo_qpl_alt_white,
+  logo_qpl_black,
+  logo_qpl_color,
+  logo_qpl_white,
+  logo_schomburg_black,
+  logo_schomburg_circle_black,
+  logo_schomburg_circle_color,
+  logo_schomburg_circle_white,
+  logo_schomburg_color,
+  logo_schomburg_white,
+  logo_simplye_black,
+  logo_simplye_white,
+  logo_simplye_color,
+  logo_snfl_black,
+  logo_snfl_white,
+  logo_treasures_color,
+  logo_treasures_color_negative,
+};

package/src/components/Logo/LogoTypes.tsx

@@ -0,0 +1,48 @@
+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",
+  BrooklynPublicLibraryWhite = "logo_bpl_white",
+  CleverColor = "logo_clever_color",
+  CleverWhite = "logo_clever_white",
+  LPAColor = "logo_lpa_color",
+  LPABlack = "logo_lpa_black",
+  LPAWhite = "logo_lpa_white",
+  MyLibraryNYCBlack = "logo_mln_black",
+  MyLibraryNYCWhite = "logo_mln_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",
+  QueensPublicLibraryBlack = "logo_qpl_black",
+  QueensPublicLibraryWhite = "logo_qpl_white",
+  QueensPublicLibraryAltBlack = "logo_qpl_alt_black",
+  QueensPublicLibraryAltWhite = "logo_qpl_alt_white",
+  SchomburgColor = "logo_schomburg_color",
+  SchomburgBlack = "logo_schomburg_black",
+  SchomburgWhite = "logo_schomburg_white",
+  SchomburgCircleColor = "logo_schomburg_circle_color",
+  SchomburgCircleBlack = "logo_schomburg_circle_black",
+  SchomburgCircleWhite = "logo_schomburg_circle_white",
+  SimplyEColor = "logo_simplye_color",
+  SimplyEBlack = "logo_simplye_black",
+  SimplyEWhite = "logo_simplye_white",
+  SNFLBlack = "logo_snfl_black",
+  SNFLWhite = "logo_snfl_white",
+  TreasuresColor = "logo_treasures_color",
+  TreasuresColorNegative = "logo_treasures_color_negative",
+}

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,25 @@
 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 Link from "../Link/Link";
 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")}
@@ -31,6 +32,26 @@ import DSProvider from "../../theme/provider";
     },
     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 } },
+    },
+    notificationContent: { control: false },
+    notificationType: {
+      control: { type: "select" },
+      table: { defaultValue: { summary: "NotificationTypes.Standard" } },
+      options: enumValues.options,
+    },
+  }}
 />
 
 # Notification
@@ -38,7 +59,7 @@ import DSProvider from "../../theme/provider";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.23.2`   |
-| Latest            | `0.25.8`   |
+| Latest            | `0.25.11`  |
 
 <Description of={Notification} />
 
@@ -51,10 +72,15 @@ within a parent element.
 
 <Canvas>
   <Story
-    name="Notification Props"
+    name="Notification with Controls"
     args={{
-      id: "basic-notification",
-      centered: true,
+      ariaLabel: "Notification label",
+      centered: false,
+      className: undefined,
+      dismissible: false,
+      icon: undefined,
+      id: "notification-id",
+      noMargin: false,
       notificationHeading: "Notification Heading",
       notificationContent: (
         <>
@@ -66,18 +92,31 @@ within a parent element.
           nisi erat porttitor ligula.
         </>
       ),
+      notificationType: "NotificationTypes.Standard",
       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" />
+
+## Accessibility
+
+The `Notification` component renders with an HTML `aside` element as its wrapper.
+This is an HTML landmark element that is similar to adding an attribute of
+`role="complementary"`. For accessibility purposes, landmark elements should not
+be rendered inside other landmark elements such as the `header` and `footer`
+landmark elements. Adding a `Notification` component inside an HTML `main` landmark
+element is acceptable.
 
 ## Variants
 
@@ -227,31 +266,82 @@ The `Notification` icon can be hidden with the `showIcon` prop set to `false`.
   </DSProvider>
 </Canvas>
 
+### With HTML content
+
+The `notificationContent` prop can accept HTML.
+
+<Canvas>
+  <DSProvider>
+    <Notification
+      notificationHeading="Standard Notification with HTML content"
+      notificationContent={
+        <>
+          <p>
+            Cras mattis consectetur purus sit amet fermentum. Maecenas faucibus
+            mollis interdum.
+          </p>
+          <p>
+            Morbi leo risus, porta ac consectetur ac, vestibulum at eros.{" "}
+            <b>
+              Cum sociis natoque penatibus et magnis dis parturient montes,
+              nascetur ridiculus mus
+            </b>
+            . <Link href="#">This is a link</Link>.
+          </p>
+        </>
+      }
+    />
+  </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>
+
+## Dismissible
+
+A dismissible `Notification` component can be created by setting the
+`dismissible` prop to `true`. Once the "X" close icon on the upper right is
+clicked, the `Notification` will be removed from the DOM, therefore it only
+appears once.
+
+<Canvas>
+  <Story name="Dismissible">
+    <Notification
+      dismissible
+      notificationHeading="Dismissible Notification"
+      notificationContent={
+        <>
+          This is a dismissible Notification with an X 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.
+        </>
+      }
+      notificationType={NotificationTypes.Announcement}
+    />
   </Story>
 </Canvas>

package/src/components/Notification/Notification.test.tsx

@@ -41,6 +41,18 @@ describe("Notification Accessibility", () => {
     );
     expect(await axe(container)).toHaveNoViolations();
   });
+
+  it("passes axe accessibility test for the dismissible type", async () => {
+    const { container } = render(
+      <Notification
+        dismissible
+        id="notificationID"
+        notificationContent={<>Notification content.</>}
+        notificationHeading="Notification Heading"
+      />
+    );
+    expect(await axe(container)).toHaveNoViolations();
+  });
 });
 
 describe("Notification", () => {
@@ -48,6 +60,7 @@ describe("Notification", () => {
   beforeEach(() => {
     utils = render(
       <Notification
+        ariaLabel="Notification label"
         id="notificationID"
         notificationContent={<>Notification content.</>}
         notificationHeading="Notification Heading"
@@ -133,7 +146,31 @@ describe("Notification", () => {
     );
   });
 
-  it("renders the UI snapshot correctly", () => {
+  it("renders with an aria-label attribute", () => {
+    expect(screen.getByRole("complementary")).toHaveAttribute(
+      "aria-label",
+      "Notification label"
+    );
+  });
+
+  it("renders a dismissible icon", () => {
+    utils.rerender(
+      <Notification
+        dismissible
+        id="notificationID"
+        notificationContent={<>Notification content.</>}
+        notificationHeading="Notification Heading"
+        notificationType={NotificationTypes.Standard}
+      />
+    );
+    const icons = screen.queryAllByRole("img");
+
+    expect(icons).toHaveLength(2);
+    expect(screen.getByTitle("Notification standard icon")).toBeInTheDocument();
+    expect(screen.getByTitle("Notification close icon")).toBeInTheDocument();
+  });
+
+  it.skip("renders the UI snapshot correctly", () => {
     const standard = renderer
       .create(
         <Notification
@@ -190,11 +227,22 @@ describe("Notification", () => {
         />
       )
       .toJSON();
+    const dismissible = renderer
+      .create(
+        <Notification
+          dismissible
+          id="notificationID7"
+          notificationContent={<>Notification content.</>}
+        />
+      )
+      .toJSON();
+
     expect(standard).toMatchSnapshot();
     expect(announcement).toMatchSnapshot();
     expect(warning).toMatchSnapshot();
     expect(withoutHeading).toMatchSnapshot();
     expect(withoutAnIcon).toMatchSnapshot();
     expect(withoutHeadingAndIcon).toMatchSnapshot();
+    expect(dismissible).toMatchSnapshot();
   });
 });