@instructure/ui-checkbox 8.46.2-snapshot-0 → 8.46.2-snapshot-1

package/lib/Checkbox/__new-tests__/Checkbox.test.js

@@ -0,0 +1,213 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+require("@testing-library/jest-dom/extend-expect");
+var _runAxeCheck = require("@instructure/ui-axe-check/lib/runAxeCheck.js");
+var _index = require("../index");
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+const TEST_VALUE = 'test-value';
+const TEST_NAME = 'test-name';
+const TEST_LABEL = 'test-label';
+const initProps = {
+  label: TEST_LABEL,
+  defaultChecked: true,
+  value: TEST_VALUE,
+  name: TEST_NAME
+};
+const renderCheckbox = props => {
+  const allProps = {
+    ...initProps,
+    ...props
+  };
+  return (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.Checkbox, allProps));
+};
+describe('<Checkbox />', () => {
+  it('renders an input with type "checkbox"', () => {
+    renderCheckbox();
+    const inputElem = _react2.screen.getByRole('checkbox');
+    expect(inputElem).toBeInTheDocument();
+    expect(inputElem.tagName).toBe('INPUT');
+    expect(inputElem).toHaveAttribute('type', 'checkbox');
+  });
+  it('`simple` variant only displays a checkmark when checked', async () => {
+    const _renderCheckbox = renderCheckbox({
+        variant: 'simple',
+        defaultChecked: false
+      }),
+      container = _renderCheckbox.container;
+    const checkboxElement = container.querySelector('input[type="checkbox"]');
+    const svgElement = container.querySelector('svg');
+    expect(svgElement).not.toBeInTheDocument();
+    _userEvent.default.click(checkboxElement);
+    await (0, _react2.waitFor)(() => {
+      const svgElementAfterClick = container.querySelector('svg');
+      expect(svgElementAfterClick).toBeInTheDocument();
+    });
+  });
+  it('`simple` variant supports indeterminate/mixed state', () => {
+    renderCheckbox({
+      variant: 'simple',
+      indeterminate: true
+    });
+    const inputElem = _react2.screen.getByRole('checkbox');
+    expect(inputElem).toBeInTheDocument();
+    expect(inputElem).toHaveAttribute('aria-checked', 'mixed');
+  });
+  describe('events', () => {
+    it('when clicked, fires onClick and onChange events', async () => {
+      const onClick = jest.fn();
+      const onChange = jest.fn();
+      renderCheckbox({
+        onClick,
+        onChange
+      });
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      _userEvent.default.click(checkboxElement);
+      await (0, _react2.waitFor)(() => {
+        expect(onClick).toHaveBeenCalled();
+        expect(onChange).toHaveBeenCalled();
+      });
+    });
+    it('when clicked, does not call onClick or onChange when disabled', async () => {
+      const onClick = jest.fn();
+      const onChange = jest.fn();
+      renderCheckbox({
+        onClick,
+        onChange,
+        disabled: true
+      });
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      _react2.fireEvent.click(checkboxElement);
+      await (0, _react2.waitFor)(() => {
+        expect(onClick).not.toHaveBeenCalled();
+        expect(onChange).not.toHaveBeenCalled();
+        expect(checkboxElement).toBeDisabled();
+      });
+    });
+    it('when clicked, does not call onClick or onChange when readOnly', async () => {
+      const onClick = jest.fn();
+      const onChange = jest.fn();
+      renderCheckbox({
+        onClick,
+        onChange,
+        readOnly: true
+      });
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      _react2.fireEvent.click(checkboxElement);
+      await (0, _react2.waitFor)(() => {
+        expect(onClick).not.toHaveBeenCalled();
+        expect(onChange).not.toHaveBeenCalled();
+      });
+    });
+    it('calls onChange when enter key is pressed', async () => {
+      const onChange = jest.fn();
+      renderCheckbox({
+        onChange
+      });
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      _userEvent.default.type(checkboxElement, '{enter}');
+      await (0, _react2.waitFor)(() => {
+        expect(onChange).toHaveBeenCalled();
+      });
+    });
+    it('responds to onBlur event', async () => {
+      const onBlur = jest.fn();
+      renderCheckbox({
+        onBlur
+      });
+      _userEvent.default.tab();
+      _userEvent.default.tab();
+      await (0, _react2.waitFor)(() => {
+        expect(onBlur).toHaveBeenCalled();
+      });
+    });
+    it('responds to onFocus event', async () => {
+      const onFocus = jest.fn();
+      renderCheckbox({
+        onFocus
+      });
+      _userEvent.default.tab();
+      await (0, _react2.waitFor)(() => {
+        expect(onFocus).toHaveBeenCalled();
+      });
+    });
+    it('focuses with the focus helper', () => {
+      var _checkboxRef$current;
+      const checkboxRef = /*#__PURE__*/_react.default.createRef();
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.Checkbox, Object.assign({
+        ref: checkboxRef
+      }, initProps)));
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      expect(checkboxElement).not.toHaveFocus();
+      (_checkboxRef$current = checkboxRef.current) === null || _checkboxRef$current === void 0 ? void 0 : _checkboxRef$current.focus();
+      expect(checkboxElement).toHaveFocus();
+    });
+    it('calls onMouseOver', async () => {
+      const onMouseOver = jest.fn();
+      renderCheckbox({
+        onMouseOver
+      });
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      _userEvent.default.hover(checkboxElement);
+      await (0, _react2.waitFor)(() => {
+        expect(onMouseOver).toHaveBeenCalled();
+      });
+    });
+    it('calls onMouseOut', async () => {
+      const onMouseOut = jest.fn();
+      renderCheckbox({
+        onMouseOut
+      });
+      const checkboxElement = _react2.screen.getByRole('checkbox');
+      _userEvent.default.hover(checkboxElement);
+      _userEvent.default.unhover(checkboxElement);
+      await (0, _react2.waitFor)(() => {
+        expect(onMouseOut).toHaveBeenCalled();
+      });
+    });
+  });
+  describe('for a11y', () => {
+    it('`simple` variant should meet standards', async () => {
+      const _renderCheckbox2 = renderCheckbox({
+          variant: 'simple'
+        }),
+        container = _renderCheckbox2.container;
+      const axeCheck = await (0, _runAxeCheck.runAxeCheck)(container);
+      expect(axeCheck).toBe(true);
+    });
+    it('`toggle` variant should meet standards', async () => {
+      const _renderCheckbox3 = renderCheckbox({
+          variant: 'toggle'
+        }),
+        container = _renderCheckbox3.container;
+      const axeCheck = await (0, _runAxeCheck.runAxeCheck)(container);
+      expect(axeCheck).toBe(true);
+    });
+  });
+});

