@atlaskit/icon 32.1.0 → 33.0.1

package/dist/types/deprecated-core.d.ts

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
  *
- * @codegen <<SignedSource::804908d3809623929b0f025db7735c8f>>
+ * @codegen <<SignedSource::940e05b18f6bba27980b5c1fdf15c580>>
  * @codegenCommand yarn build:icon-glyphs
  */
 declare const deprecatedIcons: Record<string, {

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

@@ -1,2 +1,2 @@
-export { default } from '../metadata';
+export { default } from '../metadata-core';
 export { default as coreIconMetadata } from '../metadata-core';

package/dist/types/metadata-core.d.ts

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::75a10fac3fe1f9f4b8110a6252449ece>>
+ * @codegen <<SignedSource::89369dad254e55137adbee199ee40d7d>>
  * @codegenCommand yarn build:icon-glyphs
  */
 interface metadata {
@@ -41,10 +41,6 @@ interface metadata {
      * Contact slack channel for the team owning the icon
      */
     slackChannel?: string;
-    /**
-     * A list of keys for old icons that have been replaced by this icon
-     */
-    oldName?: string[];
     /**
      * A replacement icon if this icon has been deprecated
      */

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

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `createDeprecatedIconDocs` in icon-build-process/src/create-deprecated-icon-docs.tsx.
  *
- * @codegen <<SignedSource::804908d3809623929b0f025db7735c8f>>
+ * @codegen <<SignedSource::940e05b18f6bba27980b5c1fdf15c580>>
  * @codegenCommand yarn build:icon-glyphs
  */
 declare const deprecatedIcons: Record<string, {

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

@@ -1,2 +1,2 @@
-export { default } from '../metadata';
+export { default } from '../metadata-core';
 export { default as coreIconMetadata } from '../metadata-core';

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

@@ -3,7 +3,7 @@
  *
  * To change the format of this file, modify `createIconDocsNew` in icon-build-process/src/create-icon-docs.tsx.
  *
- * @codegen <<SignedSource::75a10fac3fe1f9f4b8110a6252449ece>>
+ * @codegen <<SignedSource::89369dad254e55137adbee199ee40d7d>>
  * @codegenCommand yarn build:icon-glyphs
  */
 interface metadata {
@@ -41,10 +41,6 @@ interface metadata {
      * Contact slack channel for the team owning the icon
      */
     slackChannel?: string;
-    /**
-     * A list of keys for old icons that have been replaced by this icon
-     */
-    oldName?: string[];
     /**
      * A replacement icon if this icon has been deprecated
      */

package/icon.docs.tsx

@@ -0,0 +1,88 @@
+import path from 'path';
+
+import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
+
+const documentation: ComponentStructuredContentSource[] = [
+	{
+		name: 'Icon',
+		description: 'An icon is a symbol representing a command, device, directory, or common action.',
+		status: 'general-availability',
+		import: {
+			name: 'Icon',
+			package: '@atlaskit/icon',
+			type: 'default',
+			packagePath: path.resolve(__dirname),
+			packageJson: require('./package.json'),
+		},
+		usageGuidelines: [
+			'Use icons to enhance visual communication',
+			'Choose icons that clearly represent their function',
+			'Maintain consistent icon style and size',
+			'Use appropriate icon sizes for different contexts',
+			'Consider cultural and contextual icon meanings',
+		],
+		contentGuidelines: [
+			'Use clear, recognizable icon symbols',
+			'Ensure icons are culturally appropriate',
+			'Maintain visual consistency across icon sets',
+			'Use appropriate icon labels and descriptions',
+		],
+		accessibilityGuidelines: [
+			'Provide appropriate alt text or labels for icons',
+			'Use meaningful icon choices that convey clear meaning',
+			'Ensure sufficient color contrast for icon visibility',
+			'Consider icon size for touch targets',
+			'Use consistent iconography across the interface',
+		],
+		examples: [
+			{
+				name: 'Icon',
+				description: 'Icon example',
+				source: path.resolve(__dirname, './examples/ai/icon.tsx'),
+			},
+		],
+		keywords: ['icon', 'symbol', 'command', 'device', 'directory', 'action', 'visual'],
+		categories: ['images-and-icons'],
+	},
+	{
+		name: 'IconTile',
+		description:
+			'A tile component that displays an icon with customizable background, shape, and appearance.',
+		status: 'release-candidate',
+		import: {
+			name: 'IconTile',
+			package: '@atlaskit/icon',
+			type: 'named',
+			packagePath: path.resolve(__dirname),
+			packageJson: require('./package.json'),
+		},
+		usageGuidelines: [
+			'Use for icon presentation with background styling',
+			'Choose appropriate shapes and appearances',
+			'Maintain consistent sizing across tiles',
+			'Use for visual emphasis or categorization',
+		],
+		contentGuidelines: [
+			'Use clear, recognizable icons',
+			'Choose appropriate colors and shapes',
+			'Ensure visual consistency across tiles',
+		],
+		accessibilityGuidelines: [
+			'Provide appropriate labels for icon tiles',
+			'Ensure sufficient color contrast',
+			'Use meaningful icon choices',
+			'Consider touch target sizes',
+		],
+		examples: [
+			{
+				name: 'Icon Tile',
+				description: 'Icon Tile example',
+				source: path.resolve(__dirname, './examples/ai/icon-tile.tsx'),
+			},
+		],
+		keywords: ['icon', 'tile', 'container', 'background', 'shape', 'appearance'],
+		categories: ['images-and-icons'],
+	},
+];
+
+export default documentation;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/icon",
-	"version": "32.1.0",
+	"version": "33.0.1",
 	"description": "An icon is a symbol representing a command, device, directory, or common action.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -55,7 +55,7 @@
 		"@atlaskit/form": "^15.4.0",
 		"@atlaskit/heading": "^5.3.0",
 		"@atlaskit/icon-file-type": "^7.0.0",
-		"@atlaskit/icon-object": "^7.4.0",
+		"@atlaskit/icon-object": "^7.5.0",
 		"@atlaskit/link": "^3.3.0",
 		"@atlaskit/logo": "^19.10.0",
 		"@atlaskit/menu": "^8.4.0",
@@ -68,6 +68,7 @@
 		"@atlaskit/tooltip": "^20.14.0",
 		"@atlassian/feature-flags-test-utils": "^1.0.0",
 		"@atlassian/ssr-tests": "workspace:^",
+		"@atlassian/structured-docs-types": "workspace:^",
 		"@babel/core": "7.24.9",
 		"@babel/register": "^7.25.9",
 		"@codeshift/utils": "^0.2.4",

package/tsconfig.json

@@ -14,6 +14,7 @@
 		"**/stories/*.ts",
 		"**/stories/*.tsx",
 		"**/stories/**/*.ts",
-		"**/stories/**/*.tsx"
+		"**/stories/**/*.tsx",
+		"./icon.docs.tsx"
 	]
 }