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

package/src/components/TextInput/TextInput.stories.mdx

@@ -1,268 +0,0 @@
-import { VStack } from "@chakra-ui/react";
-import {
-  ArgsTable,
-  Canvas,
-  Description,
-  Meta,
-  Story,
-} from "@storybook/addon-docs";
-import { withDesign } from "storybook-addon-designs";
-
-import TextInput from "./TextInput";
-import { getCategory } from "../../utils/componentCategories";
-import DSProvider from "../../theme/provider";
-
-<Meta
-  title={getCategory("TextInput")}
-  component={TextInput}
-  decorators={[withDesign]}
-  parameters={{
-    design: {
-      type: "figma",
-      url: "https://www.figma.com/file/qShodlfNCJHb8n03IFyApM/Master?node-id=11895%3A547",
-    },
-    jest: ["TextInput.test.tsx"],
-  }}
-  argTypes={{
-    id: { 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 } } },
-    showRequiredLabel: { table: { defaultValue: { summary: true } } },
-    step: { table: { defaultValue: { summary: 1 } } },
-    textInputType: {
-      control: false,
-      table: { defaultValue: { summary: "default" } },
-    },
-    type: {
-      table: { defaultValue: { summary: "text" } },
-    },
-    value: { control: false },
-  }}
-/>
-
-# TextInput
-
-| Component Version | DS Version |
-| ----------------- | ---------- |
-| Added             | `0.22.0`   |
-| Latest            | `1.0.2`    |
-
-## Table of Contents
-
-- [Overview](#overview)
-- [Component Props](#component-props)
-- [Accessibility](#accessibility)
-- [Labelling Variations](#labelling-variations)
-- [HTML in Helper Text](#html-in-helper-text)
-- [Textarea](#textarea)
-
-## Overview
-
-<Description of={TextInput} />
-
-This component renders a text input form element. See below for configuration
-information. For optimal accessibility, the `labelText` property is a required
-prop, regardless of the label visibility. Additionally, while the `id` prop is
-optional, a unique `id` attribute is necessary for accessibility. If the prop
-is left blank, a value will be generated for you.
-
-## Component Props
-
-<Canvas withToolbar>
-  <Story
-    name="TextInput with Controls"
-    args={{
-      className: undefined,
-      defaultValue: undefined,
-      helperText: "Choose wisely.",
-      id: "textInput-id",
-      invalidText: "This is error text :(",
-      isDisabled: false,
-      isInvalid: false,
-      isRequired: true,
-      labelText: "What is your favorite color?",
-      name: undefined,
-      onChange: undefined,
-      placeholder: "e.g. blue, green, etc.",
-      showHelperInvalidText: true,
-      showLabel: true,
-      showRequiredLabel: true,
-      step: 1,
-      type: "text",
-      value: undefined,
-      textInputType: "default",
-    }}
-  >
-    {(args) => <TextInput {...args} />}
-  </Story>
-</Canvas>
-
-<ArgsTable story="TextInput with Controls" />
-
-## Accessibility
-
-The `TextInput` component renders an HTML `<input>` element which is accessible
-via keyboard and screen reader. The `aria-required` and `required` attributes are
-set with the `isRequired` prop. The `aria-disabled` and `disabled` attributes are
-set with the `isDisabled` prop. The `aria-invalid` is set with the `isInvalid`
-prop.
-
-Internally, a `Label` is associated with the `<input>` element. When `showLabel`
-is set to false, the `<input>` element's `aria-label` attribute is set to the
-required `labelText` value.
-
-When the `type` prop is set to `"textarea"`, the `<textarea>` element
-is rendered instead of the `<input>` element. This element follows all the same
-accessibility rules described above.
-
-Resources:
-
-- [MDN input: The Input (Form Input) element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input)
-- [MDN textarea: The Textarea element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea)
-- [Chakra UI Input](https://chakra-ui.com/docs/components/form/input)
-- [Chakra UI Textarea](https://chakra-ui.com/docs/components/form/textarea)
-
-## Labelling Variations
-
-A TextInput can be rendered with or without visible labels. When `showLabel` is
-set to `false`, an `aria-label` attribute is added to the input/textarea element
-to maintain accessibility. If the component needs to be required, the
-`showRequiredLabel` prop can be used to show or hide the "(Required)" text
-within the `label` element.
-
-<Canvas withToolbar>
-  <Story name="Labelling Variations">
-    <VStack align="stretch" spacing={12}>
-      <TextInput
-        helperText="Choose wisely!"
-        id="textInput-1"
-        labelText="What is your favorite color?"
-        placeholder="i.e. blue, green, etc."
-      />
-      <TextInput
-        id="textInput-2"
-        labelText="What is your favorite color?"
-        placeholder="i.e. blue, green, etc."
-        showLabel={false}
-      />
-      <TextInput
-        id="textInput-3"
-        isRequired
-        labelText="What is your favorite color?"
-        placeholder="i.e. blue, green, etc."
-      />
-      <TextInput
-        id="textInput-4"
-        isRequired
-        labelText="What is your favorite color?"
-        placeholder="i.e. blue, green, etc."
-        showRequiredLabel={false}
-      />
-      <TextInput
-        helperText="Choose wisely!"
-        id="textInput-5"
-        labelText="What is your favorite color?"
-        placeholder="i.e. blue, green, etc."
-        showLabel={false}
-      />
-    </VStack>
-  </Story>
-</Canvas>
-
-### Errored
-
-<Canvas>
-  <DSProvider>
-    <TextInput
-      helperText="Choose wisely!"
-      id="errored"
-      invalidText="This is error text :("
-      isInvalid
-      labelText="What is your favorite color?"
-      placeholder="i.e. blue, green, etc."
-    />
-  </DSProvider>
-</Canvas>
-
-### Disabled
-
-<Canvas>
-  <DSProvider>
-    <TextInput
-      helperText="Choose wisely!"
-      id="disabled"
-      isDisabled
-      labelText="What is your favorite color?"
-      placeholder="i.e. blue, green, etc."
-    />
-  </DSProvider>
-</Canvas>
-
-## HTML in Helper Text
-
-HTML can be passed into the `helperText` prop as a string or HTML.
-
-```jsx
-helperText="Choose <b>wisely!</b>"
-// or
-helperText={<>Choose <b>wisely!</b></>}
-```
-
-<Canvas>
-  <DSProvider>
-    <TextInput
-      helperText="Choose <b>wisely!</b>"
-      id="string"
-      labelText="What is your favorite color?"
-      placeholder="i.e. blue, green, etc."
-    />
-    <br />
-    <TextInput
-      helperText={
-        <>
-          Choose <b>wisely!</b>
-        </>
-      }
-      id="jsx"
-      labelText="What is your favorite color?"
-      placeholder="i.e. blue, green, etc."
-    />
-  </DSProvider>
-</Canvas>
-
-## Textarea
-
-The TextInput component includes a multiline `textarea` form field. To render a
-`textarea` element, pass `"textarea"` for the `type` prop. All the variations
-described above are available for the `textarea` option.
-
-<Canvas withToolbar>
-  <Story
-    name="Textarea"
-    args={{
-      helperText: "Let it all out.",
-      id: "textarea",
-      invalidText: "This is error text :(",
-      isDisabled: false,
-      isInvalid: false,
-      isRequired: true,
-      labelText: "In less than 500 words, describe your favorite color?",
-      placeholder: "Essay question...",
-      showLabel: true,
-      showRequiredLabel: true,
-      type: "textarea",
-    }}
-    argTypes={{
-      type: { control: false },
-      textInputType: { control: false },
-    }}
-  >
-    {(args) => <TextInput {...args} />}
-  </Story>
-</Canvas>

package/src/components/TextInput/TextInput.test.tsx

@@ -1,451 +0,0 @@
-import * as React from "react";
-import { render, RenderResult, screen } from "@testing-library/react";
-import { axe } from "jest-axe";
-import renderer from "react-test-renderer";
-import userEvent from "@testing-library/user-event";
-
-import TextInput from "./TextInput";
-
-describe("TextInput Accessibility", () => {
-  it("passes axe accessibility test for the input element", async () => {
-    const { container } = render(
-      <TextInput
-        id="textInput"
-        isRequired
-        labelText="Custom input label"
-        onChange={jest.fn()}
-        placeholder="Input Placeholder"
-        type="text"
-      />
-    );
-    expect(await axe(container)).toHaveNoViolations();
-  });
-
-  it("passes axe accessibility test for the textarea element", async () => {
-    const { container } = render(
-      <TextInput
-        id="textInput"
-        isRequired
-        labelText="Custom textarea label"
-        onChange={jest.fn()}
-        placeholder="Input Placeholder"
-        type="textarea"
-      />
-    );
-    expect(await axe(container)).toHaveNoViolations();
-  });
-});
-
-describe("TextInput", () => {
-  let changeHandler: jest.MockedFunction<() => void>;
-  let utils: RenderResult;
-
-  beforeEach(() => {
-    changeHandler = jest.fn();
-    utils = render(
-      <TextInput
-        id="myTextInput"
-        isRequired
-        labelText="Custom Input Label"
-        onChange={changeHandler}
-        placeholder="Input Placeholder"
-        type="text"
-      />
-    );
-  });
-
-  it("renders an input element", () => {
-    expect(screen.getByLabelText(/Custom Input Label/i)).toBeInTheDocument();
-  });
-
-  it("renders label with label text", () => {
-    expect(screen.getByText("Custom Input Label")).toBeInTheDocument();
-  });
-
-  it("renders 'Required' along with the label text", () => {
-    expect(screen.getByText("Custom Input Label")).toBeInTheDocument();
-    expect(screen.getByText(/Required/i)).toBeInTheDocument();
-  });
-
-  it("does not render '(Required)' along with the label text", () => {
-    utils.rerender(
-      <TextInput
-        id="myTextInput"
-        isRequired
-        labelText="Custom Input Label"
-        onChange={changeHandler}
-        placeholder="Input Placeholder"
-        showRequiredLabel={false}
-        type="text"
-      />
-    );
-
-    expect(screen.getByText("Custom Input Label")).toBeInTheDocument();
-    expect(screen.queryByText(/Required/i)).not.toBeInTheDocument();
-  });
-
-  it("renders label's `for` attribute pointing at ID from input", () => {
-    expect(screen.getByText(/Custom Input Label/i)).toHaveAttribute(
-      "for",
-      "myTextInput"
-    );
-  });
-
-  it("renders placeholder text", () => {
-    expect(
-      screen.getByPlaceholderText("Input Placeholder")
-    ).toBeInTheDocument();
-  });
-
-  it("adds aria-required prop if input is required", () => {
-    expect(screen.getByLabelText(/Custom Input Label/i)).toHaveAttribute(
-      "aria-required"
-    );
-  });
-
-  it("changing the value calls the onChange handler", () => {
-    expect(changeHandler).toHaveBeenCalledTimes(0);
-    userEvent.type(screen.getByLabelText(/Custom Input Label/i), "Hello");
-    // Called 5 times because "Hello" has length of 5.
-    expect(changeHandler).toHaveBeenCalledTimes(5);
-  });
-
-  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.
-      <TextInput labelText="Custom Input Label" />
-    );
-    expect(warn).toHaveBeenCalledWith(
-      "NYPL Reservoir TextInput: This component's required `id` prop was not passed."
-    );
-  });
-});
-
-describe("Renders TextInput with auto-generated ID, hidden label and visible helper text", () => {
-  beforeEach(() => {
-    render(
-      <TextInput
-        helperText="Custom Helper Text"
-        id="textInput"
-        isRequired
-        labelText="Custom Input Label"
-        placeholder="Input Placeholder"
-        showLabel={false}
-        type="text"
-      />
-    );
-  });
-
-  it("renders Input component", () => {
-    expect(screen.getByLabelText(/Custom Input Label/i)).toBeInTheDocument();
-  });
-
-  it("does not renders Label component", () => {
-    expect(screen.queryByText(/Custom Input Label/i)).not.toBeInTheDocument();
-  });
-
-  it("renders custom aria-label", () => {
-    expect(screen.getByLabelText(/Custom Input Label/i)).toHaveAttribute(
-      "aria-label",
-      "Custom Input Label - Custom Helper Text"
-    );
-  });
-
-  it("renders HelperErrorText component", () => {
-    expect(screen.getByText("Custom Helper Text")).toBeInTheDocument();
-  });
-});
-
-describe("TextInput shows error state", () => {
-  let utils: RenderResult;
-
-  beforeEach(() => {
-    utils = render(
-      <TextInput
-        helperText="Custom Helper Text"
-        id="myTextInputError"
-        invalidText="Custom Error Text"
-        isInvalid
-        labelText="Custom Input Label"
-        placeholder="Input Placeholder"
-        type="text"
-      />
-    );
-  });
-
-  it("renders Input component", () => {
-    expect(screen.getByLabelText(/Custom Input Label/i)).toBeInTheDocument();
-  });
-
-  it("renders Label component", () => {
-    expect(screen.getByText(/Custom Input Label/i)).toBeInTheDocument();
-  });
-
-  it("renders HelperErrorText component", () => {
-    expect(screen.queryByText("Custom Helper Text")).not.toBeInTheDocument();
-    expect(screen.getByText("Custom Error Text")).toBeInTheDocument();
-  });
-
-  it("does not render the invalid text when 'showHelperInvalidText' is set to false", () => {
-    utils.rerender(
-      <TextInput
-        helperText="Custom Helper Text"
-        id="myTextInputError"
-        invalidText="Custom Error Text"
-        isInvalid
-        labelText="Custom Input Label"
-        placeholder="Input Placeholder"
-        showHelperInvalidText={false}
-        type="text"
-      />
-    );
-    expect(screen.queryByText("Custom Helper Text")).not.toBeInTheDocument();
-    expect(screen.queryByText("Custom Error Text")).not.toBeInTheDocument();
-  });
-
-  it("input shows error state", () => {
-    expect(screen.getByLabelText(/Custom Input Label/i)).toHaveAttribute(
-      "aria-invalid"
-    );
-  });
-});
-
-describe("Renders HTML attributes passed", () => {
-  const onChangeSpy = jest.fn();
-  beforeEach(() => {
-    render(
-      <TextInput
-        id="inputID-attributes"
-        labelText="Input Label"
-        maxLength={10}
-        onChange={onChangeSpy}
-        placeholder="Input Placeholder"
-        type="text"
-      />
-    );
-  });
-
-  it("has a maxlength for the input element", () => {
-    expect(screen.getByLabelText(/Input Label/i)).toHaveAttribute(
-      "maxLength",
-      "10"
-    );
-  });
-
-  it("calls the onChange function", () => {
-    expect(onChangeSpy).toHaveBeenCalledTimes(0);
-    userEvent.type(screen.getByLabelText(/Input Label/i), "Hello");
-    expect(onChangeSpy).toHaveBeenCalledTimes(5);
-  });
-});
-
-// TODO:
-// describe("Forwarding refs", () => {
-//   it("Passes the ref to the input element", () => {
-//     const ref = React.createRef<TextInputRefType>();
-//     const container = render(
-//       <TextInput
-//         id="inputID-attributes"
-//         labelText="Input Label"
-//         placeholder={"Input Placeholder"}
-//         type="text"
-//         ref={ref}
-//       />
-//     );
-//     expect(container.find("input").instance()).toEqual(ref.current);
-//   });
-
-//   it("Passes the ref to the textarea element", () => {
-//     const ref = React.createRef<TextInputRefType>();
-//     const container = render(
-//       <TextInput
-//         id="inputID-attributes"
-//         labelText="Input Label"
-//         placeholder={"Input Placeholder"}
-//         type="textarea"
-//         ref={ref}
-//       />
-//     );
-//     expect(container.find("textarea").instance()).toEqual(ref.current);
-//   });
-// });
-
-describe("Hidden input", () => {
-  it("renders a hidden type input", () => {
-    const utils = render(
-      <TextInput
-        id="inputID-hidden"
-        labelText="Hidden Input Label"
-        type="hidden"
-        value="hidden"
-      />
-    );
-
-    expect(utils.container.querySelector("#inputID-hidden")).toHaveAttribute(
-      "aria-hidden"
-    );
-    expect(utils.container.querySelector("#inputID-hidden")).toHaveAttribute(
-      "value",
-      "hidden"
-    );
-  });
-
-  it("does not show the helper text", () => {
-    render(
-      <TextInput
-        helperText="Helper Text"
-        id="inputID-hidden"
-        labelText="Hidden Input Label"
-        type="hidden"
-        value="hidden"
-      />
-    );
-
-    expect(screen.queryByText("Hidden Input Label")).not.toBeInTheDocument();
-    expect(screen.queryByText("Helper Text")).not.toBeInTheDocument();
-  });
-});
-
-describe("Textarea element type", () => {
-  beforeEach(() => {
-    render(
-      <TextInput
-        id="myTextarea"
-        labelText="Custom textarea Label"
-        placeholder="Textarea Placeholder"
-        type="textarea"
-      />
-    );
-  });
-
-  it("renders a textarea element", () => {
-    expect(screen.getByRole("textbox")).toBeInTheDocument();
-  });
-
-  it("renders label with label text", () => {
-    expect(screen.getByLabelText(/Custom textarea Label/i)).toBeInTheDocument();
-  });
-});
-
-describe("UI Snapshots", () => {
-  it("renders the text input UI snapshot correctly", () => {
-    const required = renderer
-      .create(
-        <TextInput
-          id="myTextInput"
-          isRequired
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-        />
-      )
-      .toJSON();
-    const optional = renderer
-      .create(
-        <TextInput
-          id="myTextInput"
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-        />
-      )
-      .toJSON();
-    const hiddenLabelText = renderer
-      .create(
-        <TextInput
-          id="myTextInput"
-          isRequired
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          showLabel={false}
-          type="text"
-        />
-      )
-      .toJSON();
-    const withHelperText = renderer
-      .create(
-        <TextInput
-          helperText="Custom helper text"
-          id="myTextInput"
-          isRequired
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-        />
-      )
-      .toJSON();
-    const errorState = renderer
-      .create(
-        <TextInput
-          id="myTextInput"
-          isInvalid
-          isRequired
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-        />
-      )
-      .toJSON();
-    const disabledState = renderer
-      .create(
-        <TextInput
-          id="myTextInput"
-          isDisabled
-          isRequired
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-        />
-      )
-      .toJSON();
-    const withChakraProps = renderer
-      .create(
-        <TextInput
-          id="chakra"
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-          p="20px"
-          color="ui.error.primary"
-        />
-      )
-      .toJSON();
-    const withOtherProps = renderer
-      .create(
-        <TextInput
-          id="props"
-          labelText="Custom Input Label"
-          placeholder="Input Placeholder"
-          type="text"
-          data-testid="props"
-        />
-      )
-      .toJSON();
-
-    expect(required).toMatchSnapshot();
-    expect(optional).toMatchSnapshot();
-    expect(hiddenLabelText).toMatchSnapshot();
-    expect(withHelperText).toMatchSnapshot();
-    expect(errorState).toMatchSnapshot();
-    expect(disabledState).toMatchSnapshot();
-    expect(withChakraProps).toMatchSnapshot();
-    expect(withOtherProps).toMatchSnapshot();
-  });
-
-  it("renders the textarea UI snapshot correctly", () => {
-    const basicTextarea = renderer
-      .create(
-        <TextInput
-          id="myTextarea"
-          labelText="Custom textarea Label"
-          placeholder="Textarea Placeholder"
-          type="textarea"
-        />
-      )
-      .toJSON();
-
-    expect(basicTextarea).toMatchSnapshot();
-  });
-});