@atlaskit/heading 1.8.1 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/heading
 
+## 2.0.0
+
+### Major Changes
+
+- [#81744](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/81744) [`bc7085853ea2`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/bc7085853ea2) - Renamed `variant` prop to `size`. The prop values remain unchanged.
+
 ## 1.8.1
 
 ### Patch Changes

package/dist/cjs/heading.js

@@ -11,7 +11,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
 var _react = require("@emotion/react");
 var _headingContext = require("./heading-context");
 var _heading = _interopRequireDefault(require("./heading.partial"));
-var _excluded = ["level", "size", "variant"];
+var _excluded = ["level", "size"];
 /** @jsx jsx */
 // https://atlassian.design/foundations/typography
 var levelMap = {
@@ -136,7 +136,6 @@ var Heading = function Heading(_ref) {
 var _default = exports.default = function _default(_ref2) {
   var level = _ref2.level,
     size = _ref2.size,
-    variant = _ref2.variant,
     props = (0, _objectWithoutProperties2.default)(_ref2, _excluded);
   return level ?
   // eslint-disable-next-line jsx-a11y/heading-has-content
@@ -145,7 +144,6 @@ var _default = exports.default = function _default(_ref2) {
   }, props)) :
   // eslint-disable-next-line jsx-a11y/heading-has-content
   (0, _react.jsx)(_heading.default, (0, _extends2.default)({
-    variant: variant,
     size: size
   }, props));
 };

package/dist/cjs/heading.partial.js

@@ -43,7 +43,6 @@ var inverseStyles = (0, _react.css)({
 var Heading = function Heading(_ref) {
   var children = _ref.children,
     size = _ref.size,
-    variant = _ref.variant,
     id = _ref.id,
     testId = _ref.testId,
     as = _ref.as,
@@ -53,12 +52,9 @@ var Heading = function Heading(_ref) {
     throw new Error('`as` prop should be a string.');
   }
 
-  // TODO: Temporary to move variant over to size
-  var localSize = variant || size;
-
   // Technically size can be undefined here due to how the types work.
   // Once removing the level prop this assertion can be removed since size will be a required prop.
-  var _useHeading = (0, _headingContext.useHeading)(sizeTagMap[localSize]),
+  var _useHeading = (0, _headingContext.useHeading)(sizeTagMap[size]),
     _useHeading2 = (0, _slicedToArray2.default)(_useHeading, 2),
     hLevel = _useHeading2[0],
     inferredElement = _useHeading2[1];
@@ -69,7 +65,7 @@ var Heading = function Heading(_ref) {
     "data-testid": testId,
     role: needsAriaRole ? 'heading' : undefined,
     "aria-level": needsAriaRole ? hLevel : undefined,
-    css: [headingResetStyles, localSize && headingSizeStylesMap[localSize], color === 'inverse' && inverseStyles]
+    css: [headingResetStyles, size && headingSizeStylesMap[size], color === 'inverse' && inverseStyles]
   }, children);
 };
 

package/dist/es2019/heading.js

@@ -123,7 +123,6 @@ const Heading = ({
 export default (({
   level,
   size,
-  variant,
   ...props
 }) => {
   return level ?
@@ -133,7 +132,6 @@ export default (({
   }, props)) :
   // eslint-disable-next-line jsx-a11y/heading-has-content
   jsx(NewHeading, _extends({
-    variant: variant,
     size: size
   }, props));
 });

package/dist/es2019/heading.partial.js

@@ -34,7 +34,6 @@ const inverseStyles = css({
 const Heading = ({
   children,
   size,
-  variant,
   id,
   testId,
   as,
@@ -44,12 +43,9 @@ const Heading = ({
     throw new Error('`as` prop should be a string.');
   }
 
-  // TODO: Temporary to move variant over to size
-  const localSize = variant || size;
-
   // Technically size can be undefined here due to how the types work.
   // Once removing the level prop this assertion can be removed since size will be a required prop.
-  const [hLevel, inferredElement] = useHeading(sizeTagMap[localSize]);
+  const [hLevel, inferredElement] = useHeading(sizeTagMap[size]);
   const Component = as || inferredElement;
   const needsAriaRole = Component === 'div' && hLevel;
   return jsx(Component, {
@@ -57,7 +53,7 @@ const Heading = ({
     "data-testid": testId,
     role: needsAriaRole ? 'heading' : undefined,
     "aria-level": needsAriaRole ? hLevel : undefined,
-    css: [headingResetStyles, localSize && headingSizeStylesMap[localSize], color === 'inverse' && inverseStyles]
+    css: [headingResetStyles, size && headingSizeStylesMap[size], color === 'inverse' && inverseStyles]
   }, children);
 };
 

package/dist/esm/heading.js

@@ -1,7 +1,7 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
-var _excluded = ["level", "size", "variant"];
+var _excluded = ["level", "size"];
 /** @jsx jsx */
 import { css, jsx } from '@emotion/react';
 import { useHeading } from './heading-context';
@@ -129,7 +129,6 @@ var Heading = function Heading(_ref) {
 export default (function (_ref2) {
   var level = _ref2.level,
     size = _ref2.size,
-    variant = _ref2.variant,
     props = _objectWithoutProperties(_ref2, _excluded);
   return level ?
   // eslint-disable-next-line jsx-a11y/heading-has-content
@@ -138,7 +137,6 @@ export default (function (_ref2) {
   }, props)) :
   // eslint-disable-next-line jsx-a11y/heading-has-content
   jsx(NewHeading, _extends({
-    variant: variant,
     size: size
   }, props));
 });

package/dist/esm/heading.partial.js

@@ -35,7 +35,6 @@ var inverseStyles = css({
 var Heading = function Heading(_ref) {
   var children = _ref.children,
     size = _ref.size,
-    variant = _ref.variant,
     id = _ref.id,
     testId = _ref.testId,
     as = _ref.as,
@@ -45,12 +44,9 @@ var Heading = function Heading(_ref) {
     throw new Error('`as` prop should be a string.');
   }
 
-  // TODO: Temporary to move variant over to size
-  var localSize = variant || size;
-
   // Technically size can be undefined here due to how the types work.
   // Once removing the level prop this assertion can be removed since size will be a required prop.
-  var _useHeading = useHeading(sizeTagMap[localSize]),
+  var _useHeading = useHeading(sizeTagMap[size]),
     _useHeading2 = _slicedToArray(_useHeading, 2),
     hLevel = _useHeading2[0],
     inferredElement = _useHeading2[1];
@@ -61,7 +57,7 @@ var Heading = function Heading(_ref) {
     "data-testid": testId,
     role: needsAriaRole ? 'heading' : undefined,
     "aria-level": needsAriaRole ? hLevel : undefined,
-    css: [headingResetStyles, localSize && headingSizeStylesMap[localSize], color === 'inverse' && inverseStyles]
+    css: [headingResetStyles, size && headingSizeStylesMap[size], color === 'inverse' && inverseStyles]
   }, children);
 };
 

package/dist/types/heading.d.ts

@@ -1,5 +1,5 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import type { HeadingProps } from './types';
-declare const _default: ({ level, size, variant, ...props }: HeadingProps) => jsx.JSX.Element;
+declare const _default: ({ level, size, ...props }: HeadingProps) => jsx.JSX.Element;
 export default _default;

package/dist/types/heading.partial.d.ts

@@ -12,7 +12,7 @@ import type { HeadingProps } from './types';
  * <Heading size="xxlarge">Page title</Heading>
  * ```
  */
-declare const Heading: ({ children, size, variant, id, testId, as, color, }: HeadingProps) => jsx.JSX.Element;
+declare const Heading: ({ children, size, id, testId, as, color, }: HeadingProps) => jsx.JSX.Element;
 /**
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
  * @codegen <<SignedSource::057c0fe2015c2071afe3d694c5afcc0e>>

package/dist/types/types.d.ts

@@ -52,7 +52,6 @@ export type HeadingProps = {
      * Heading size. Use instead of the deprecated `level` prop.
      */
     size?: never;
-    variant?: never;
 } | {
     level?: never;
     /**
@@ -61,9 +60,5 @@ export type HeadingProps = {
      *
      * This prop will only work if the typography tokens theme is applied on the page.
      */
-    size?: HeadingSize;
-    /**
-     * @deprecated. Use `size` instead.
-     */
-    variant?: HeadingSize;
+    size: HeadingSize;
 });

package/dist/types-ts4.5/heading.d.ts

@@ -1,5 +1,5 @@
 /** @jsx jsx */
 import { jsx } from '@emotion/react';
 import type { HeadingProps } from './types';
-declare const _default: ({ level, size, variant, ...props }: HeadingProps) => jsx.JSX.Element;
+declare const _default: ({ level, size, ...props }: HeadingProps) => jsx.JSX.Element;
 export default _default;

package/dist/types-ts4.5/heading.partial.d.ts

@@ -12,7 +12,7 @@ import type { HeadingProps } from './types';
  * <Heading size="xxlarge">Page title</Heading>
  * ```
  */
-declare const Heading: ({ children, size, variant, id, testId, as, color, }: HeadingProps) => jsx.JSX.Element;
+declare const Heading: ({ children, size, id, testId, as, color, }: HeadingProps) => jsx.JSX.Element;
 /**
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
  * @codegen <<SignedSource::057c0fe2015c2071afe3d694c5afcc0e>>

package/dist/types-ts4.5/types.d.ts

@@ -52,7 +52,6 @@ export type HeadingProps = {
      * Heading size. Use instead of the deprecated `level` prop.
      */
     size?: never;
-    variant?: never;
 } | {
     level?: never;
     /**
@@ -61,9 +60,5 @@ export type HeadingProps = {
      *
      * This prop will only work if the typography tokens theme is applied on the page.
      */
-    size?: HeadingSize;
-    /**
-     * @deprecated. Use `size` instead.
-     */
-    variant?: HeadingSize;
+    size: HeadingSize;
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/heading",
-  "version": "1.8.1",
+  "version": "2.0.0",
   "description": "A heading is a typography component used to display text in different sizes and formats.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -62,7 +62,7 @@
       "dom-events": "use-bind-event-listener",
       "design-system": "v1",
       "styling": [
-        "static"
+        "emotion"
       ],
       "ui-components": "lite-mode",
       "analytics": "analytics-next",
@@ -86,4 +86,4 @@
   },
   "homepage": "https://atlassian.design/components/heading/",
   "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.0"
-}
+}