@atlaskit/heading 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/heading
 
+## 3.1.0
+
+### Minor Changes
+
+- [#166220](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/166220)
+  [`c02bd4e1ce076`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c02bd4e1ce076) -
+  Removed unused types related to the old Heading API. Exported types for the Heading component are
+  now `HeadingProps` and `HeadingColor`. Removed circular type references.
+
 ## 3.0.0
 
 ### Major Changes

package/dist/es2019/heading.partial.js

@@ -3,6 +3,7 @@
  * @jsx jsx
  */
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+
 import { css, jsx } from '@emotion/react';
 import { UNSAFE_inverseColorMap, UNSAFE_useSurface } from '@atlaskit/primitives';
 import { useHeading } from './heading-context';

package/dist/esm/heading.partial.js

@@ -4,6 +4,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
  * @jsx jsx
  */
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
+
 import { css, jsx } from '@emotion/react';
 import { UNSAFE_inverseColorMap, UNSAFE_useSurface } from '@atlaskit/primitives';
 import { useHeading } from './heading-context';

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

@@ -2,8 +2,41 @@
  * @jsxRuntime classic
  * @jsx jsx
  */
+import { type ReactNode } from 'react';
 import { jsx, type SerializedStyles } from '@emotion/react';
-import type { NewHeadingProps } from './types';
+export type HeadingColor = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
+export type HeadingProps = {
+    /**
+     * Heading size. This value is detached from the specific heading level applied to allow for more flexibility.
+     * Use instead of the deprecated `level` prop.
+     *
+     */
+    size: HeadingSize;
+    /**
+     * Allows the component to be rendered as the specified DOM element, overriding a default element set by `level` prop.
+     */
+    as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
+    /**
+     * Token representing text color with a built-in fallback value.
+     * Will apply inverse text color automatically if placed within a Box with bold background color.
+     * Defaults to `color.text`.
+     */
+    color?: HeadingColor;
+    /**
+     * The text of the heading.
+     */
+    children: ReactNode;
+    /**
+     * Unique identifier for the heading DOM element.
+     */
+    id?: string;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+     */
+    testId?: string;
+};
 /**
  * __Heading__
  *
@@ -15,7 +48,7 @@ import type { NewHeadingProps } from './types';
  * <Heading size="xxlarge">Page title</Heading>
  * ```
  */
-declare const Heading: ({ children, size, id, testId, as, color: colorProp }: NewHeadingProps) => jsx.JSX.Element;
+declare const Heading: ({ children, size, id, testId, as, color: colorProp }: HeadingProps) => jsx.JSX.Element;
 /**
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
  * @codegen <<SignedSource::df829c6c0aa19bb57c0c77dc08d12d60>>

package/dist/types/index.d.ts

@@ -1,3 +1,2 @@
-export { default } from './heading.partial';
+export { default, type HeadingProps } from './heading.partial';
 export { default as HeadingContextProvider } from './heading-context';
-export type { HeadingProps } from './types';

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

@@ -2,8 +2,41 @@
  * @jsxRuntime classic
  * @jsx jsx
  */
+import { type ReactNode } from 'react';
 import { jsx, type SerializedStyles } from '@emotion/react';
-import type { NewHeadingProps } from './types';
+export type HeadingColor = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
+export type HeadingProps = {
+    /**
+     * Heading size. This value is detached from the specific heading level applied to allow for more flexibility.
+     * Use instead of the deprecated `level` prop.
+     *
+     */
+    size: HeadingSize;
+    /**
+     * Allows the component to be rendered as the specified DOM element, overriding a default element set by `level` prop.
+     */
+    as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
+    /**
+     * Token representing text color with a built-in fallback value.
+     * Will apply inverse text color automatically if placed within a Box with bold background color.
+     * Defaults to `color.text`.
+     */
+    color?: HeadingColor;
+    /**
+     * The text of the heading.
+     */
+    children: ReactNode;
+    /**
+     * Unique identifier for the heading DOM element.
+     */
+    id?: string;
+    /**
+     * A `testId` prop is provided for specified elements, which is a unique
+     * string that appears as a data attribute `data-testid` in the rendered code,
+     * serving as a hook for automated tests.
+     */
+    testId?: string;
+};
 /**
  * __Heading__
  *
@@ -15,7 +48,7 @@ import type { NewHeadingProps } from './types';
  * <Heading size="xxlarge">Page title</Heading>
  * ```
  */
-declare const Heading: ({ children, size, id, testId, as, color: colorProp }: NewHeadingProps) => jsx.JSX.Element;
+declare const Heading: ({ children, size, id, testId, as, color: colorProp }: HeadingProps) => jsx.JSX.Element;
 /**
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
  * @codegen <<SignedSource::df829c6c0aa19bb57c0c77dc08d12d60>>

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

@@ -1,3 +1,2 @@
-export { default } from './heading.partial';
+export { default, type HeadingProps } from './heading.partial';
 export { default as HeadingContextProvider } from './heading-context';
-export type { HeadingProps } from './types';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/heading",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"description": "A heading is a typography component used to display text in different sizes and formats.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"

package/dist/cjs/types.js

@@ -1,5 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});

package/dist/es2019/types.js

@@ -1 +0,0 @@
-export {};

package/dist/esm/types.js

@@ -1 +0,0 @@
-export {};

package/dist/types/types.d.ts

@@ -1,74 +0,0 @@
-import { type ReactNode } from 'react';
-import { type HeadingSize } from './heading.partial';
-type HeadingPropsBase = {
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique
-     * string that appears as a data attribute `data-testid` in the rendered code,
-     * serving as a hook for automated tests.
-     */
-    testId?: string;
-    /**
-     * The text of the heading.
-     */
-    children: ReactNode;
-    /**
-     * Unique identifier for the heading DOM element.
-     */
-    id?: string;
-    /**
-     * Allows the component to be rendered as the specified DOM element, overriding a default element set by `level` prop.
-     */
-    as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
-};
-export type OldHeadingProps = HeadingPropsBase & {
-    /**
-     * Text color of the heading. Use `"inverse"` option for a light text color over a dark background.
-     * Defaults to `"default"`.
-     */
-    color?: 'inverse' | 'default';
-    /**
-     * @private
-     * @deprecated Use `size` prop instead.
-     * The heading level as defined by the Atlassian Design [typography foundations](/foundations/typography/). The `level` prop affects the actual HTML element rendered in the DOM:
-     * @example
-     * ```js
-     * const levelMap = {
-     *    h900: 'h1',
-     *    h800: 'h1',
-     *    h700: 'h2',
-     *    h600: 'h3',
-     *    h500: 'h4',
-     *    h400: 'h5',
-     *    h300: 'h6',
-     *    h200: 'div',
-     *    h100: 'div',
-     * };
-     * ```
-     *
-     * It's important to note that the final DOM may be impacted by the parent heading level context because of inferred accessibility level correction.
-     * Therefore, it is recommended to check the final DOM to confirm the actual rendered HTML element.
-     */
-    level: 'h900' | 'h800' | 'h700' | 'h600' | 'h500' | 'h400' | 'h300' | 'h200' | 'h100';
-    /**
-     * Heading size. Use instead of the deprecated `level` prop.
-     */
-    size?: never;
-};
-export type HeadingColor = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
-export type NewHeadingProps = HeadingPropsBase & {
-    /**
-     * Token representing text color with a built-in fallback value.
-     * Will apply inverse text color automatically if placed within a Box with bold background color.
-     * Defaults to `color.text`.
-     */
-    color?: HeadingColor;
-    /**
-     * Heading size. This value is detached from the specific heading level applied to allow for more flexibility.
-     * Use instead of the deprecated `level` prop.
-     *
-     */
-    size: HeadingSize;
-    level?: never;
-};
-export type HeadingProps = OldHeadingProps | NewHeadingProps;
-export {};

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

