@nypl/design-system-react-components 1.0.2 → 1.0.4

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

@@ -1,492 +0,0 @@
-import { Flex, Spacer } from "@chakra-ui/react";
-import { render, screen } from "@testing-library/react";
-import userEvent from "@testing-library/user-event";
-import { axe } from "jest-axe";
-import * as React from "react";
-import renderer from "react-test-renderer";
-
-import CheckboxGroup from "./CheckboxGroup";
-import Checkbox from "../Checkbox/Checkbox";
-
-describe("CheckboxGroup Accessibility", () => {
-  it("passes axe accessibility with string labels ", async () => {
-    const { container } = render(
-      <CheckboxGroup
-        id="checkboxGroup"
-        labelText="CheckboxGroup example"
-        name="a11y-test"
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" value="4" labelText="Checkbox 4" />
-        <Checkbox id="checkbox5" value="5" labelText="Checkbox 5" />
-      </CheckboxGroup>
-    );
-    expect(await axe(container)).toHaveNoViolations();
-  });
-  it("passes axe accessibility with jsx labels", async () => {
-    const { container } = render(
-      <CheckboxGroup
-        labelText="jsxLabels"
-        name="jsxLabels"
-        id="jsxLabels"
-        isFullWidth
-      >
-        <Checkbox
-          id="arts"
-          labelText={
-            <Flex>
-              <span>Arts</span>
-              <Spacer />
-              <span>4</span>
-            </Flex>
-          }
-          value="arts"
-        />
-        <Checkbox
-          id="English"
-          labelText={
-            <Flex>
-              <span>English</span>
-              <Spacer />
-              <span>23</span>
-            </Flex>
-          }
-          value="English"
-        />
-      </CheckboxGroup>
-    );
-    expect(await axe(container)).toHaveNoViolations();
-  });
-});
-
-describe("Checkbox", () => {
-  it("renders with Checkbox inputs and a label", () => {
-    render(
-      <CheckboxGroup id="checkboxGroup" labelText="Test Label" name="test1">
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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 id="checkboxGroup" labelText="Test Label" name="test2">
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" value="4" labelText="Checkbox 4" />
-      </CheckboxGroup>
-    );
-    expect(screen.getByTestId("checkbox-group")).not.toHaveAttribute(
-      "aria-label",
-      "Test Label"
-    );
-
-    rerender(
-      <CheckboxGroup
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test2"
-        showLabel={false}
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test3"
-        helperText="This is the helper text for the full group."
-        invalidText="This is the error text :("
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test3"
-        helperText="This is the helper text for the full group."
-        invalidText="This is the error text :("
-        isInvalid
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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 id="checkbox2" value="2" labelText="Checkbox 2" />
-      </CheckboxGroup>
-    );
-
-    // The "group" role here is for the `fieldset` element.
-    expect(screen.getByRole("group")).toHaveAttribute(
-      "id",
-      "some-id-checkbox-group"
-    );
-  });
-
-  it("sets the next value through the onChange function", () => {
-    let newValue: string[] = [];
-    const onChange = (value: string[]) => {
-      newValue = value;
-    };
-    render(
-      <CheckboxGroup
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="getValue"
-        defaultValue={["4"]}
-        onChange={onChange}
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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("sets the 'disabled' attribute for all its Checkbox children", () => {
-    render(
-      <CheckboxGroup
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test7"
-        isDisabled
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test8"
-        isRequired
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test9"
-        isInvalid
-        invalidText="There's an error!"
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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("does not render the invalid text when 'isInvalid' is true but 'showHelperInvalidText' is false", () => {
-    render(
-      <CheckboxGroup
-        id="checkboxGroup"
-        labelText="Test Label"
-        name="test9"
-        isInvalid
-        invalidText="There's an error!"
-        showHelperInvalidText={false}
-      >
-        <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-        <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        <Checkbox id="checkbox4" 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("logs a warning when there is no `id` passed", () => {
-    const warn = jest.spyOn(console, "warn");
-    render(
-      // @ts-ignore: Typescript complains when a required prop is not passed, but
-      // here we don't want to pass the required prop to make sure the warning appears.
-      <CheckboxGroup labelText="column" name="column">
-        <Checkbox id="checkbox1" value="1" labelText="Checkbox 1" />
-      </CheckboxGroup>
-    );
-    expect(warn).toHaveBeenCalledWith(
-      "NYPL Reservoir CheckboxGroup: This component's required `id` prop was not passed."
-    );
-  });
-
-  it("renders the UI snapshot correctly", () => {
-    const column = renderer
-      .create(
-        <CheckboxGroup labelText="column" name="column" id="column">
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const row = renderer
-      .create(
-        <CheckboxGroup labelText="row" name="row" id="row" layout="row">
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const noLabel = renderer
-      .create(
-        <CheckboxGroup
-          labelText="no label"
-          name="noLabel"
-          id="noLabel"
-          showLabel={false}
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const helperText = renderer
-      .create(
-        <CheckboxGroup
-          labelText="helperText"
-          name="helperText"
-          id="helperText"
-          helperText="helper text"
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const invalidText = renderer
-      .create(
-        <CheckboxGroup
-          labelText="invalidText"
-          name="invalidText"
-          id="invalidText"
-          invalidText="error text"
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const isRequired = renderer
-      .create(
-        <CheckboxGroup
-          labelText="required"
-          name="required"
-          id="required"
-          isRequired
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const noRequiredLabel = renderer
-      .create(
-        <CheckboxGroup
-          labelText="no optional or required label"
-          name="noRequiredLabel"
-          id="noRequiredLabel"
-          isRequired
-          showRequiredLabel={false}
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const isInvalid = renderer
-      .create(
-        <CheckboxGroup
-          labelText="invalid"
-          name="invalid"
-          id="invalid"
-          isInvalid
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const isDisabled = renderer
-      .create(
-        <CheckboxGroup
-          labelText="disabled"
-          name="disabled"
-          id="disabled"
-          isDisabled
-        >
-          <Checkbox id="checkbox2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="checkbox3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const withJSXCheckboxLabels = renderer
-      .create(
-        <CheckboxGroup
-          id="jsxLabels"
-          isFullWidth
-          labelText="jsxLabels"
-          name="jsxLabels"
-        >
-          <Checkbox
-            id="arts"
-            labelText={
-              <Flex>
-                <span>Arts</span>
-                <Spacer />
-                <span>4</span>
-              </Flex>
-            }
-            value="arts"
-          />
-          <Checkbox
-            id="English"
-            labelText={
-              <Flex>
-                <span>English</span>
-                <Spacer />
-                <span>23</span>
-              </Flex>
-            }
-            value="English"
-          />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const withChakraProps = renderer
-      .create(
-        <CheckboxGroup
-          labelText="chakraProps"
-          name="chakraProps"
-          id="chakraProps"
-          p="s"
-          color="ui.error.primary"
-        >
-          <Checkbox id="2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-    const withOtherProps = renderer
-      .create(
-        <CheckboxGroup
-          labelText="otherProps"
-          name="otherProps"
-          id="otherProps"
-          data-testid="props"
-        >
-          <Checkbox id="2" value="2" labelText="Checkbox 2" />
-          <Checkbox id="3" value="3" labelText="Checkbox 3" />
-        </CheckboxGroup>
-      )
-      .toJSON();
-
-    expect(column).toMatchSnapshot();
-    expect(row).toMatchSnapshot();
-    expect(noLabel).toMatchSnapshot();
-    expect(helperText).toMatchSnapshot();
-    expect(invalidText).toMatchSnapshot();
-    expect(noRequiredLabel).toMatchSnapshot();
-    expect(isRequired).toMatchSnapshot();
-    expect(isInvalid).toMatchSnapshot();
-    expect(isDisabled).toMatchSnapshot();
-    expect(withJSXCheckboxLabels).toMatchSnapshot();
-    expect(withChakraProps).toMatchSnapshot();
-    expect(withOtherProps).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(
-      "NYPL Reservoir CheckboxGroup: Only `Checkbox` components are " +
-        "allowed as children."
-    );
-  });
-});

package/src/components/CheckboxGroup/CheckboxGroup.tsx

@@ -1,173 +0,0 @@
-import {
-  chakra,
-  CheckboxGroup as ChakraCheckboxGroup,
-  Stack,
-  useMultiStyleConfig,
-} from "@chakra-ui/react";
-import * as React from "react";
-
-import Checkbox from "../Checkbox/Checkbox";
-import Fieldset from "../Fieldset/Fieldset";
-import HelperErrorText, {
-  HelperErrorTextType,
-} from "../HelperErrorText/HelperErrorText";
-import { LayoutTypes } from "../../helpers/types";
-import { spacing } from "../../theme/foundations/spacing";
-
-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 standard state */
-  helperText?: HelperErrorTextType;
-  /** ID that other components can cross reference for accessibility purposes */
-  id: string;
-  /** Optional string to populate the HelperErrorText for error state */
-  invalidText?: HelperErrorTextType;
-  /** Adds the 'disabled' prop to the input when true. */
-  isDisabled?: boolean;
-  /** Set's the `Checkbox`s' wrapper to be full width. */
-  isFullWidth?: 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?: LayoutTypes;
-  /** 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;
-  /** Offers the ability to hide the helper/invalid text. */
-  showHelperInvalidText?: boolean;
-  /** Offers the ability to show the group's legend onscreen or hide it. Refer
-   * to the `labelText` property for more information. */
-  showLabel?: boolean;
-  /** Whether or not to display the "(Required)" text in the label text.
-   * True by default. */
-  showRequiredLabel?: 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.
- */
-export const CheckboxGroup = chakra(
-  React.forwardRef<HTMLInputElement, CheckboxGroupProps>((props, ref?) => {
-    const {
-      children,
-      defaultValue = [],
-      helperText,
-      id,
-      invalidText,
-      isDisabled = false,
-      isFullWidth = false,
-      isInvalid = false,
-      isRequired = false,
-      labelText,
-      layout = "column",
-      name,
-      onChange,
-      showHelperInvalidText = true,
-      showLabel = true,
-      showRequiredLabel = true,
-      ...rest
-    } = props;
-    const footnote = isInvalid ? invalidText : helperText;
-    const newChildren: JSX.Element[] = [];
-    const spacingProp =
-      layout === "column"
-        ? spacing.input.group.default.vstack
-        : spacing.input.group.default.hstack;
-    const checkboxProps =
-      defaultValue && onChange
-        ? {
-            defaultValue,
-            onChange,
-          }
-        : {};
-
-    if (!id) {
-      console.warn(
-        "NYPL Reservoir CheckboxGroup: This component's required `id` prop was not passed."
-      );
-    }
-
-    // Go through the Checkbox children and update them as needed.
-    React.Children.map(
-      children as JSX.Element,
-      (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(
-              "NYPL Reservoir CheckboxGroup: Only `Checkbox` components are " +
-                "allowed as children."
-            );
-          }
-        }
-
-        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 the custom elements in this component.
-    const styles = useMultiStyleConfig("CheckboxGroup", { isFullWidth });
-
-    return (
-      <Fieldset
-        id={`${id}-checkbox-group`}
-        isLegendHidden={!showLabel}
-        isRequired={isRequired}
-        legendText={labelText}
-        showRequiredLabel={showRequiredLabel}
-        {...rest}
-        __css={styles}
-      >
-        <ChakraCheckboxGroup {...checkboxProps}>
-          <Stack
-            id={id}
-            data-testid="checkbox-group"
-            direction={[layout]}
-            spacing={spacingProp}
-            ref={ref}
-            aria-label={!showLabel ? labelText : undefined}
-          >
-            {newChildren}
-          </Stack>
-        </ChakraCheckboxGroup>
-        {footnote && showHelperInvalidText && (
-          <HelperErrorText
-            id={`${id}-helperErrorText`}
-            isInvalid={isInvalid}
-            text={footnote}
-            __css={styles.helperErrorText}
-          />
-        )}
-      </Fieldset>
-    );
-  })
-);
-
-export default CheckboxGroup;