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

package/src/components/RadioGroup/RadioGroup.stories.mdx

@@ -1,17 +1,23 @@
 import {
-  Meta,
-  Story,
-  Canvas,
   ArgsTable,
+  Canvas,
   Description,
-} from "@storybook/addon-docs/blocks";
+  Meta,
+  Story,
+} from "@storybook/addon-docs";
 import { withDesign } from "storybook-addon-designs";
 
-import { getCategory } from "../../utils/componentCategories";
-import DSProvider from "../../theme/provider";
+import Radio from "../Radio/Radio";
 import RadioGroup, { onChangeDefault } from "./RadioGroup";
 import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
-import Radio from "../Radio/Radio";
+import { getCategory } from "../../utils/componentCategories";
+import DSProvider from "../../theme/provider";
+import { getStorybookEnumValues } from "../../utils/utils";
+
+export const enumValues = getStorybookEnumValues(
+  RadioGroupLayoutTypes,
+  "RadioGroupLayoutTypes"
+);
 
 <Meta
   title={getCategory("RadioGroup")}
@@ -20,16 +26,40 @@ import Radio from "../Radio/Radio";
   parameters={{
     design: {
       type: "figma",
-      url:
-        "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=11895%3A742",
+      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Main?node-id=11895%3A742",
     },
     jest: ["RadioGroup.test.tsx"],
   }}
   argTypes={{
     children: { table: { disable: true } },
-    className: { table: { disable: true } },
-    onChange: { table: { disable: true } },
-    id: { table: { disable: true } },
+    className: { control: false },
+    id: { control: false },
+    isDisabled: {
+      table: { defaultValue: { summary: false } },
+    },
+    isInvalid: {
+      table: { defaultValue: { summary: false } },
+    },
+    isRequired: {
+      table: { defaultValue: { summary: false } },
+    },
+    layout: {
+      control: { type: "select" },
+      table: { defaultValue: { summary: "RadioGroupLayoutTypes.Column" } },
+      options: enumValues.options,
+    },
+    key: { table: { disable: true } },
+    onChange: { control: false },
+    ref: { table: { disable: true } },
+    optReqFlag: {
+      table: { defaultValue: { summary: true } },
+    },
+    showHelperInvalidText: {
+      table: { defaultValue: { summary: true } },
+    },
+    showLabel: {
+      table: { defaultValue: { summary: true } },
+    },
   }}
 />
 
@@ -38,7 +68,7 @@ import Radio from "../Radio/Radio";
 | Component Version | DS Version |
 | ----------------- | ---------- |
 | Added             | `0.25.0`   |
-| Latest            | `0.25.3`   |
+| Latest            | `0.25.10`  |
 
 <Description of={RadioGroup} />
 
