@atlaskit/visually-hidden 3.1.0 → 4.0.1

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @atlaskit/visually-hidden
 
+## 4.0.1
+
+### Patch Changes
+
+- [`ee28cf33718b0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ee28cf33718b0) -
+  Add @atlassian/react-compiler-gating as a runtime dependency to enable React Compiler platform
+  gating.
+- Updated dependencies
+
+## 4.0.0
+
+### Major Changes
+
+- [`f2dc9097319f0`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/f2dc9097319f0) - ###
+  Dropped support for _legacy_ Typescript 4 types. **Typescript 5 is now the new minimum**.
+
+  Removes the `typesVersions` property and `dist/types-ts4.5` directory from the dist.
+
+  Types are now exclusively via the `"types": "dist/types/index.d.ts"` property.
+
+  ```diff
+  - "typesVersions": {
+  -    ">=4.5 <4.9": {
+  -        "*": [
+  -            "dist/types-ts4.5/*",
+  -            "dist/types-ts4.5/index.d.ts"
+  -        ]
+  -    }
+  - },
+  ```
+
 ## 3.1.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/visually-hidden",
-	"version": "3.1.0",
+	"version": "4.0.1",
 	"description": "A utility that hides content from the screen while retaining readability by screen readers for accessibility.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -31,6 +31,7 @@
 		}
 	},
 	"dependencies": {
+		"@atlassian/react-compiler-gating": "^0.2.0",
 		"@babel/runtime": "^7.0.0",
 		"@compiled/react": "^0.20.0"
 	},
@@ -41,16 +42,16 @@
 		"@af/accessibility-testing": "workspace:^",
 		"@af/integration-testing": "workspace:^",
 		"@af/visual-regression": "workspace:^",
-		"@atlaskit/button": "^23.11.0",
-		"@atlaskit/docs": "^11.8.0",
-		"@atlaskit/link": "^3.4.0",
-		"@atlaskit/section-message": "^8.12.0",
-		"@atlaskit/toggle": "^15.6.0",
-		"@atlaskit/tokens": "^13.0.0",
-		"@atlassian/react-compiler-gating": "workspace:^",
+		"@atlaskit/button": "^24.1.0",
+		"@atlaskit/docs": "^12.0.0",
+		"@atlaskit/link": "^4.0.0",
+		"@atlaskit/section-message": "^9.1.0",
+		"@atlaskit/toggle": "^17.0.0",
+		"@atlaskit/tokens": "^15.0.0",
 		"@atlassian/ssr-tests": "workspace:^",
 		"@atlassian/structured-docs-types": "workspace:^",
 		"@testing-library/react": "^16.3.0",
+		"react": "^18.2.0",
 		"react-dom": "^18.2.0"
 	},
 	"techstack": {
@@ -74,13 +75,5 @@
 			"deprecation": "no-deprecated-imports"
 		}
 	},
-	"typesVersions": {
-		">=4.5 <4.9": {
-			"*": [
-				"dist/types-ts4.5/*",
-				"dist/types-ts4.5/index.d.ts"
-			]
-		}
-	},
 	"homepage": "https://atlassian.design/components/visually-hidden/"
 }

package/types/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "**/*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/types.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/types.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/types.d.ts"
 }

package/visually-hidden/package.json

@@ -6,12 +6,5 @@
   "sideEffects": [
     "**/*.compiled.css"
   ],
-  "types": "../dist/types/entry-points/visually-hidden.d.ts",
-  "typesVersions": {
-    ">=4.5 <5.9": {
-      "*": [
-        "../dist/types-ts4.5/entry-points/visually-hidden.d.ts"
-      ]
-    }
-  }
+  "types": "../dist/types/entry-points/visually-hidden.d.ts"
 }

package/visually-hidden.docs.tsx

@@ -1,46 +1,48 @@
 import path from 'path';
 
-import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
 
-const documentation: ComponentStructuredContentSource[] = [
-	{
-		name: 'VisuallyHidden',
-		description:
-			'Content hidden from sight but available to screen readers. Use when meaning is clear visually but not to assistive technology.',
-		status: 'general-availability',
-		import: {
+const documentation: StructuredContentSource = {
+	components: [
+		{
 			name: 'VisuallyHidden',
-			package: '@atlaskit/visually-hidden',
-			type: 'default',
-			packagePath: path.resolve(__dirname),
-			packageJson: require('./package.json'),
-		},
-		usageGuidelines: [
-			'Use when meaning is clear visually but not to assistive technology',
-			'Avoid clutter—verbose screen-reader-only text can be more harmful than helpful',
-			'Use the role prop for semantic meaning when needed',
-		],
-		contentGuidelines: [
-			'Use clear, descriptive hidden content',
-			'Ensure content adds value for screen readers',
-			'Keep content concise but meaningful',
-		],
-		accessibilityGuidelines: [
-			'Use for screen reader only content when visual context is insufficient for AT',
-			'Use role prop for semantic meaning when appropriate',
-			'Balance clarity with brevity—avoid overwhelming screen reader users',
-			'Prefer over aria-label in some cases when screen readers need to translate or announce full phrasing',
-		],
-		examples: [
-			{
-				name: '00 Basic',
-				description: '00 Basic example',
-				source: path.resolve(__dirname, './examples/00-basic.tsx'),
+			description:
+				'Content hidden from sight but available to screen readers. Use when meaning is clear visually but not to assistive technology.',
+			status: 'general-availability',
+			import: {
+				name: 'VisuallyHidden',
+				package: '@atlaskit/visually-hidden',
+				type: 'default',
+				packagePath: path.resolve(__dirname),
+				packageJson: require('./package.json'),
 			},
-		],
-		keywords: ['hidden', 'accessibility', 'screen-reader', 'aria', 'utility'],
-		categories: ['utility'],
-	},
-];
+			usageGuidelines: [
+				'Use when meaning is clear visually but not to assistive technology',
+				'Avoid clutter—verbose screen-reader-only text can be more harmful than helpful',
+				'Use the role prop for semantic meaning when needed',
+			],
+			contentGuidelines: [
+				'Use clear, descriptive hidden content',
+				'Ensure content adds value for screen readers',
+				'Keep content concise but meaningful',
+			],
+			accessibilityGuidelines: [
+				'Use for screen reader only content when visual context is insufficient for AT',
+				'Use role prop for semantic meaning when appropriate',
+				'Balance clarity with brevity—avoid overwhelming screen reader users',
+				'Prefer over aria-label in some cases when screen readers need to translate or announce full phrasing',
+			],
+			examples: [
+				{
+					name: '00 Basic',
+					description: '00 Basic example',
+					source: path.resolve(__dirname, './examples/00-basic.tsx'),
+				},
+			],
+			keywords: ['hidden', 'accessibility', 'screen-reader', 'aria', 'utility'],
+			categories: ['utility'],
+		},
+	],
+};
 
 export default documentation;

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

@@ -1 +0,0 @@
-export type { VisuallyHiddenProps } from '../types';

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

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

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

@@ -1,2 +0,0 @@
-export { default } from './visually-hidden';
-export type { VisuallyHiddenProps } from './types';

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

@@ -1,22 +0,0 @@
-import { type ReactNode } from 'react';
-export type VisuallyHiddenProps = {
-    /**
-     * The element or elements that should be hidden.
-     */
-    children: ReactNode;
-    /**
-     * An ARIA role attribute to aid screen readers.
-     */
-    role?: string;
-    /**
-     * An id may be appropriate for this component if used in conjunction with `aria-describedby`
-     * on a paired 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;
-};

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

@@ -1,26 +0,0 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-import { type FC } from 'react';
-import type { VisuallyHiddenProps } from './types';
-/**
- * __Visually hidden__
- *
- * A composable element to apply a visually hidden effect to children.
- * Useful for accessibility compliance.
- *
- * @example
- * ```jsx
- * import VisuallyHidden from '@atlaskit/visually-hidden';
- *
- * export default () => (
- *   <div style={{ border: '1px solid black' }}>
- *      There is text hidden between the brackets [
- *      <VisuallyHidden>Can't see me!</VisuallyHidden>]
- *   </div>
- * );
- * ```
- */
-declare const VisuallyHidden: FC<VisuallyHiddenProps>;
-export default VisuallyHidden;