@instructure/ui-heading 9.2.1-snapshot-6 → 9.2.1-snapshot-9

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.
 
-## [9.2.1-snapshot-6](https://github.com/instructure/instructure-ui/compare/v9.2.0...v9.2.1-snapshot-6) (2024-07-12)
+## [9.2.1-snapshot-9](https://github.com/instructure/instructure-ui/compare/v9.2.0...v9.2.1-snapshot-9) (2024-07-16)
 
 **Note:** Version bump only for package @instructure/ui-heading
 

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

@@ -0,0 +1,64 @@
+var _Heading, _Heading2, _Heading3, _Heading4, _Heading5;
+/*
+ * 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 { render, screen } from '@testing-library/react';
+import '@testing-library/jest-dom';
+import { Heading } from '../index';
+import { runAxeCheck } from '@instructure/ui-axe-check';
+describe('<Heading />', () => {
+  it('should render as an H2 element', async () => {
+    const _render = render(_Heading || (_Heading = /*#__PURE__*/React.createElement(Heading, null, "Hello World"))),
+      container = _render.container;
+    const heading = container.querySelector('[class$="-heading"]');
+    expect(heading.tagName).toBe('H2');
+  });
+  it('should render the children as text content', async () => {
+    const _render2 = render(_Heading2 || (_Heading2 = /*#__PURE__*/React.createElement(Heading, null, "Hello World"))),
+      container = _render2.container;
+    const heading = container.querySelector('[class$="-heading"]');
+    expect(heading).toHaveTextContent('Hello World');
+  });
+  it('should render as a SPAN if level is `reset`', async () => {
+    render(_Heading3 || (_Heading3 = /*#__PURE__*/React.createElement(Heading, {
+      level: "reset"
+    }, "Hello World")));
+    const heading = screen.getByText('Hello World');
+    expect(heading.tagName).toBe('SPAN');
+  });
+  it('should meet a11y standards', async () => {
+    const _render3 = render(_Heading4 || (_Heading4 = /*#__PURE__*/React.createElement(Heading, null, "Hello World"))),
+      container = _render3.container;
+    const axeCheck = await runAxeCheck(container);
+    expect(axeCheck).toBe(true);
+  });
+  it('should render with the specified tag when `as` prop is set', async () => {
+    render(_Heading5 || (_Heading5 = /*#__PURE__*/React.createElement(Heading, {
+      as: "div"
+    }, "Hello World")));
+    const heading = screen.getByText('Hello World');
+    expect(heading.tagName).toBe('DIV');
+  });
+});

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

