@instructure/ui-text-area 10.2.2-snapshot-16 → 10.2.2-snapshot-17

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [10.2.2-snapshot-16](https://github.com/instructure/instructure-ui/compare/v10.2.1...v10.2.2-snapshot-16) (2024-09-13)
+## [10.2.2-snapshot-17](https://github.com/instructure/instructure-ui/compare/v10.2.1...v10.2.2-snapshot-17) (2024-09-13)
 
 **Note:** Version bump only for package @instructure/ui-text-area
 

package/es/TextArea/__new-tests__/TextArea.test.js

@@ -0,0 +1,217 @@
+var _TextArea, _TextArea2, _TextArea3, _TextArea4;
+/*
+ * 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.
+ */
+
+import React from 'react';
+import { fireEvent, render, screen, waitFor } from '@testing-library/react';
+import { vi } from 'vitest';
+import userEvent from '@testing-library/user-event';
+import { runAxeCheck } from '@instructure/ui-axe-check';
+import '@testing-library/jest-dom';
+import { TextArea } from '../index';
+describe('TextArea', () => {
+  let consoleWarningMock;
+  let consoleErrorMock;
+  beforeEach(() => {
+    // Mocking console to prevent test output pollution and expect for messages
+    consoleWarningMock = vi.spyOn(console, 'warn').mockImplementation(() => {});
+    consoleErrorMock = vi.spyOn(console, 'error').mockImplementation(() => {});
+  });
+  afterEach(() => {
+    consoleWarningMock.mockRestore();
+    consoleErrorMock.mockRestore();
+  });
+  it('should accept a default value', async () => {
+    render(_TextArea || (_TextArea = /*#__PURE__*/React.createElement(TextArea, {
+      label: "Name",
+      autoGrow: false,
+      defaultValue: "Tom Servo"
+    })));
+    const input = screen.getByRole('textbox');
+    expect(input).toHaveTextContent('Tom Servo');
+  });
+  it('should include a label', async () => {
+    const _render = render(_TextArea2 || (_TextArea2 = /*#__PURE__*/React.createElement(TextArea, {
+        label: "Name",
+        autoGrow: false
+      }))),
+      container = _render.container;
+    const textArea = container.querySelector('span[class$="-formFieldLabel"]');
+    expect(textArea).toHaveTextContent('Name');
+  });
+  it('should set an initial height', async () => {
+    render(_TextArea3 || (_TextArea3 = /*#__PURE__*/React.createElement(TextArea, {
+      label: "Name",
+      autoGrow: false,
+      height: "100px"
+    })));
+    const input = screen.getByRole('textbox');
+    expect(input).toHaveStyle('height: 100px');
+  });
+  it('should focus the textarea when focus is called', async () => {
+    let ref;
+    render( /*#__PURE__*/React.createElement(TextArea, {
+      label: "Name",
+      autoGrow: false
+      // @ts-expect-error this is managed by the testing framework
+      ,
+      textareaRef: el => ref = el
+    }));
+    const input = screen.getByRole('textbox');
+    ref.focus();
+    expect(input).toHaveFocus();
+  });
+  it('provides a focused getter', async () => {
+    let ref;
+    render( /*#__PURE__*/React.createElement(TextArea, {
+      label: "Name",
+      autoGrow: false,
+      ref: el => ref = el
+    }));
+    ref.focus();
+    expect(ref.focused).toBe(true);
+  });
+  it('should provide an textareaRef prop', async () => {
+    const textareaRef = vi.fn();
+    render( /*#__PURE__*/React.createElement(TextArea, {
+      label: "Name",
+      autoGrow: false,
+      textareaRef: textareaRef
+    }));
+    const input = screen.getByRole('textbox');
+    expect(textareaRef).toHaveBeenCalledWith(input);
+  });
+  it('should provide a value getter', async () => {
+    let ref;
+    render( /*#__PURE__*/React.createElement(TextArea, {
+      label: "Name",
+      autoGrow: false,
+      defaultValue: "bar"
+      // @ts-expect-error this is managed by the testing framework
+      ,
+      textareaRef: el => ref = el
+    }));
+    expect(ref.value).toBe('bar');
+  });
+  describe('events', () => {
+    it('responds to onChange event', async () => {
+      const onChange = vi.fn();
+      render( /*#__PURE__*/React.createElement(TextArea, {
+        label: "Name",
+        autoGrow: false,
+        onChange: onChange
+      }));
+      const input = screen.getByRole('textbox');
+      fireEvent.change(input, {
+        target: {
+          value: 'foo'
+        }
+      });
+      await waitFor(() => {
+        expect(onChange).toHaveBeenCalledTimes(1);
+      });
+    });
+    it('does not respond to onChange event when disabled', async () => {
+      const onChange = vi.fn();
+      render( /*#__PURE__*/React.createElement(TextArea, {
+        disabled: true,
+        label: "Name",
+        autoGrow: false,
+        onChange: onChange
+      }));
+      const input = screen.getByRole('textbox');
+      fireEvent.change(input, {
+        target: {
+          value: 'foo'
+        }
+      });
+      expect(onChange).not.toHaveBeenCalled();
+    });
+    it('does not respond to onChange event when readOnly', async () => {
+      const onChange = vi.fn();
+      render( /*#__PURE__*/React.createElement(TextArea, {
+        readOnly: true,
+        label: "Name",
+        autoGrow: false,
+        onChange: onChange
+      }));
+      const input = screen.getByRole('textbox');
+      fireEvent.change(input, {
+        target: {
+          value: 'foo'
+        }
+      });
+      expect(onChange).not.toHaveBeenCalled();
+    });
+    it('responds to onBlur event', async () => {
+      const onBlur = vi.fn();
+      render( /*#__PURE__*/React.createElement(TextArea, {
+        label: "Name",
+        autoGrow: false,
+        onBlur: onBlur
+      }));
+      userEvent.tab();
+      userEvent.tab();
+      await waitFor(() => {
+        expect(onBlur).toHaveBeenCalled();
+      });
+    });
+    it('responds to onFocus event', async () => {
+      const onFocus = vi.fn();
+      render( /*#__PURE__*/React.createElement(TextArea, {
+        label: "Name",
+        autoGrow: false,
+        onFocus: onFocus
+      }));
+      const input = screen.getByRole('textbox');
+      input.focus();
+      await waitFor(() => {
+        expect(onFocus).toHaveBeenCalled();
+      });
+    });
+  });
+  describe('for a11y', () => {
+    it('should meet standards', async () => {
+      const _render2 = render(_TextArea4 || (_TextArea4 = /*#__PURE__*/React.createElement(TextArea, {
+          label: "Name",
+          autoGrow: false
+        }))),
+        container = _render2.container;
+      const axeCheck = await runAxeCheck(container);
+      expect(axeCheck).toBe(true);
+    });
+    it('should set aria-invalid when errors prop is set', async () => {
+      render( /*#__PURE__*/React.createElement(TextArea, {
+        label: "Name",
+        autoGrow: false,
+        messages: [{
+          type: 'error',
+          text: 'some error message'
+        }]
+      }));
+      const input = screen.getByRole('textbox');
+      expect(input).toHaveAttribute('aria-invalid');
+    });
+  });
+});

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

@@ -0,0 +1,219 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+var _vitest = require("vitest");
+var _userEvent = _interopRequireDefault(require("@testing-library/user-event"));
+var _runAxeCheck = require("@instructure/ui-axe-check/lib/runAxeCheck.js");
+require("@testing-library/jest-dom");
+var _index = require("../index");
+var _TextArea, _TextArea2, _TextArea3, _TextArea4;
+/*
+ * 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.
+ */
+describe('TextArea', () => {
+  let consoleWarningMock;
+  let consoleErrorMock;
+  beforeEach(() => {
+    // Mocking console to prevent test output pollution and expect for messages
+    consoleWarningMock = _vitest.vi.spyOn(console, 'warn').mockImplementation(() => {});
+    consoleErrorMock = _vitest.vi.spyOn(console, 'error').mockImplementation(() => {});
+  });
+  afterEach(() => {
+    consoleWarningMock.mockRestore();
+    consoleErrorMock.mockRestore();
+  });
+  it('should accept a default value', async () => {
+    (0, _react2.render)(_TextArea || (_TextArea = /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+      label: "Name",
+      autoGrow: false,
+      defaultValue: "Tom Servo"
+    })));
+    const input = _react2.screen.getByRole('textbox');
+    expect(input).toHaveTextContent('Tom Servo');
+  });
+  it('should include a label', async () => {
+    const _render = (0, _react2.render)(_TextArea2 || (_TextArea2 = /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        label: "Name",
+        autoGrow: false
+      }))),
+      container = _render.container;
+    const textArea = container.querySelector('span[class$="-formFieldLabel"]');
+    expect(textArea).toHaveTextContent('Name');
+  });
+  it('should set an initial height', async () => {
+    (0, _react2.render)(_TextArea3 || (_TextArea3 = /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+      label: "Name",
+      autoGrow: false,
+      height: "100px"
+    })));
+    const input = _react2.screen.getByRole('textbox');
+    expect(input).toHaveStyle('height: 100px');
+  });
+  it('should focus the textarea when focus is called', async () => {
+    let ref;
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+      label: "Name",
+      autoGrow: false
+      // @ts-expect-error this is managed by the testing framework
+      ,
+      textareaRef: el => ref = el
+    }));
+    const input = _react2.screen.getByRole('textbox');
+    ref.focus();
+    expect(input).toHaveFocus();
+  });
+  it('provides a focused getter', async () => {
+    let ref;
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+      label: "Name",
+      autoGrow: false,
+      ref: el => ref = el
+    }));
+    ref.focus();
+    expect(ref.focused).toBe(true);
+  });
+  it('should provide an textareaRef prop', async () => {
+    const textareaRef = _vitest.vi.fn();
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+      label: "Name",
+      autoGrow: false,
+      textareaRef: textareaRef
+    }));
+    const input = _react2.screen.getByRole('textbox');
+    expect(textareaRef).toHaveBeenCalledWith(input);
+  });
+  it('should provide a value getter', async () => {
+    let ref;
+    (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+      label: "Name",
+      autoGrow: false,
+      defaultValue: "bar"
+      // @ts-expect-error this is managed by the testing framework
+      ,
+      textareaRef: el => ref = el
+    }));
+    expect(ref.value).toBe('bar');
+  });
+  describe('events', () => {
+    it('responds to onChange event', async () => {
+      const onChange = _vitest.vi.fn();
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        label: "Name",
+        autoGrow: false,
+        onChange: onChange
+      }));
+      const input = _react2.screen.getByRole('textbox');
+      _react2.fireEvent.change(input, {
+        target: {
+          value: 'foo'
+        }
+      });
+      await (0, _react2.waitFor)(() => {
+        expect(onChange).toHaveBeenCalledTimes(1);
+      });
+    });
+    it('does not respond to onChange event when disabled', async () => {
+      const onChange = _vitest.vi.fn();
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        disabled: true,
+        label: "Name",
+        autoGrow: false,
+        onChange: onChange
+      }));
+      const input = _react2.screen.getByRole('textbox');
+      _react2.fireEvent.change(input, {
+        target: {
+          value: 'foo'
+        }
+      });
+      expect(onChange).not.toHaveBeenCalled();
+    });
+    it('does not respond to onChange event when readOnly', async () => {
+      const onChange = _vitest.vi.fn();
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        readOnly: true,
+        label: "Name",
+        autoGrow: false,
+        onChange: onChange
+      }));
+      const input = _react2.screen.getByRole('textbox');
+      _react2.fireEvent.change(input, {
+        target: {
+          value: 'foo'
+        }
+      });
+      expect(onChange).not.toHaveBeenCalled();
+    });
+    it('responds to onBlur event', async () => {
+      const onBlur = _vitest.vi.fn();
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        label: "Name",
+        autoGrow: false,
+        onBlur: onBlur
+      }));
+      _userEvent.default.tab();
+      _userEvent.default.tab();
+      await (0, _react2.waitFor)(() => {
+        expect(onBlur).toHaveBeenCalled();
+      });
+    });
+    it('responds to onFocus event', async () => {
+      const onFocus = _vitest.vi.fn();
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        label: "Name",
+        autoGrow: false,
+        onFocus: onFocus
+      }));
+      const input = _react2.screen.getByRole('textbox');
+      input.focus();
+      await (0, _react2.waitFor)(() => {
+        expect(onFocus).toHaveBeenCalled();
+      });
+    });
+  });
+  describe('for a11y', () => {
+    it('should meet standards', async () => {
+      const _render2 = (0, _react2.render)(_TextArea4 || (_TextArea4 = /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+          label: "Name",
+          autoGrow: false
+        }))),
+        container = _render2.container;
+      const axeCheck = await (0, _runAxeCheck.runAxeCheck)(container);
+      expect(axeCheck).toBe(true);
+    });
+    it('should set aria-invalid when errors prop is set', async () => {
+      (0, _react2.render)( /*#__PURE__*/_react.default.createElement(_index.TextArea, {
+        label: "Name",
+        autoGrow: false,
+        messages: [{
+          type: 'error',
+          text: 'some error message'
+        }]
+      }));
+      const input = _react2.screen.getByRole('textbox');
+      expect(input).toHaveAttribute('aria-invalid');
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-text-area",
-  "version": "10.2.2-snapshot-16",
+  "version": "10.2.2-snapshot-17",
   "description": "A styled HTML text area component",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -24,24 +24,28 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.24.5",
-    "@instructure/debounce": "10.2.2-snapshot-16",
-    "@instructure/emotion": "10.2.2-snapshot-16",
-    "@instructure/shared-types": "10.2.2-snapshot-16",
-    "@instructure/ui-dom-utils": "10.2.2-snapshot-16",
-    "@instructure/ui-form-field": "10.2.2-snapshot-16",
-    "@instructure/ui-prop-types": "10.2.2-snapshot-16",
-    "@instructure/ui-react-utils": "10.2.2-snapshot-16",
-    "@instructure/ui-testable": "10.2.2-snapshot-16",
-    "@instructure/ui-utils": "10.2.2-snapshot-16",
-    "@instructure/uid": "10.2.2-snapshot-16",
+    "@instructure/debounce": "10.2.2-snapshot-17",
+    "@instructure/emotion": "10.2.2-snapshot-17",
+    "@instructure/shared-types": "10.2.2-snapshot-17",
+    "@instructure/ui-dom-utils": "10.2.2-snapshot-17",
+    "@instructure/ui-form-field": "10.2.2-snapshot-17",
+    "@instructure/ui-prop-types": "10.2.2-snapshot-17",
+    "@instructure/ui-react-utils": "10.2.2-snapshot-17",
+    "@instructure/ui-testable": "10.2.2-snapshot-17",
+    "@instructure/ui-utils": "10.2.2-snapshot-17",
+    "@instructure/uid": "10.2.2-snapshot-17",
     "prop-types": "^15.8.1"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "10.2.2-snapshot-16",
-    "@instructure/ui-color-utils": "10.2.2-snapshot-16",
-    "@instructure/ui-test-locator": "10.2.2-snapshot-16",
-    "@instructure/ui-test-utils": "10.2.2-snapshot-16",
-    "@instructure/ui-themes": "10.2.2-snapshot-16"
+    "@instructure/ui-axe-check": "10.2.2-snapshot-17",
+    "@instructure/ui-babel-preset": "10.2.2-snapshot-17",
+    "@instructure/ui-color-utils": "10.2.2-snapshot-17",
+    "@instructure/ui-test-utils": "10.2.2-snapshot-17",
+    "@instructure/ui-themes": "10.2.2-snapshot-17",
+    "@testing-library/jest-dom": "^6.4.6",
+    "@testing-library/react": "^15.0.7",
+    "@testing-library/user-event": "^14.5.2",
+    "vitest": "^2.0.2"
   },
   "peerDependencies": {
     "react": ">=16.8 <=18"