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

package/src/components/Notification/Notification.tsx

@@ -17,6 +17,8 @@ interface BaseProps {
   centered?: boolean;
   /** Optional custom `Icon` that will override the default `Icon`. */
   icon?: JSX.Element;
+  /** ID that other components can cross reference for accessibility purposes. */
+  id?: string;
   /** Optional prop to control the coloring of the `Notification` text and the
    * visibility of an applicable icon. */
   notificationType?: NotificationTypes;
@@ -28,6 +30,8 @@ type BasePropsWithoutAlignText = Omit<BaseProps, "alignText">;
 type BasePropsWithoutCentered = Omit<BaseProps, "centered">;
 
 export interface NotificationProps extends BasePropsWithoutAlignText {
+  /** Label used to describe the `Notification`'s aside HTML element. */
+  ariaLabel?: string;
   /** Additional `className` to add.  */
   className?: string;
   /** Optional prop to control whether a `Notification` can be dismissed
@@ -35,8 +39,6 @@ export interface NotificationProps extends BasePropsWithoutAlignText {
   dismissible?: boolean;
   /** Optional custom `Icon` that will override the default `Icon`. */
   icon?: JSX.Element;
-  /** ID that other components can cross reference for accessibility purposes. */
-  id?: string;
   /** Optional prop to control the margin around the `Notification` component. */
   noMargin?: boolean;
   /** Content to be rendered in a `NotificationContent` component. */
@@ -53,7 +55,7 @@ export interface NotificationProps extends BasePropsWithoutAlignText {
 export function NotificationHeading(
   props: React.PropsWithChildren<BasePropsWithoutAlignText>
 ) {
-  const { centered, children, icon, notificationType } = props;
+  const { centered, children, icon, id, notificationType } = props;
   const styles = useMultiStyleConfig("NotificationHeading", {
     centered,
     icon,
@@ -62,7 +64,11 @@ export function NotificationHeading(
   return (
     <Box as="header" __css={styles}>
       {icon}
-      <Heading level={HeadingLevels.Four} additionalStyles={styles.heading}>
+      <Heading
+        additionalStyles={styles.heading}
+        id={`${id}-heading`}
+        level={HeadingLevels.Four}
+      >
         {children}
       </Heading>
     </Box>
@@ -95,6 +101,7 @@ export function NotificationContent(
  */
 export default function Notification(props: NotificationProps) {
   const {
+    ariaLabel,
     centered = false,
     className,
     dismissible = false,
@@ -110,15 +117,15 @@ export default function Notification(props: NotificationProps) {
   const handleClose = () => setIsOpen(false);
   const styles = useMultiStyleConfig("Notification", {
     centered,
+    dismissible,
     noMargin,
     notificationType,
-    showIcon,
   });
   const iconElement = () => {
     const baseIconProps = {
+      additionalStyles: styles.icon,
       decorative: false,
       size: IconSizes.Large,
-      additionalStyles: styles.icon,
     };
     // If the icon should not display, return null.
     if (!showIcon) {
@@ -132,16 +139,19 @@ export default function Notification(props: NotificationProps) {
       });
     const iconProps = {
       [NotificationTypes.Announcement]: {
-        name: IconNames.SpeakerNotes,
         color: IconColors.SectionResearchSecondary,
+        name: IconNames.SpeakerNotes,
+        title: "Notification announcement icon",
       },
       [NotificationTypes.Standard]: {
-        name: IconNames.AlertNotificationImportant,
         color: IconColors.UiBlack,
+        name: IconNames.AlertNotificationImportant,
+        title: "Notification standard icon",
       },
       [NotificationTypes.Warning]: {
-        name: IconNames.ErrorFilled,
         color: IconColors.BrandPrimary,
+        name: IconNames.ErrorFilled,
+        title: "Notification warning icon",
       },
     };
     return (
@@ -159,10 +169,11 @@ export default function Notification(props: NotificationProps) {
       additionalStyles={styles.dismissibleButton}
     >
       <Icon
-        id={`${id}-notification-dismissible-icon`}
         decorative={false}
+        id={`${id}-notification-dismissible-icon`}
         name={IconNames.Close}
         size={IconSizes.Large}
+        title="Notification close icon"
       />
     </Button>
   );
@@ -171,6 +182,7 @@ export default function Notification(props: NotificationProps) {
     <NotificationHeading
       centered={centered}
       icon={iconElem}
+      id={id}
       notificationType={notificationType}
     >
       {notificationHeading}
@@ -194,11 +206,12 @@ export default function Notification(props: NotificationProps) {
   }
   return (
     <Box
+      aria-label={ariaLabel}
       as="aside"
-      id={id}
       className={className}
-      __css={styles}
       data-type={notificationType}
+      id={id}
+      __css={styles}
     >
       <Box __css={styles.container}>
         {childHeading}

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

@@ -46,6 +46,7 @@ exports[`Notification renders the UI snapshot correctly 1`] = `
       </svg>
       <h4
         className="chakra-heading css-0"
+        id="notificationID1-heading"
       >
         Notification Heading
       </h4>
@@ -109,6 +110,7 @@ exports[`Notification renders the UI snapshot correctly 2`] = `
       </svg>
       <h4
         className="chakra-heading css-0"
+        id="notificationID2-heading"
       >
         Notification Heading
       </h4>
@@ -172,6 +174,7 @@ exports[`Notification renders the UI snapshot correctly 3`] = `
       </svg>
       <h4
         className="chakra-heading css-0"
+        id="notificationID3-heading"
       >
         Notification Heading
       </h4>
@@ -257,6 +260,7 @@ exports[`Notification renders the UI snapshot correctly 5`] = `
     >
       <h4
         className="chakra-heading css-0"
+        id="notificationID5-heading"
       >
         Notification Heading
       </h4>

package/src/components/Pagination/Pagination.stories.mdx

@@ -1,12 +1,13 @@
 import {
-  Meta,
-  Story,
   ArgsTable,
   Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
 import { withQuery } from "@storybook/addon-queryparams";
+
 import Pagination from "./Pagination";
 import * as stories from "./Pagination.stories.tsx";
 import { getCategory } from "../../utils/componentCategories";
@@ -23,9 +24,11 @@ import { getCategory } from "../../utils/componentCategories";
     jest: ["Pagination.test.tsx"],
   }}
   argTypes={{
-    id: { table: { disable: true } },
-    getPageHref: { table: { disable: true } },
-    onPageChange: { table: { disable: true } },
+    className: { control: false },
+    getPageHref: { control: false },
+    id: { control: false },
+    initialPage: { table: { defaultValue: { summary: 1 } } },
+    onPageChange: { control: false },
   }}
 />
 
@@ -34,7 +37,7 @@ import { getCategory } from "../../utils/componentCategories";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.0.10`   |
-| Latest            | `0.25.3`   |
+| Latest            | `0.25.10`  |
 
 <Description of={Pagination} />
 
@@ -69,7 +72,11 @@ const getPageHref = (selectedPage: number) => {
   <Story
     name="Pagination with URL Updates"
     args={{
+      className: undefined,
+      getPageHref: undefined,
+      id: "pagination-id",
       initialPage: 1,
+      onPageChange: undefined,
       pageCount: 10,
     }}
   >
@@ -102,7 +109,11 @@ const onPageChange = (currentPage: number) => {
   <Story
     name="Pagination with Unchanging URL"
     args={{
+      className: undefined,
+      getPageHref: undefined,
+      id: "pagination-id-2",
       initialPage: 7,
+      onPageChange: undefined,
       pageCount: 100,
     }}
   >

package/src/components/Pagination/Pagination.tsx

@@ -31,10 +31,10 @@ export interface PaginationProps {
 const Pagination: React.FC<PaginationProps> = (props: PaginationProps) => {
   const {
     className,
-    initialPage = 1,
     getPageHref,
     id = generateUUID(),
-    onPageChange = () => {},
+    initialPage = 1,
+    onPageChange,
     pageCount,
   } = props;
   const [currentPage, setCurrentPage] = useState<number>(initialPage);
@@ -63,7 +63,7 @@ const Pagination: React.FC<PaginationProps> = (props: PaginationProps) => {
     e.preventDefault && e.preventDefault();
     if (currentPage === selectedPage) return;
     setCurrentPage(selectedPage);
-    onPageChange(selectedPage);
+    onPageChange && onPageChange(selectedPage);
   };
   // Select the previous page.
   const previousPage = (e: Event) => {

package/src/components/Placeholder/Placeholder.tsx

@@ -1,24 +1,17 @@
 import * as React from "react";
-import bem from "../../utils/bem";
 
 export interface PlaceholderProps {
-  /** BlockName for use with BEM. See how to work with blockNames and BEM here: http://getbem.com/introduction/ */
-  blockName?: string;
-  /** Modifiers array for use with BEM. See how to work with modifiers and BEM here: http://getbem.com/introduction/ */
-  modifiers?: string[];
+  /** Modifier string for the classname. */
+  variant?: string;
 }
 
 /** Creates a gray box with an editable string for dropping in spaces
  * within components or on templates where a component will be but
  * that hasn't been created yet
  */
-export default function Placeholder(
-  props: React.PropsWithChildren<PlaceholderProps>
-) {
-  const { modifiers = [], blockName } = props;
-  return (
-    <div className={bem("placeholder", modifiers, blockName)}>
-      {props.children}
-    </div>
-  );
+export default function Placeholder({
+  children,
+  variant,
+}: React.PropsWithChildren<PlaceholderProps>) {
+  return <div className={`placeholder placeholder-${variant}`}>{children}</div>;
 }

package/src/components/ProgressIndicator/ProgressIndicator.stories.mdx

@@ -1,22 +1,32 @@
+import { Box } from "@chakra-ui/react";
 import {
-  Meta,
-  Story,
   ArgsTable,
   Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
-import { Box } from "@chakra-ui/react";
 
+import { GridGaps } from "../Grid/GridTypes";
 import ProgressIndicator from "./ProgressIndicator";
 import {
   ProgressIndicatorSizes,
   ProgressIndicatorTypes,
 } from "./ProgressIndicatorTypes";
+import SimpleGrid from "../Grid/SimpleGrid";
 import { getCategory } from "../../utils/componentCategories";
 import DSProvider from "../../theme/provider";
-import SimpleGrid from "../Grid/SimpleGrid";
-import { GridGaps } from "../Grid/GridTypes";
+import { getStorybookEnumValues } from "../../utils/utils";
+
+export const sizesEnumValues = getStorybookEnumValues(
+  ProgressIndicatorSizes,
+  "ProgressIndicatorSizes"
+);
+export const typesEnumValues = getStorybookEnumValues(
+  ProgressIndicatorTypes,
+  "ProgressIndicatorTypes"
+);
 
 <Meta
   title={getCategory("ProgressIndicator")}
@@ -30,7 +40,29 @@ import { GridGaps } from "../Grid/GridTypes";
     jest: ["ProgressIndicator.test.tsx"],
   }}
   argTypes={{
-    id: { table: { disable: true } },
+    darkMode: {
+      table: { defaultValue: { summary: false } },
+    },
+    id: { control: false },
+    indicatorType: {
+      control: { type: "radio" },
+      table: { defaultValue: { summary: "ProgressIndicatorTypes.Linear" } },
+      options: typesEnumValues.options,
+    },
+    isIndeterminate: {
+      table: { defaultValue: { summary: false } },
+    },
+    showLabel: {
+      table: { defaultValue: { summary: true } },
+    },
+    size: {
+      control: { type: "radio" },
+      table: { defaultValue: { summary: "ProgressIndicatorSizes.Default" } },
+      options: sizesEnumValues.options,
+    },
+    value: {
+      table: { defaultValue: { summary: 0 } },
+    },
   }}
 />
 
@@ -45,22 +77,29 @@ import { GridGaps } from "../Grid/GridTypes";
 
 <Canvas withToolbar>
   <Story
-    name="Basic with props"
+    name="ProgressIndicator with Controls"
     args={{
       darkMode: false,
-      indicatorType: ProgressIndicatorTypes.Linear,
+      id: "progressIndicator-id",
+      indicatorType: "ProgressIndicatorTypes.Linear",
       isIndeterminate: false,
       labelText: "Progress",
       showLabel: true,
-      size: ProgressIndicatorSizes.Default,
+      size: "ProgressIndicatorSizes.Default",
       value: 50,
     }}
   >
-    {(args) => <ProgressIndicator {...args} />}
+    {(args) => (
+      <ProgressIndicator
+        {...args}
+        indicatorType={typesEnumValues.getValue(args.indicatorType)}
+        size={sizesEnumValues.getValue(args.size)}
+      />
+    )}
   </Story>
 </Canvas>
 
-<ArgsTable story="Basic with props" />
+<ArgsTable story="ProgressIndicator with Controls" />
 
 ## Linear Type
 
@@ -70,20 +109,15 @@ dialogs, etc.
 <Canvas>
   <Story
     name="Linear Type"
-    args={{
-      darkMode: false,
-      indicatorType: ProgressIndicatorTypes.Linear,
-      isIndeterminate: false,
-      labelText: "Linear Progress Type",
-      showLabel: true,
-      size: ProgressIndicatorSizes.Default,
-      value: 50,
-    }}
     argTypes={{
       indicatorType: { table: { disable: true } },
     }}
   >
-    {(args) => <ProgressIndicator {...args} />}
+    <ProgressIndicator
+      indicatorType={ProgressIndicatorTypes.Linear}
+      labelText="Linear Progress Type"
+      value={50}
+    />
   </Story>
 </Canvas>
 
@@ -96,20 +130,15 @@ full-screen loading. Set the `indicatorType` prop to
 <Canvas>
   <Story
     name="Circular Type"
-    args={{
-      darkMode: false,
-      indicatorType: ProgressIndicatorTypes.Circular,
-      isIndeterminate: false,
-      labelText: "Circular Progress Type",
-      showLabel: true,
-      size: ProgressIndicatorSizes.Default,
-      value: 50,
-    }}
     argTypes={{
       indicatorType: { table: { disable: true } },
     }}
   >
-    {(args) => <ProgressIndicator {...args} />}
+    <ProgressIndicator
+      indicatorType={ProgressIndicatorTypes.Circular}
+      labelText="Linear Progress Type"
+      value={50}
+    />
   </Story>
 </Canvas>
 
@@ -145,13 +174,13 @@ percentage will not displayed.
   <DSProvider>
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator
-        labelText="Default 48px size"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Default 48px size"
         value={50}
       />
       <ProgressIndicator
-        labelText="Small 24px size"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Small 24px size"
         size={ProgressIndicatorSizes.Small}
         value={50}
       />
@@ -174,14 +203,14 @@ the progress element to provide a description of the progress for screen readers
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator
         labelText="This label will be added through aria-label"
-        value={50}
         showLabel={false}
+        value={50}
       />
       <ProgressIndicator
-        labelText="This label will be added through aria-label"
         indicatorType={ProgressIndicatorTypes.Circular}
-        value={50}
+        labelText="This label will be added through aria-label"
         showLabel={false}
+        value={50}
       />
     </SimpleGrid>
   </DSProvider>
@@ -197,14 +226,14 @@ exact value or progress of the task is unknown.
   <DSProvider>
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator
-        labelText="Indeterminate state"
         isIndeterminate
+        labelText="Indeterminate state"
         value={50}
       />
       <ProgressIndicator
-        labelText="Indeterminate state"
         indicatorType={ProgressIndicatorTypes.Circular}
         isIndeterminate
+        labelText="Indeterminate state"
         value={50}
       />
     </SimpleGrid>
@@ -224,10 +253,10 @@ Note: the background is manually set to better showcase the `darkMode` prop.
       <SimpleGrid columns={1} gap={GridGaps.Medium}>
         <ProgressIndicator labelText="Dark Mode" value={50} darkMode />
         <ProgressIndicator
-          labelText="Dark Mode"
+          darkMode
           indicatorType={ProgressIndicatorTypes.Circular}
+          labelText="Dark Mode"
           value={50}
-          darkMode
         />
       </SimpleGrid>
     </Box>
@@ -255,8 +284,8 @@ function ProgressIndicatorExample() {
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator labelText="Progress example" value={value} />
       <ProgressIndicator
-        labelText="Progress example"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Progress example"
         value={value}
       />
     </SimpleGrid>
@@ -276,8 +305,8 @@ export function ProgressIndicatorExample() {
     <SimpleGrid columns={1} gap={GridGaps.Medium}>
       <ProgressIndicator labelText="Progress example" value={value} />
       <ProgressIndicator
-        labelText="Progress example"
         indicatorType={ProgressIndicatorTypes.Circular}
+        labelText="Progress example"
         value={value}
       />
     </SimpleGrid>

package/src/components/Radio/Radio.stories.mdx

@@ -1,16 +1,16 @@
+import { HStack } from "@chakra-ui/react";
 import {
-  Meta,
-  Story,
-  Canvas,
   ArgsTable,
+  Canvas,
   Description,
+  Meta,
+  Story,
 } from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
-import { HStack } from "@chakra-ui/react";
 
+import Radio from "./Radio";
 import { getCategory } from "../../utils/componentCategories";
 import DSProvider from "../../theme/provider";
-import Radio from "./Radio";
 
 <Meta
   title={getCategory("Radio")}
@@ -19,16 +19,32 @@ import Radio from "./Radio";
   parameters={{
     design: {
       type: "figma",
-      url:
-        "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=11895%3A742",
+      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=11895%3A742",
     },
     jest: ["Radio.test.tsx"],
   }}
   argTypes={{
-    className: { table: { disable: true } },
-    id: { table: { disable: true } },
-    isChecked: { table: { disable: true } },
-    onChange: { table: { disable: true } },
+    className: { control: false },
+    id: { control: false },
+    isChecked: { control: false },
+    isDisabled: {
+      table: { defaultValue: { summary: false } },
+    },
+    isInvalid: {
+      table: { defaultValue: { summary: false } },
+    },
+    isRequired: {
+      table: { defaultValue: { summary: false } },
+    },
+    key: { table: { disable: true } },
+    onChange: { control: false },
+    ref: { table: { disable: true } },
+    showHelperInvalidText: {
+      table: { defaultValue: { summary: true } },
+    },
+    showLabel: {
+      table: { defaultValue: { summary: true } },
+    },
   }}
 />
 
@@ -37,7 +53,7 @@ import Radio from "./Radio";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.22.0`   |
-| Latest            | `0.25.0`   |
+| Latest            | `0.25.10`  |
 
 <Description of={Radio} />
 
@@ -50,16 +66,20 @@ component will handle all the states and data management.
   <Story
     name="Radio"
     args={{
+      className: undefined,
+      helperText: "This is the helper text!",
+      id: "radio-id",
+      invalidText: "This is the error text :(",
+      isChecked: undefined,
+      isDisabled: false,
+      isInvalid: false,
+      isRequired: false,
       labelText: "Test Label",
-      showLabel: true,
-      id: "test_id",
       name: "test_name",
+      onChange: undefined,
+      showHelperInvalidText: true,
+      showLabel: true,
       value: "1",
-      isDisabled: false,
-      isRequired: false,
-      isInvalid: false,
-      helperText: "This is the helper text!",
-      invalidText: "This is the error text :(",
     }}
   >
     {(args) => <Radio {...args} />}

package/src/components/Radio/Radio.tsx

@@ -5,20 +5,22 @@ import {
   useMultiStyleConfig,
 } from "@chakra-ui/react";
 
+import HelperErrorText, {
+  HelperErrorTextType,
+} from "../HelperErrorText/HelperErrorText";
 import generateUUID from "../../helpers/generateUUID";
-import HelperErrorText from "../HelperErrorText/HelperErrorText";
 
 export interface RadioProps {
   /** Additional class name. */
   className?: string;
-  /** Optional string to populate the HelperErrorText for the error state
-   * when `isInvalid` is true.
-   */
-  invalidText?: string;
   /** Optional string to populate the HelperErrorText for the standard state. */
-  helperText?: string;
+  helperText?: HelperErrorTextType;
   /** ID that other components can cross reference for accessibility purposes */
   id?: string;
+  /** Optional string to populate the HelperErrorText for the error state
+   * when `isInvalid` is true.
+   */
+  invalidText?: HelperErrorTextType;
   /** When using the Radio as a "controlled" form element, you can specify the
    * `Radio`'s checked state using this prop. You must also pass an onChange prop.
    * Learn more about controlled and uncontrolled form fields: https://goshakkk.name/controlled-vs-uncontrolled-inputs-react/ */
@@ -100,9 +102,11 @@ const Radio = React.forwardRef<HTMLInputElement, RadioProps>((props, ref?) => {
       </ChakraRadio>
       {footnote && showHelperInvalidText && (
         <Box __css={styles.helper} aria-disabled={isDisabled}>
-          <HelperErrorText isInvalid={isInvalid} id={`${id}-helperText`}>
-            {footnote}
-          </HelperErrorText>
+          <HelperErrorText
+            id={`${id}-helperText`}
+            isInvalid={isInvalid}
+            text={footnote}
+          />
         </Box>
       )}
     </>