@@ -46,21 +76,25 @@ import Radio from "../Radio/Radio";
   <Story
     name="RadioGroup"
     args={{
+      className: undefined,
       defaultValue: "4",
-      invalidText: "error!",
       helperText: "This is the helper text for the full group.",
+      id: "radioGroup-id",
+      invalidText: "error!",
       isDisabled: false,
       isInvalid: false,
       isRequired: false,
       labelText: "Standard Radio Group",
-      layout: RadioGroupLayoutTypes.Column,
+      layout: "RadioGroupLayoutTypes.Column",
       name: "radio-story",
+      onChange: undefined,
       optReqFlag: true,
+      showHelperInvalidText: true,
       showLabel: true,
     }}
   >
     {(args) => (
-      <RadioGroup {...args}>
+      <RadioGroup {...args} layout={enumValues.getValue(args.layout)}>
         <Radio value="2" labelText="Radio 2" />
         <Radio value="3" labelText="Radio 3" />
         <Radio value="4" labelText="Radio 4" />

package/src/components/RadioGroup/RadioGroup.test.tsx

@@ -3,7 +3,7 @@ import { render, screen } from "@testing-library/react";
 import { axe } from "jest-axe";
 import renderer from "react-test-renderer";
 
-import * as generateUUID from "../../helpers/generateUUID";
+// import * as generateUUID from "../../helpers/generateUUID";
 import RadioGroup from "./RadioGroup";
 import Radio from "../Radio/Radio";
 import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
@@ -131,16 +131,18 @@ describe("Radio Button", () => {
     expect(newValue).toEqual("2");
   });
 
-  it("calls the UUID generation function if no id prop value is passed", () => {
-    const generateUUIDSpy = jest.spyOn(generateUUID, "default");
-    expect(generateUUIDSpy).toHaveBeenCalledTimes(0);
-    render(
-      <RadioGroup labelText="Test Label" name="test6">
-        <Radio value="2" labelText="Radio 2" id="radio2" />
-      </RadioGroup>
-    );
-    expect(generateUUIDSpy).toHaveBeenCalledTimes(1);
-  });
+  // TODO: Figure out why this renders twice with two different calls
+  // to the render function.
+  // it("calls the UUID generation function if no id prop value is passed", () => {
+  //   const generateUUIDSpy = jest.spyOn(generateUUID, "default");
+  //   expect(generateUUIDSpy).toHaveBeenCalledTimes(0);
+  //   render(
+  //     <RadioGroup labelText="Test Label" name="test6">
+  //       <Radio value="2" labelText="Radio 2" id="radio2" />
+  //     </RadioGroup>
+  //   );
+  //   expect(generateUUIDSpy).toHaveBeenCalledTimes(1);
+  // });
 
   it("sets the 'disabled' attribute for all its Radio children", () => {
     render(

package/src/components/RadioGroup/RadioGroup.tsx

@@ -1,31 +1,31 @@
-import * as React from "react";
 import {
   Box,
   Stack,
   useMultiStyleConfig,
   useRadioGroup,
 } from "@chakra-ui/react";
+import * as React from "react";
 
-import HelperErrorText from "../HelperErrorText/HelperErrorText";
-import generateUUID from "../../helpers/generateUUID";
+import Fieldset from "../Fieldset/Fieldset";
+import HelperErrorText, {
+  HelperErrorTextType,
+} from "../HelperErrorText/HelperErrorText";
 import { spacing } from "../../theme/foundations/spacing";
-import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
 import Radio from "../Radio/Radio";
-import Fieldset from "../Fieldset/Fieldset";
+import { RadioGroupLayoutTypes } from "./RadioGroupLayoutTypes";
+import generateUUID from "../../helpers/generateUUID";
 
 export interface RadioGroupProps {
-  /** Any child node passed to the component. */
-  children: React.ReactNode;
   /** Additional class name. */
   className?: string;
   /** Populates the initial value of the input */
   defaultValue?: string;
   /** Optional string to populate the HelperErrorText for 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 error state */
-  invalidText?: string;
+  invalidText?: HelperErrorTextType;
   /** Adds the 'disabled' prop to the input when true. */
   isDisabled?: boolean;
   /** Adds the 'aria-invalid' attribute to the input and
@@ -56,99 +56,102 @@ export const onChangeDefault = () => {
   return;
 };
 
-const RadioGroup = React.forwardRef<HTMLInputElement, RadioGroupProps>(
-  (props, ref?) => {
-    const {
-      children,
-      className = "",
-      defaultValue,
-      helperText,
-      id = generateUUID(),
-      invalidText,
-      isDisabled = false,
-      isInvalid = false,
-      isRequired = false,
-      labelText,
-      layout = RadioGroupLayoutTypes.Column,
-      name,
-      onChange = onChangeDefault,
-      optReqFlag = true,
-      showHelperInvalidText = true,
-      showLabel = true,
-    } = props;
-    const footnote = isInvalid ? invalidText : helperText;
-    const spacingProp =
-      layout === RadioGroupLayoutTypes.Column ? spacing.s : spacing.l;
-    const newChildren = [];
+const RadioGroup = React.forwardRef<
+  HTMLInputElement,
+  React.PropsWithChildren<RadioGroupProps>
+>((props, ref?) => {
+  const {
+    children,
+    className = "",
+    defaultValue,
+    helperText,
+    id = generateUUID(),
+    invalidText,
+    isDisabled = false,
+    isInvalid = false,
+    isRequired = false,
+    labelText,
+    layout = RadioGroupLayoutTypes.Column,
+    name,
+    onChange = onChangeDefault,
+    optReqFlag = true,
+    showHelperInvalidText = true,
+    showLabel = true,
+  } = props;
+  const footnote: HelperErrorTextType = isInvalid ? invalidText : helperText;
+  const spacingProp =
+    layout === RadioGroupLayoutTypes.Column ? spacing.s : spacing.l;
+  const newChildren = [];
 
-    // Use Chakra's RadioGroup hook to set and get the proper props
-    // or the custom components.
-    const { getRootProps, getRadioProps } = useRadioGroup({
-      name,
-      defaultValue,
-      onChange,
-    });
-    const radioGroupProps = getRootProps();
+  // Use Chakra's RadioGroup hook to set and get the proper props
+  // or the custom components.
+  const { getRootProps, getRadioProps } = useRadioGroup({
+    name,
+    defaultValue,
+    onChange,
+  });
+  const radioGroupProps = getRootProps();
 
-    // Go through the Radio children and update them as needed.
-    React.Children.map(children, (child: React.ReactElement, i) => {
-      if (child.type !== Radio) {
-        // Special case for Storybook MDX documentation.
-        if (child.props.mdxType && child.props.mdxType === "Radio") {
-          noop();
-        } else {
-          console.warn(
-            "Only `Radio` components are allowed inside the `RadioGroup` component."
-          );
-        }
+  // Go through the Radio children and update them as needed.
+  React.Children.map(children, (child: React.ReactElement, i) => {
+    if (child.type !== Radio) {
+      // Special case for Storybook MDX documentation.
+      if (child.props.mdxType && child.props.mdxType === "Radio") {
+        noop();
+      } else {
+        console.warn(
+          "Only `Radio` components are allowed inside the `RadioGroup` component."
+        );
       }
+    }
 
-      const chakraRadioProps = getRadioProps({
-        value: child.props.value,
-      } as any);
+    const chakraRadioProps = getRadioProps({
+      value: child.props.value,
+    } as any);
 
-      if (child !== undefined && child !== null) {
-        const newProps = { key: i, isDisabled, isInvalid, isRequired };
-        if (child.props.value === defaultValue) {
-          newProps["checked"] = true;
-        }
-        newChildren.push(
-          React.cloneElement(child, { ...newProps, ...chakraRadioProps })
-        );
+    if (child !== undefined && child !== null) {
+      const newProps = { key: i, isDisabled, isInvalid, isRequired };
+      if (child.props.value === defaultValue) {
+        newProps["checked"] = true;
       }
-    });
+      newChildren.push(
+        React.cloneElement(child, { ...newProps, ...chakraRadioProps })
+      );
+    }
+  });
 
-    // Get the Chakra-based styles for the custom elements in this component.
-    const styles = useMultiStyleConfig("RadioGroup", {});
+  // Get the Chakra-based styles for the custom elements in this component.
+  const styles = useMultiStyleConfig("RadioGroup", {});
 
-    return (
-      <Fieldset
-        id={`radio-group-${id}`}
-        className={className}
-        isLegendHidden={!showLabel}
-        legendText={labelText}
-        optReqFlag={optReqFlag}
+  return (
+    <Fieldset
+      className={className}
+      id={`radio-group-${id}`}
+      isLegendHidden={!showLabel}
+      legendText={labelText}
+      optReqFlag={optReqFlag}
+    >
+      <Stack
+        aria-label={!showLabel ? labelText : null}
+        direction={[layout]}
+        spacing={spacingProp}
+        ref={ref}
+        {...radioGroupProps}
+        sx={styles.stack}
       >
-        <Stack
-          direction={[layout]}
-          spacing={spacingProp}
-          ref={ref}
-          aria-label={!showLabel ? labelText : null}
-          {...radioGroupProps}
-          sx={styles.stack}
-        >
-          {newChildren}
-        </Stack>
-        {footnote && showHelperInvalidText && (
-          <Box __css={styles.helper}>
-            <HelperErrorText isInvalid={isInvalid} id={`${id}-helperErrorText`}>
-              {footnote}
-            </HelperErrorText>
-          </Box>
-        )}
-      </Fieldset>
-    );
-  }
-);
+        {newChildren}
+      </Stack>
+      {footnote && showHelperInvalidText && (
+        <Box __css={styles.helper}>
+          <HelperErrorText
+            id={`${id}-helperErrorText`}
+            isInvalid={isInvalid}
+            text={footnote}
+          />
+        </Box>
+      )}
+    </Fieldset>
+  );
+});
 
 export default RadioGroup;

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

@@ -19,7 +19,7 @@ exports[`Radio Button renders the UI snapshot correctly 1`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -66,7 +66,7 @@ exports[`Radio Button renders the UI snapshot correctly 1`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -135,7 +135,7 @@ exports[`Radio Button renders the UI snapshot correctly 2`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -182,7 +182,7 @@ exports[`Radio Button renders the UI snapshot correctly 2`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -251,7 +251,7 @@ exports[`Radio Button renders the UI snapshot correctly 3`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -298,7 +298,7 @@ exports[`Radio Button renders the UI snapshot correctly 3`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -367,7 +367,7 @@ exports[`Radio Button renders the UI snapshot correctly 4`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -414,7 +414,7 @@ exports[`Radio Button renders the UI snapshot correctly 4`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -468,11 +468,14 @@ exports[`Radio Button renders the UI snapshot correctly 4`] = `
       aria-atomic={true}
       aria-live="off"
       className=" css-0"
+      dangerouslySetInnerHTML={
+        Object {
+          "__html": "helper text",
+        }
+      }
       data-isinvalid={false}
       id="helperText-helperErrorText"
-    >
-      helper text
-    </div>
+    />
   </div>
 </fieldset>
 `;
@@ -496,7 +499,7 @@ exports[`Radio Button renders the UI snapshot correctly 5`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -543,7 +546,7 @@ exports[`Radio Button renders the UI snapshot correctly 5`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -607,7 +610,7 @@ exports[`Radio Button renders the UI snapshot correctly 6`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -654,7 +657,7 @@ exports[`Radio Button renders the UI snapshot correctly 6`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         checked={false}
@@ -723,7 +726,7 @@ exports[`Radio Button renders the UI snapshot correctly 7`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         aria-required={true}
@@ -771,7 +774,7 @@ exports[`Radio Button renders the UI snapshot correctly 7`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
     >
       <input
         aria-required={true}
@@ -841,7 +844,7 @@ exports[`Radio Button renders the UI snapshot correctly 8`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
       data-invalid=""
     >
       <input
@@ -892,7 +895,7 @@ exports[`Radio Button renders the UI snapshot correctly 8`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
       data-invalid=""
     >
       <input
@@ -965,7 +968,7 @@ exports[`Radio Button renders the UI snapshot correctly 9`] = `
     role="radiogroup"
   >
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
       data-disabled=""
     >
       <input
@@ -1016,7 +1019,7 @@ exports[`Radio Button renders the UI snapshot correctly 9`] = `
       </span>
     </label>
     <label
-      className="chakra-radio css-78joka"
+      className="chakra-radio css-1pw4d56"
       data-disabled=""
     >
       <input