package/lib/CheckboxGroup/__new-tests__/CheckboxGroup.test.js

@@ -0,0 +1,198 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+require("@testing-library/jest-dom/extend-expect");
+var _runAxeCheck = require("@instructure/ui-axe-check/lib/runAxeCheck.js");
+var _index = require("../index");
+var _Checkbox3 = require("../../Checkbox");
+var _Checkbox, _Checkbox2;
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 - present Instructure, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+const TEST_NAME = 'test-name';
+const TEST_DESCRIPTION = 'test-description';
+const TEST_ERROR_MESSAGE = 'test-error-message';
+const TEST_VALUE_1 = 'test-value-1';
+const TEST_VALUE_2 = 'test-value-2';
+const TEST_LABEL_1 = 'test-label-1';
+const TEST_LABEL_2 = 'test-label-2';
+const renderCheckboxGroup = props => {
+  const allProps = {
+    name: TEST_NAME,
+    description: TEST_DESCRIPTION,
+    ...props
+  };
+  return (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.CheckboxGroup, allProps, _Checkbox || (_Checkbox = /*#__PURE__*/_react.default.createElement(_Checkbox3.Checkbox, {
+    label: TEST_LABEL_1,
+    value: TEST_VALUE_1
+  })), _Checkbox2 || (_Checkbox2 = /*#__PURE__*/_react.default.createElement(_Checkbox3.Checkbox, {
+    label: TEST_LABEL_2,
+    value: TEST_VALUE_2
+  }))));
+};
+describe('<CheckboxGroup />', () => {
+  it('adds the name props to all Checkbox types', () => {
+    renderCheckboxGroup({
+      name: TEST_NAME
+    });
+    const checkboxes = _react2.screen.getAllByRole('checkbox');
+    expect(checkboxes.length).toBe(2);
+    expect(checkboxes[0]).toHaveAttribute('name', TEST_NAME);
+    expect(checkboxes[1]).toHaveAttribute('name', TEST_NAME);
+  });
+  it('links the messages to the fieldset via aria-describedby', () => {
+    const _renderCheckboxGroup = renderCheckboxGroup({
+        messages: [{
+          text: TEST_ERROR_MESSAGE,
+          type: 'error'
+        }]
+      }),
+      container = _renderCheckboxGroup.container;
+    const fieldset = _react2.screen.getByRole('group');
+    const ariaDesc = fieldset.getAttribute('aria-describedby');
+    const messageById = container.querySelector(`[id="${ariaDesc}"]`);
+    expect(messageById).toBeInTheDocument();
+    expect(messageById).toHaveTextContent(TEST_ERROR_MESSAGE);
+  });
+  it('displays description message inside the legend', () => {
+    const _renderCheckboxGroup2 = renderCheckboxGroup({
+        description: TEST_DESCRIPTION
+      }),
+      container = _renderCheckboxGroup2.container;
+    const legend = container.querySelector('legend');
+    expect(legend).toBeInTheDocument();
+    expect(legend).toHaveTextContent(TEST_DESCRIPTION);
+  });
+  it('does not call the onChange prop when disabled', async () => {
+    const onChange = jest.fn();
+    renderCheckboxGroup({
+      onChange,
+      disabled: true
+    });
+    const checkboxElement = _react2.screen.getAllByRole('checkbox')[0];
+    _react2.fireEvent.click(checkboxElement);
+    await (0, _react2.waitFor)(() => {
+      expect(onChange).not.toHaveBeenCalled();
+      expect(checkboxElement).toBeDisabled();
+    });
+  });
+  it('does not call the onChange prop when readOnly', async () => {
+    const onChange = jest.fn();
+    renderCheckboxGroup({
+      onChange,
+      readOnly: true
+    });
+    const checkboxElement = _react2.screen.getAllByRole('checkbox')[0];
+    _react2.fireEvent.click(checkboxElement);
+    await (0, _react2.waitFor)(() => {
+      expect(onChange).not.toHaveBeenCalled();
+      expect(checkboxElement).toBeDisabled();
+    });
+  });
+  it('should not update the value when the value prop is set', async () => {
+    const onChange = jest.fn();
+    renderCheckboxGroup({
+      onChange,
+      value: ['tester']
+    });
+    const checkboxes = _react2.screen.getAllByRole('checkbox');
+    expect(checkboxes[0]).not.toBeChecked();
+    expect(checkboxes[1]).not.toBeChecked();
+    _userEvent.default.click(checkboxes[0]);
+    await (0, _react2.waitFor)(() => {
+      expect(onChange).not.toHaveBeenCalled();
+      expect(checkboxes[0]).not.toBeChecked();
+      expect(checkboxes[1]).not.toBeChecked();
+    });
+  });
+  it('should add the checkbox value to the value list when it is checked', async () => {
+    const onChange = jest.fn();
+    renderCheckboxGroup({
+      onChange
+    });
+    const checkboxes = _react2.screen.getAllByRole('checkbox');
+    expect(checkboxes[0]).not.toBeChecked();
+    expect(checkboxes[1]).not.toBeChecked();
+    _userEvent.default.click(checkboxes[0]);
+    _userEvent.default.click(checkboxes[1]);
+    await (0, _react2.waitFor)(() => {
+      expect(checkboxes[0]).toBeChecked();
+      expect(checkboxes[1]).toBeChecked();
+      expect(onChange).toHaveBeenCalledWith([TEST_VALUE_1, TEST_VALUE_2]);
+    });
+  });
+  it('should check the checkboxes based on the defaultValue prop', () => {
+    const defaultValue = [TEST_VALUE_2];
+    renderCheckboxGroup({
+      defaultValue
+    });
+    const checkboxes = _react2.screen.getAllByRole('checkbox');
+    expect(checkboxes[0]).not.toBeChecked();
+    expect(checkboxes[1]).toBeChecked();
+  });
+  it('should remove the checkbox value from the value list when it is unchecked', async () => {
+    const onChange = jest.fn();
+    const defaultValue = [TEST_VALUE_1, TEST_VALUE_2];
+    renderCheckboxGroup({
+      onChange,
+      defaultValue
+    });
+    const checkboxes = _react2.screen.getAllByRole('checkbox');
+    expect(checkboxes[0]).toBeChecked();
+    expect(checkboxes[1]).toBeChecked();
+    _userEvent.default.click(checkboxes[0]);
+    await (0, _react2.waitFor)(() => {
+      expect(checkboxes[0]).not.toBeChecked();
+      expect(checkboxes[1]).toBeChecked();
+      expect(onChange).toHaveBeenCalledWith([TEST_VALUE_2]);
+    });
+  });
+  it('passes the array of selected values to onChange handler', async () => {
+    const onChange = jest.fn();
+    const defaultValue = [TEST_VALUE_2];
+    renderCheckboxGroup({
+      onChange,
+      defaultValue
+    });
+    const checkboxes = _react2.screen.getAllByRole('checkbox');
+    expect(checkboxes[0]).not.toBeChecked();
+    expect(checkboxes[1]).toBeChecked();
+    _userEvent.default.click(checkboxes[0]);
+    await (0, _react2.waitFor)(() => {
+      expect(checkboxes[0]).toBeChecked();
+      expect(checkboxes[1]).toBeChecked();
+      expect(onChange).toHaveBeenCalledWith([TEST_VALUE_2, TEST_VALUE_1]);
+    });
+  });
+  describe('for a11y', () => {
+    it('should meet standards', async () => {
+      const _renderCheckboxGroup3 = renderCheckboxGroup(),
+        container = _renderCheckboxGroup3.container;
+      const axeCheck = await (0, _runAxeCheck.runAxeCheck)(container);
+      expect(axeCheck).toBe(true);
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-checkbox",
-  "version": "8.46.2-snapshot-0",
+  "version": "8.46.2-snapshot-1",
   "description": " styled HTML input type='checkbox' component.",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -24,28 +24,31 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.22.15",
-    "@instructure/console": "8.46.2-snapshot-0",
-    "@instructure/emotion": "8.46.2-snapshot-0",
-    "@instructure/shared-types": "8.46.2-snapshot-0",
-    "@instructure/ui-dom-utils": "8.46.2-snapshot-0",
-    "@instructure/ui-form-field": "8.46.2-snapshot-0",
-    "@instructure/ui-icons": "8.46.2-snapshot-0",
-    "@instructure/ui-prop-types": "8.46.2-snapshot-0",
-    "@instructure/ui-react-utils": "8.46.2-snapshot-0",
-    "@instructure/ui-svg-images": "8.46.2-snapshot-0",
-    "@instructure/ui-testable": "8.46.2-snapshot-0",
-    "@instructure/ui-utils": "8.46.2-snapshot-0",
-    "@instructure/ui-view": "8.46.2-snapshot-0",
-    "@instructure/uid": "8.46.2-snapshot-0",
+    "@instructure/console": "8.46.2-snapshot-1",
+    "@instructure/emotion": "8.46.2-snapshot-1",
+    "@instructure/shared-types": "8.46.2-snapshot-1",
+    "@instructure/ui-dom-utils": "8.46.2-snapshot-1",
+    "@instructure/ui-form-field": "8.46.2-snapshot-1",
+    "@instructure/ui-icons": "8.46.2-snapshot-1",
+    "@instructure/ui-prop-types": "8.46.2-snapshot-1",
+    "@instructure/ui-react-utils": "8.46.2-snapshot-1",
+    "@instructure/ui-svg-images": "8.46.2-snapshot-1",
+    "@instructure/ui-testable": "8.46.2-snapshot-1",
+    "@instructure/ui-utils": "8.46.2-snapshot-1",
+    "@instructure/ui-view": "8.46.2-snapshot-1",
+    "@instructure/uid": "8.46.2-snapshot-1",
     "keycode": "^2.2.1",
     "prop-types": "^15.8.1"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "8.46.2-snapshot-0",
-    "@instructure/ui-color-utils": "8.46.2-snapshot-0",
-    "@instructure/ui-test-locator": "8.46.2-snapshot-0",
-    "@instructure/ui-test-utils": "8.46.2-snapshot-0",
-    "@instructure/ui-themes": "8.46.2-snapshot-0"
+    "@instructure/ui-axe-check": "8.46.2-snapshot-1",
+    "@instructure/ui-babel-preset": "8.46.2-snapshot-1",
+    "@instructure/ui-color-utils": "8.46.2-snapshot-1",
+    "@instructure/ui-test-utils": "8.46.2-snapshot-1",
+    "@instructure/ui-themes": "8.46.2-snapshot-1",
+    "@testing-library/jest-dom": "^5.17.0",
+    "@testing-library/react": "^14.0.0",
+    "@testing-library/user-event": "^14.4.3"
   },
   "peerDependencies": {
     "react": ">=16.8 <=18"

package/src/{CheckboxGroup/CheckboxGroupLocator.ts → Checkbox/CheckboxFacade/__new-tests__/CheckboxFacade.test.tsx}

@@ -22,9 +22,27 @@
  * SOFTWARE.
  */
 
-import { locator } from '@instructure/ui-test-locator'
+import React from 'react'
+import { render, screen } from '@testing-library/react'
+import '@testing-library/jest-dom/extend-expect'
 
-import { CheckboxGroup } from './index'
+import { runAxeCheck } from '@instructure/ui-axe-check'
+import { CheckboxFacade } from '../index'
 
-// @ts-expect-error ts-migrate(2339) FIXME: Property 'selector' does not exist on type 'typeof... Remove this comment to see the full error message
-export const CheckboxGroupLocator = locator(CheckboxGroup.selector)
+const TEST_TEXT = 'test-text'
+
+describe('<CheckboxFacade />', () => {
+  it('should render', () => {
+    render(<CheckboxFacade>{TEST_TEXT}</CheckboxFacade>)
+    const facade = screen.getByText(TEST_TEXT)
+
+    expect(facade).toBeInTheDocument()
+  })
+
+  it('should meet a11y standards', async () => {
+    const { container } = render(<CheckboxFacade>{TEST_TEXT}</CheckboxFacade>)
+    const axeCheck = await runAxeCheck(container)
+
+    expect(axeCheck).toBe(true)
+  })
+})

package/src/Checkbox/{CheckboxLocator.ts → ToggleFacade/__new-tests__/ToggleFacade.test.tsx}

@@ -22,9 +22,27 @@
  * SOFTWARE.
  */
 
-import { locator } from '@instructure/ui-test-locator'
+import React from 'react'
+import { render, screen } from '@testing-library/react'
+import '@testing-library/jest-dom/extend-expect'
 
-import { Checkbox } from './index'
+import { runAxeCheck } from '@instructure/ui-axe-check'
+import { ToggleFacade } from '../index'
 
-// @ts-expect-error ts-migrate(2339) FIXME: Property 'selector' does not exist on type 'typeof... Remove this comment to see the full error message
-export const CheckboxLocator = locator(Checkbox.selector)
+const TEST_TEXT = 'test-text'
+
+describe('<ToggleFacade />', () => {
+  it('should render', () => {
+    render(<ToggleFacade>{TEST_TEXT}</ToggleFacade>)
+    const facade = screen.getByText(TEST_TEXT)
+
+    expect(facade).toBeInTheDocument()
+  })
+
+  it('should meet a11y standards', async () => {
+    const { container } = render(<ToggleFacade>{TEST_TEXT}</ToggleFacade>)
+    const axeCheck = await runAxeCheck(container)
+
+    expect(axeCheck).toBe(true)
+  })
+})