@@ -1,74 +0,0 @@
-import { type ReactNode } from 'react';
-import { type HeadingSize } from './heading.partial';
-type HeadingPropsBase = {
-    /**
-     * A `testId` prop is provided for specified elements, which is a unique
-     * string that appears as a data attribute `data-testid` in the rendered code,
-     * serving as a hook for automated tests.
-     */
-    testId?: string;
-    /**
-     * The text of the heading.
-     */
-    children: ReactNode;
-    /**
-     * Unique identifier for the heading DOM element.
-     */
-    id?: string;
-    /**
-     * Allows the component to be rendered as the specified DOM element, overriding a default element set by `level` prop.
-     */
-    as?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
-};
-export type OldHeadingProps = HeadingPropsBase & {
-    /**
-     * Text color of the heading. Use `"inverse"` option for a light text color over a dark background.
-     * Defaults to `"default"`.
-     */
-    color?: 'inverse' | 'default';
-    /**
-     * @private
-     * @deprecated Use `size` prop instead.
-     * The heading level as defined by the Atlassian Design [typography foundations](/foundations/typography/). The `level` prop affects the actual HTML element rendered in the DOM:
-     * @example
-     * ```js
-     * const levelMap = {
-     *    h900: 'h1',
-     *    h800: 'h1',
-     *    h700: 'h2',
-     *    h600: 'h3',
-     *    h500: 'h4',
-     *    h400: 'h5',
-     *    h300: 'h6',
-     *    h200: 'div',
-     *    h100: 'div',
-     * };
-     * ```
-     *
-     * It's important to note that the final DOM may be impacted by the parent heading level context because of inferred accessibility level correction.
-     * Therefore, it is recommended to check the final DOM to confirm the actual rendered HTML element.
-     */
-    level: 'h900' | 'h800' | 'h700' | 'h600' | 'h500' | 'h400' | 'h300' | 'h200' | 'h100';
-    /**
-     * Heading size. Use instead of the deprecated `level` prop.
-     */
-    size?: never;
-};
-export type HeadingColor = 'color.text' | 'color.text.inverse' | 'color.text.warning.inverse';
-export type NewHeadingProps = HeadingPropsBase & {
-    /**
-     * Token representing text color with a built-in fallback value.
-     * Will apply inverse text color automatically if placed within a Box with bold background color.
-     * Defaults to `color.text`.
-     */
-    color?: HeadingColor;
-    /**
-     * Heading size. This value is detached from the specific heading level applied to allow for more flexibility.
-     * Use instead of the deprecated `level` prop.
-     *
-     */
-    size: HeadingSize;
-    level?: never;
-};
-export type HeadingProps = OldHeadingProps | NewHeadingProps;
-export {};