@atlaskit/heading 5.3.0 → 5.4.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/heading
 
+## 5.4.0
+
+### Minor Changes
+
+- [`8fdea38bd31f8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/8fdea38bd31f8) -
+  Autofix: add explicit package exports (barrel removal)
+
+## 5.3.1
+
+### Patch Changes
+
+- [`02483200273ec`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/02483200273ec) -
+  Enrol all Design System UI packages into the React Compiler with platform gating via
+  isReactCompilerActivePlatform.
+- Updated dependencies
+
 ## 5.3.0
 
 ### Minor Changes

package/dist/cjs/entry-points/heading-context.js

@@ -0,0 +1,20 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _headingContext.default;
+  }
+});
+Object.defineProperty(exports, "useHeading", {
+  enumerable: true,
+  get: function get() {
+    return _headingContext.useHeading;
+  }
+});
+var _headingContext = _interopRequireWildcard(require("../heading-context"));
+function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }

package/dist/cjs/entry-points/heading.js

@@ -0,0 +1,13 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "default", {
+  enumerable: true,
+  get: function get() {
+    return _heading.default;
+  }
+});
+var _heading = _interopRequireDefault(require("../heading"));

package/dist/cjs/heading.js

@@ -1,4 +1,4 @@
-/* heading.tsx generated by @compiled/babel-plugin v0.38.1 */
+/* heading.tsx generated by @compiled/babel-plugin v0.39.1 */
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

package/dist/es2019/entry-points/heading-context.js

@@ -0,0 +1,2 @@
+export { useHeading } from '../heading-context';
+export { default } from '../heading-context';

package/dist/es2019/entry-points/heading.js

@@ -0,0 +1 @@
+export { default } from '../heading';

package/dist/es2019/heading.js

@@ -1,4 +1,4 @@
-/* heading.tsx generated by @compiled/babel-plugin v0.38.1 */
+/* heading.tsx generated by @compiled/babel-plugin v0.39.1 */
 /* eslint-disable @atlaskit/ui-styling-standard/no-nested-selectors, @atlaskit/ui-styling-standard/no-unsafe-selectors */
 import "./heading.compiled.css";
 import * as React from 'react';

package/dist/esm/entry-points/heading-context.js

@@ -0,0 +1,2 @@
+export { useHeading } from '../heading-context';
+export { default } from '../heading-context';

package/dist/esm/entry-points/heading.js

@@ -0,0 +1 @@
+export { default } from '../heading';

package/dist/esm/heading.js

@@ -1,4 +1,4 @@
-/* heading.tsx generated by @compiled/babel-plugin v0.38.1 */
+/* heading.tsx generated by @compiled/babel-plugin v0.39.1 */
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import "./heading.compiled.css";
 import * as React from 'react';

package/dist/types/entry-points/heading-context.d.ts

@@ -0,0 +1,2 @@
+export { useHeading } from '../heading-context';
+export { default } from '../heading-context';

package/dist/types/entry-points/heading.d.ts

@@ -0,0 +1,2 @@
+export type { HeadingProps } from '../heading';
+export { default } from '../heading';

package/dist/types/heading-context.d.ts

@@ -4,10 +4,7 @@ type HeadingElement = `h${1 | 2 | 3 | 4 | 5 | 6}` | 'div';
 /**
  * Infers the correct heading markup based on the current heading level context.
  */
-export declare const useHeading: (fallback: HeadingElement) => readonly [
-    HeadingLevel,
-    HeadingElement
-];
+export declare const useHeading: (fallback: HeadingElement) => readonly [HeadingLevel, HeadingElement];
 interface HeadingLevelContextProps {
     /**
      * Optional - only apply this value if the intent is to reset the heading context outside the normal content flow, for example inside a `section`.
@@ -34,5 +31,5 @@ interface HeadingLevelContextProps {
  * </HeadingContext>
  * ```
  */
-declare const HeadingLevelContextProvider: ({ children, value }: HeadingLevelContextProps) => React.JSX.Element;
+declare const HeadingLevelContextProvider: ({ children, value, }: HeadingLevelContextProps) => React.JSX.Element;
 export default HeadingLevelContextProvider;

package/dist/types-ts4.5/entry-points/heading-context.d.ts

@@ -0,0 +1,2 @@
+export { useHeading } from '../heading-context';
+export { default } from '../heading-context';

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

@@ -0,0 +1,2 @@
+export type { HeadingProps } from '../heading';
+export { default } from '../heading';

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

@@ -34,5 +34,5 @@ interface HeadingLevelContextProps {
  * </HeadingContext>
  * ```
  */
-declare const HeadingLevelContextProvider: ({ children, value }: HeadingLevelContextProps) => React.JSX.Element;
+declare const HeadingLevelContextProvider: ({ children, value, }: HeadingLevelContextProps) => React.JSX.Element;
 export default HeadingLevelContextProvider;

package/heading/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/heading/heading",
+  "main": "../dist/cjs/entry-points/heading.js",
+  "module": "../dist/esm/entry-points/heading.js",
+  "module:es2019": "../dist/es2019/entry-points/heading.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/entry-points/heading.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/entry-points/heading.d.ts"
+      ]
+    }
+  }
+}

package/heading-context/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "@atlaskit/heading/heading-context",
+  "main": "../dist/cjs/entry-points/heading-context.js",
+  "module": "../dist/esm/entry-points/heading-context.js",
+  "module:es2019": "../dist/es2019/entry-points/heading-context.js",
+  "sideEffects": [
+    "**/*.compiled.css"
+  ],
+  "types": "../dist/types/entry-points/heading-context.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/entry-points/heading-context.d.ts"
+      ]
+    }
+  }
+}

package/heading.docs.tsx

@@ -0,0 +1,94 @@
+import path from 'path';
+
+import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+
+const documentation: ComponentStructuredContentSource[] = [
+	{
+		name: 'Heading',
+		description:
+			'A component for creating accessible, consistently styled headings with proper hierarchy. Headings are sized to contrast with content, increase visual hierarchy, and help readers easily understand the structure of content.',
+		status: 'general-availability',
+		import: {
+			name: 'Heading',
+			package: '@atlaskit/heading',
+			type: 'default',
+			packagePath: path.resolve(__dirname),
+			packageJson: require('./package.json'),
+		},
+		usageGuidelines: [
+			'Use the `HeadingContextProvider` offering to maintain heading levels in complex layouts',
+			'Maintain proper heading hierarchy',
+			'Keep headings concise and meaningful',
+			'Use sentence case for most headings',
+			'Use the `color` prop for inverse text on dark backgrounds',
+			'Do NOT use any inline styles, you must use the `size` (required) and `color` (optional) props available',
+		],
+		contentGuidelines: [
+			'Use clear, descriptive heading text',
+			'Maintain proper heading hierarchy',
+			'Keep headings concise and meaningful',
+			'Use sentence case for most headings',
+			'Make headings descriptive of the content that follows',
+		],
+		accessibilityGuidelines: [
+			'Maintain proper heading hierarchy (h1 to h6)',
+			'Use only one h1 per page for main page titles',
+			'Ensure minimum 4.5:1 color contrast for text readability',
+			'Use clear, descriptive heading text that describes the content below',
+		],
+		examples: [
+			{
+				name: 'Basic',
+				description: 'Basic example',
+				source: path.resolve(__dirname, './examples/ai/basic.tsx'),
+			},
+		],
+		keywords: [
+			'heading',
+			'title',
+			'header',
+			'typography',
+			'text',
+			'h1',
+			'h2',
+			'h3',
+			'h4',
+			'h5',
+			'h6',
+		],
+		categories: ['primitive', 'data-display'],
+	},
+	{
+		name: 'HeadingContextProvider',
+		description:
+			'A context provider that allows you to configure the default HTML heading level for all headings within its subtree. Useful for maintaining proper heading hierarchy in complex layouts.',
+		status: 'general-availability',
+		import: {
+			name: 'HeadingContextProvider',
+			package: '@atlaskit/heading',
+			type: 'named',
+			packagePath: path.resolve(__dirname),
+			packageJson: require('./package.json'),
+		},
+		usageGuidelines: [
+			'Wrap sections that need different heading hierarchy',
+			'Use for complex layouts where heading levels need adjustment',
+		],
+		contentGuidelines: [
+			'Ensure proper heading hierarchy is maintained',
+			'Use clear, descriptive heading text',
+			'Keep headings concise and meaningful',
+		],
+		examples: [
+			{
+				name: 'Heading Context Provider',
+				description: 'Heading Context Provider example',
+				source: path.resolve(__dirname, './examples/ai/heading-context-provider.tsx'),
+			},
+		],
+		keywords: ['heading', 'context', 'provider', 'hierarchy', 'accessibility'],
+		categories: ['primitive', 'data-display'],
+	},
+];
+
+export default documentation;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/heading",
-	"version": "5.3.0",
+	"version": "5.4.0",
 	"description": "A heading is a typography component used to display text in different sizes and formats.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -17,6 +17,13 @@
 	],
 	"atlaskit:src": "src/index.tsx",
 	"atlassian": {
+		"react-compiler": {
+			"enabled": true,
+			"gating": {
+				"source": "@atlassian/react-compiler-gating",
+				"importSpecifierName": "isReactCompilerActivePlatform"
+			}
+		},
 		"team": "Design System Team",
 		"website": {
 			"name": "Heading",
@@ -24,10 +31,10 @@
 		}
 	},
 	"dependencies": {
-		"@atlaskit/primitives": "^18.0.0",
-		"@atlaskit/tokens": "^11.0.0",
+		"@atlaskit/primitives": "^18.1.0",
+		"@atlaskit/tokens": "^11.4.0",
 		"@babel/runtime": "^7.0.0",
-		"@compiled/react": "^0.18.6"
+		"@compiled/react": "^0.20.0"
 	},
 	"peerDependencies": {
 		"react": "^18.2.0"
@@ -37,10 +44,12 @@
 		"@af/formatting": "workspace:^",
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/button": "^23.9.0",
+		"@atlaskit/button": "^23.11.0",
 		"@atlaskit/css": "^0.19.0",
 		"@atlassian/codegen": "^0.1.0",
+		"@atlassian/react-compiler-gating": "workspace:^",
 		"@atlassian/ssr-tests": "workspace:^",
+		"@atlassian/structured-docs-types": "workspace:^",
 		"@testing-library/react": "^16.3.0",
 		"react-dom": "^18.2.0",
 		"ts-node": "^10.9.1"