@@ -0,0 +1,66 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
+var _react = _interopRequireDefault(require("react"));
+var _react2 = require("@testing-library/react");
+require("@testing-library/jest-dom");
+var _index = require("../index");
+var _runAxeCheck = require("@instructure/ui-axe-check/lib/runAxeCheck.js");
+var _Heading, _Heading2, _Heading3, _Heading4, _Heading5;
+/*
+ * 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('<Heading />', () => {
+  it('should render as an H2 element', async () => {
+    const _render = (0, _react2.render)(_Heading || (_Heading = /*#__PURE__*/_react.default.createElement(_index.Heading, null, "Hello World"))),
+      container = _render.container;
+    const heading = container.querySelector('[class$="-heading"]');
+    expect(heading.tagName).toBe('H2');
+  });
+  it('should render the children as text content', async () => {
+    const _render2 = (0, _react2.render)(_Heading2 || (_Heading2 = /*#__PURE__*/_react.default.createElement(_index.Heading, null, "Hello World"))),
+      container = _render2.container;
+    const heading = container.querySelector('[class$="-heading"]');
+    expect(heading).toHaveTextContent('Hello World');
+  });
+  it('should render as a SPAN if level is `reset`', async () => {
+    (0, _react2.render)(_Heading3 || (_Heading3 = /*#__PURE__*/_react.default.createElement(_index.Heading, {
+      level: "reset"
+    }, "Hello World")));
+    const heading = _react2.screen.getByText('Hello World');
+    expect(heading.tagName).toBe('SPAN');
+  });
+  it('should meet a11y standards', async () => {
+    const _render3 = (0, _react2.render)(_Heading4 || (_Heading4 = /*#__PURE__*/_react.default.createElement(_index.Heading, null, "Hello World"))),
+      container = _render3.container;
+    const axeCheck = await (0, _runAxeCheck.runAxeCheck)(container);
+    expect(axeCheck).toBe(true);
+  });
+  it('should render with the specified tag when `as` prop is set', async () => {
+    (0, _react2.render)(_Heading5 || (_Heading5 = /*#__PURE__*/_react.default.createElement(_index.Heading, {
+      as: "div"
+    }, "Hello World")));
+    const heading = _react2.screen.getByText('Hello World');
+    expect(heading.tagName).toBe('DIV');
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@instructure/ui-heading",
-  "version": "9.2.1-snapshot-6",
+  "version": "9.2.1-snapshot-9",
   "description": "A component for creating typographic headings",
   "author": "Instructure, Inc. Engineering and Product Design",
   "module": "./es/index.js",
@@ -24,20 +24,23 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.24.5",
-    "@instructure/console": "9.2.1-snapshot-6",
-    "@instructure/emotion": "9.2.1-snapshot-6",
-    "@instructure/shared-types": "9.2.1-snapshot-6",
-    "@instructure/ui-prop-types": "9.2.1-snapshot-6",
-    "@instructure/ui-react-utils": "9.2.1-snapshot-6",
-    "@instructure/ui-testable": "9.2.1-snapshot-6",
-    "@instructure/ui-view": "9.2.1-snapshot-6",
+    "@instructure/console": "9.2.1-snapshot-9",
+    "@instructure/emotion": "9.2.1-snapshot-9",
+    "@instructure/shared-types": "9.2.1-snapshot-9",
+    "@instructure/ui-prop-types": "9.2.1-snapshot-9",
+    "@instructure/ui-react-utils": "9.2.1-snapshot-9",
+    "@instructure/ui-testable": "9.2.1-snapshot-9",
+    "@instructure/ui-view": "9.2.1-snapshot-9",
     "prop-types": "^15.8.1"
   },
   "devDependencies": {
-    "@instructure/ui-babel-preset": "9.2.1-snapshot-6",
-    "@instructure/ui-test-locator": "9.2.1-snapshot-6",
-    "@instructure/ui-test-utils": "9.2.1-snapshot-6",
-    "@instructure/ui-themes": "9.2.1-snapshot-6"
+    "@instructure/ui-axe-check": "9.2.1-snapshot-9",
+    "@instructure/ui-babel-preset": "9.2.1-snapshot-9",
+    "@instructure/ui-test-utils": "9.2.1-snapshot-9",
+    "@instructure/ui-themes": "9.2.1-snapshot-9",
+    "@testing-library/jest-dom": "^6.4.5",
+    "@testing-library/react": "^15.0.7",
+    "vitest": "^1.6.0"
   },
   "peerDependencies": {
     "react": ">=16.8 <=18"

package/src/Heading/__new-tests__/Heading.test.tsx

@@ -0,0 +1,67 @@
+/*
+ * 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 { render, screen } from '@testing-library/react'
+import '@testing-library/jest-dom'
+
+import { Heading } from '../index'
+import { runAxeCheck } from '@instructure/ui-axe-check'
+
+describe('<Heading />', () => {
+  it('should render as an H2 element', async () => {
+    const { container } = render(<Heading>Hello World</Heading>)
+    const heading = container.querySelector('[class$="-heading"]')
+
+    expect(heading!.tagName).toBe('H2')
+  })
+
+  it('should render the children as text content', async () => {
+    const { container } = render(<Heading>Hello World</Heading>)
+    const heading = container.querySelector('[class$="-heading"]')
+
+    expect(heading).toHaveTextContent('Hello World')
+  })
+
+  it('should render as a SPAN if level is `reset`', async () => {
+    render(<Heading level="reset">Hello World</Heading>)
+    const heading = screen.getByText('Hello World')
+
+    expect(heading.tagName).toBe('SPAN')
+  })
+
+  it('should meet a11y standards', async () => {
+    const { container } = render(<Heading>Hello World</Heading>)
+    const axeCheck = await runAxeCheck(container)
+
+    expect(axeCheck).toBe(true)
+  })
+
+  it('should render with the specified tag when `as` prop is set', async () => {
+    render(<Heading as="div">Hello World</Heading>)
+    const heading = screen.getByText('Hello World')
+
+    expect(heading.tagName).toBe('DIV')
+  })
+})

package/tsconfig.build.json

@@ -10,12 +10,12 @@
     { "path": "../console/tsconfig.build.json" },
     { "path": "../emotion/tsconfig.build.json" },
     { "path": "../shared-types/tsconfig.build.json" },
+    { "path": "../ui-axe-check/tsconfig.build.json" },
     { "path": "../ui-prop-types/tsconfig.build.json" },
     { "path": "../ui-react-utils/tsconfig.build.json" },
     { "path": "../ui-testable/tsconfig.build.json" },
     { "path": "../ui-view/tsconfig.build.json" },
     { "path": "../ui-babel-preset/tsconfig.build.json" },
-    { "path": "../ui-test-locator/tsconfig.build.json" },
     { "path": "../ui-test-utils/tsconfig.build.json" },
     { "path": "../ui-themes/tsconfig.build.json" }
   ]