@nypl/design-system-react-components 0.25.0 → 0.25.1

package/src/components/CheckboxGroup/CheckboxGroup.test.tsx

@@ -0,0 +1,345 @@
+import * as React from "react";
+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 CheckboxGroup from "./CheckboxGroup";
+import Checkbox from "../Checkbox/Checkbox";
+import { CheckboxGroupLayoutTypes } from "./CheckboxGroupLayoutTypes";
+import userEvent from "@testing-library/user-event";
+
+describe("Checkbox Accessibility", () => {
+  it("passes axe accessibility", async () => {
+    const { container } = render(
+      <CheckboxGroup labelText="CheckboxGroup example" name="a11y-test">
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+        <Checkbox value="5" labelText="Checkbox 5" />
+      </CheckboxGroup>
+    );
+    expect(await axe(container)).toHaveNoViolations();
+  });
+});
+
+describe("Checkbox", () => {
+  it("renders with Checkbox inputs and a label", () => {
+    render(
+      <CheckboxGroup labelText="Test Label" name="test1">
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    expect(screen.getByText(/Test Label/i)).toBeInTheDocument();
+    expect(screen.getAllByRole("checkbox")).toHaveLength(3);
+    expect(screen.getByLabelText("Checkbox 2")).toBeInTheDocument();
+    expect(screen.getByLabelText("Checkbox 3")).toBeInTheDocument();
+    expect(screen.getByLabelText("Checkbox 4")).toBeInTheDocument();
+  });
+
+  it("renders with appropriate 'aria-label' attribute and value when 'showLabel' prop is set to false", () => {
+    const { rerender } = render(
+      <CheckboxGroup labelText="Test Label" name="test2">
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    expect(screen.getByTestId("checkbox-group")).not.toHaveAttribute(
+      "aria-label",
+      "Test Label"
+    );
+
+    rerender(
+      <CheckboxGroup labelText="Test Label" name="test2" showLabel={false}>
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    expect(screen.getByTestId("checkbox-group")).toHaveAttribute(
+      "aria-label",
+      "Test Label"
+    );
+  });
+
+  it("renders visible helper or error text", () => {
+    const { rerender } = render(
+      <CheckboxGroup
+        labelText="Test Label"
+        name="test3"
+        helperText="This is the helper text for the full group."
+        invalidText="This is the error text :("
+      >
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    expect(
+      screen.getByText("This is the helper text for the full group.")
+    ).toBeVisible();
+    expect(
+      screen.queryByText("This is the error text :(")
+    ).not.toBeInTheDocument();
+
+    rerender(
+      <CheckboxGroup
+        labelText="Test Label"
+        name="test3"
+        helperText="This is the helper text for the full group."
+        invalidText="This is the error text :("
+        isInvalid
+      >
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    expect(screen.getByText("This is the error text :(")).toBeVisible();
+    expect(
+      screen.queryByText("This is the helper text for the full group.")
+    ).not.toBeInTheDocument();
+  });
+
+  it("sets the CheckboxGroup's ID", () => {
+    render(
+      <CheckboxGroup labelText="Test Label" name="test5" id="some-id">
+        <Checkbox value="2" labelText="Checkbox 2" />
+      </CheckboxGroup>
+    );
+
+    // The "group" role here is for the `fieldset` element.
+    expect(screen.getByRole("group")).toHaveAttribute(
+      "id",
+      "checkbox-group-some-id"
+    );
+  });
+
+  it("sets the next value through the onChange function", () => {
+    let newValue = [];
+    const onChange = (value) => {
+      newValue = value;
+    };
+    render(
+      <CheckboxGroup
+        labelText="Test Label"
+        name="getValue"
+        defaultValue={["4"]}
+        onChange={onChange}
+      >
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+
+    expect(newValue).toEqual([]);
+
+    userEvent.click(screen.getByText("Checkbox 3"));
+    // "4" was the initial selected value
+    expect(newValue).toEqual(["4", "3"]);
+    userEvent.click(screen.getByText("Checkbox 2"));
+    expect(newValue).toEqual(["4", "3", "2"]);
+    userEvent.click(screen.getByText("Checkbox 3"));
+    expect(newValue).toEqual(["4", "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(
+      <CheckboxGroup labelText="Test Label" name="test6">
+        <Checkbox value="2" labelText="Checkbox 2" />
+      </CheckboxGroup>
+    );
+    expect(generateUUIDSpy).toHaveBeenCalledTimes(1);
+  });
+
+  it("sets the 'disabled' attribute for all its Checkbox children", () => {
+    render(
+      <CheckboxGroup labelText="Test Label" name="test7" isDisabled>
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    const Checkboxes = screen.getAllByRole("checkbox");
+
+    expect(Checkboxes).toHaveLength(3);
+    expect(Checkboxes[0]).toHaveAttribute("disabled");
+    expect(Checkboxes[1]).toHaveAttribute("disabled");
+    expect(Checkboxes[2]).toHaveAttribute("disabled");
+  });
+
+  it("sets the 'required' attribute for all its Checkbox children", () => {
+    render(
+      <CheckboxGroup labelText="Test Label" name="test8" isRequired>
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    const Checkboxes = screen.getAllByRole("checkbox");
+
+    expect(Checkboxes).toHaveLength(3);
+    expect(Checkboxes[0]).toHaveAttribute("required");
+    expect(Checkboxes[1]).toHaveAttribute("required");
+    expect(Checkboxes[2]).toHaveAttribute("required");
+  });
+
+  it("sets the error state for all its Checkbox children", () => {
+    render(
+      <CheckboxGroup labelText="Test Label" name="test9" isInvalid>
+        <Checkbox value="2" labelText="Checkbox 2" />
+        <Checkbox value="3" labelText="Checkbox 3" />
+        <Checkbox value="4" labelText="Checkbox 4" />
+      </CheckboxGroup>
+    );
+    const Checkboxes = screen.getAllByRole("checkbox");
+
+    expect(Checkboxes).toHaveLength(3);
+    expect(Checkboxes[0]).toHaveAttribute("aria-invalid");
+    expect(Checkboxes[1]).toHaveAttribute("aria-invalid");
+    expect(Checkboxes[2]).toHaveAttribute("aria-invalid");
+  });
+
+  it("renders the UI snapshot correctly", () => {
+    const column = renderer
+      .create(
+        <CheckboxGroup labelText="column" name="column" id="column">
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const row = renderer
+      .create(
+        <CheckboxGroup
+          labelText="row"
+          name="row"
+          id="row"
+          layout={CheckboxGroupLayoutTypes.Row}
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const noLabel = renderer
+      .create(
+        <CheckboxGroup
+          labelText="no label"
+          name="noLabel"
+          id="noLabel"
+          showLabel={false}
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const helperText = renderer
+      .create(
+        <CheckboxGroup
+          labelText="helperText"
+          name="helperText"
+          id="helperText"
+          helperText="helper text"
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const invalidText = renderer
+      .create(
+        <CheckboxGroup
+          labelText="invalidText"
+          name="invalidText"
+          id="invalidText"
+          invalidText="error text"
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const noOptReqLabel = renderer
+      .create(
+        <CheckboxGroup
+          labelText="no optional or required label"
+          name="optReq"
+          id="optReq"
+          optReqFlag={false}
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const isRequired = renderer
+      .create(
+        <CheckboxGroup
+          labelText="required"
+          name="required"
+          id="required"
+          isRequired
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const isInvalid = renderer
+      .create(
+        <CheckboxGroup
+          labelText="invalid"
+          name="invalid"
+          id="invalid"
+          isInvalid
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+    const isDisabled = renderer
+      .create(
+        <CheckboxGroup
+          labelText="disabled"
+          name="disabled"
+          id="disabled"
+          isDisabled
+        >
+          <Checkbox value="2" labelText="Checkbox 2" />
+          <Checkbox value="3" labelText="Checkbox 3" />
+        </CheckboxGroup>
+      )
+      .toJSON();
+
+    expect(column).toMatchSnapshot();
+    expect(row).toMatchSnapshot();
+    expect(noLabel).toMatchSnapshot();
+    expect(helperText).toMatchSnapshot();
+    expect(invalidText).toMatchSnapshot();
+    expect(noOptReqLabel).toMatchSnapshot();
+    expect(isRequired).toMatchSnapshot();
+    expect(isInvalid).toMatchSnapshot();
+    expect(isDisabled).toMatchSnapshot();
+  });
+
+  it("should throw warning when a non-Checkbox component is used as a child", () => {
+    const warn = jest.spyOn(console, "warn");
+    render(
+      <CheckboxGroup labelText="wrong child!" name="wrong" id="wrong-child">
+        <p>This is wrong!</p>
+      </CheckboxGroup>
+    );
+    expect(warn).toHaveBeenCalledWith(
+      "Only `Checkbox` components are allowed inside the `CheckboxGroup` component."
+    );
+  });
+});

package/src/components/CheckboxGroup/CheckboxGroup.tsx

@@ -0,0 +1,148 @@
+import * as React from "react";
+import {
+  Box,
+  Stack,
+  CheckboxGroup as ChakraCheckboxGroup,
+  useMultiStyleConfig,
+} from "@chakra-ui/react";
+
+import HelperErrorText from "../HelperErrorText/HelperErrorText";
+import generateUUID from "../../helpers/generateUUID";
+import { spacing } from "../../theme/foundations/spacing";
+import { CheckboxGroupLayoutTypes } from "./CheckboxGroupLayoutTypes";
+import Checkbox from "../Checkbox/Checkbox";
+
+export interface CheckboxGroupProps {
+  /** Any child node passed to the component. */
+  children: React.ReactNode;
+  /** Populates the initial value of the input */
+  defaultValue?: string[];
+  /** Optional string to populate the HelperErrorText for error state */
+  invalidText?: string;
+  /** Optional string to populate the HelperErrorText for standard state */
+  helperText?: string;
+  /** ID that other components can cross reference for accessibility purposes */
+  id?: string;
+  /** Adds the 'disabled' prop to the input when true. */
+  isDisabled?: boolean;
+  /** A`dds the 'aria-invalid' attribute to the input and
+   * sets the error state when true. */
+  isInvalid?: boolean;
+  /** Adds the 'required' attribute to the input when true. */
+  isRequired?: boolean;
+  /** The checkbox group label displayed in a `legend` element if `showlabel` is
+   * true, or an "aria-label" if `showLabel` is false. */
+  labelText: string;
+  /** Renders the checkbox buttons in a row or column (default). */
+  layout?: CheckboxGroupLayoutTypes;
+  /** The `name` prop indicates the form group for all the `Checkbox` children. */
+  name: string;
+  /** The action to perform on the `<input>`'s onChange function  */
+  onChange?: (value: string[]) => void;
+  /** Whether or not to display "Required"/"Optional" in the label text. */
+  optReqFlag?: boolean;
+  /** Offers the ability to show the group's legend onscreen or hide it. Refer
+   * to the `labelText` property for more information. */
+  showLabel?: boolean;
+}
+
+const noop = () => {};
+
+/**
+ * Wrapper component to wrap `Checkbox` components. Can be displayed in a
+ * column or in a row. The `CheckboxGroup` component renders all the necessary
+ * wrapping and associated text elements, but the checkbox input elements
+ * _need_ to be child `Checkbox` components from the NYPL Design System.
+ */
+const CheckboxGroup = React.forwardRef<HTMLInputElement, CheckboxGroupProps>(
+  (props, ref?) => {
+    const {
+      children,
+      defaultValue = [],
+      invalidText,
+      helperText,
+      id = generateUUID(),
+      isDisabled = false,
+      isInvalid = false,
+      isRequired = false,
+      labelText,
+      layout = CheckboxGroupLayoutTypes.Column,
+      name,
+      onChange,
+      optReqFlag = true,
+      showLabel = true,
+    } = props;
+    const footnote = isInvalid ? invalidText : helperText;
+    const spacingProp =
+      layout === CheckboxGroupLayoutTypes.Column ? spacing.s : spacing.l;
+    const newChildren = [];
+    const checkboxProps =
+      defaultValue && onChange
+        ? {
+            defaultValue,
+            onChange,
+          }
+        : {};
+
+    // Go through the Checkbox children and update them as needed.
+    React.Children.map(children, (child: React.ReactElement, i) => {
+      if (child.type !== Checkbox) {
+        // Special case for Storybook MDX documentation.
+        if (child.props.mdxType && child.props.mdxType === "Checkbox") {
+          noop();
+        } else {
+          console.warn(
+            "Only `Checkbox` components are allowed inside the `CheckboxGroup` component."
+          );
+        }
+      }
+
+      if (child !== undefined && child !== null) {
+        const newProps = {
+          key: i,
+          id: `${id}-${i}`,
+          name,
+          isDisabled,
+          isInvalid,
+          isRequired,
+        };
+        newChildren.push(React.cloneElement(child, newProps));
+      }
+    });
+
+    // Get the Chakra-based styles for all the custom elements in this component.
+    const styles = useMultiStyleConfig("CustomCheckboxGroup", {});
+
+    return (
+      <Box as="fieldset" id={`checkbox-group-${id}`} __css={styles}>
+        <legend className={showLabel ? "" : "sr-only"}>
+          <span>{labelText}</span>
+          {optReqFlag && (
+            <Box as="span" __css={styles.required}>
+              {isRequired ? "Required" : "Optional"}
+            </Box>
+          )}
+        </legend>
+        <ChakraCheckboxGroup {...checkboxProps}>
+          <Stack
+            id={id}
+            data-testid="checkbox-group"
+            direction={[layout]}
+            spacing={spacingProp}
+            ref={ref}
+            aria-label={!showLabel ? labelText : null}
+          >
+            {newChildren}
+          </Stack>
+        </ChakraCheckboxGroup>
+        {footnote && (
+          <Box __css={styles.helper}>
+            <HelperErrorText isError={isInvalid}>{footnote}</HelperErrorText>
+          </Box>
+        )}
+      </Box>
+    );
+  }
+);
+
+export default CheckboxGroup;

package/src/components/CheckboxGroup/CheckboxGroupLayoutTypes.tsx

@@ -0,0 +1,4 @@
+export enum CheckboxGroupLayoutTypes {
+  Column = "column",
+  Row = "row",
+}