@atlaskit/image 3.0.10 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +4 -0
  3. package/image.docs.tsx +41 -39
  4. package/package.json +7 -9
  5. package/offerings.json +0 -34
package/CHANGELOG.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @atlaskit/image
2
2
 
3
+ ## 3.1.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`afbd895691509`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/afbd895691509) -
8
+ Promote `@atlaskit/image` to general availability.
9
+
3
10
  ## 3.0.10
4
11
 
5
12
  ### Patch Changes
package/README.md CHANGED
@@ -2,6 +2,10 @@
2
2
 
3
3
  An image component with additional features, such as support for themes.
4
4
 
5
+ ## Release stage: General availability
6
+
7
+ This package is supported for production use.
8
+
5
9
  ## Installation
6
10
 
7
11
  ```sh
package/image.docs.tsx CHANGED
@@ -1,47 +1,49 @@
1
1
  import path from 'path';
2
2
 
3
- import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
3
+ import type { StructuredContentSource } from '@atlassian/structured-docs-types/types';
4
4
 
5
- const documentation: ComponentStructuredContentSource[] = [
6
- {
7
- name: 'Image',
8
- description: 'A component for displaying images with theme support.',
9
- status: 'open-beta',
10
- import: {
5
+ const documentation: StructuredContentSource = {
6
+ components: [
7
+ {
11
8
  name: 'Image',
12
- package: '@atlaskit/image',
13
- type: 'default',
14
- packagePath: path.resolve(__dirname),
15
- packageJson: require('./package.json'),
16
- },
17
- usageGuidelines: [
18
- 'Use for displaying images in content',
19
- 'Provide appropriate alt text',
20
- 'Consider responsive image sizing',
21
- 'Handle loading and error states',
22
- ],
23
- contentGuidelines: [
24
- 'Use clear, descriptive alt text',
25
- 'Choose appropriate image dimensions',
26
- 'Consider image quality and file size',
27
- 'Use meaningful image content',
28
- ],
29
- accessibilityGuidelines: [
30
- 'Always provide meaningful alt text',
31
- 'Ensure appropriate image sizing',
32
- 'Consider loading states and error handling',
33
- 'Use appropriate image formats',
34
- ],
35
- examples: [
36
- {
9
+ description: 'A component for displaying images with theme support.',
10
+ status: 'general-availability',
11
+ import: {
37
12
  name: 'Image',
38
- description: 'Image example',
39
- source: path.resolve(__dirname, './examples/ai/image.tsx'),
13
+ package: '@atlaskit/image',
14
+ type: 'default',
15
+ packagePath: path.resolve(__dirname),
16
+ packageJson: require('./package.json'),
40
17
  },
41
- ],
42
- keywords: ['image', 'picture', 'photo', 'visual', 'media'],
43
- categories: ['data-display'],
44
- },
45
- ];
18
+ usageGuidelines: [
19
+ 'Use for displaying images in content',
20
+ 'Provide appropriate alt text',
21
+ 'Consider responsive image sizing',
22
+ 'Handle loading and error states',
23
+ ],
24
+ contentGuidelines: [
25
+ 'Use clear, descriptive alt text',
26
+ 'Choose appropriate image dimensions',
27
+ 'Consider image quality and file size',
28
+ 'Use meaningful image content',
29
+ ],
30
+ accessibilityGuidelines: [
31
+ 'Always provide meaningful alt text',
32
+ 'Ensure appropriate image sizing',
33
+ 'Consider loading states and error handling',
34
+ 'Use appropriate image formats',
35
+ ],
36
+ examples: [
37
+ {
38
+ name: 'Image',
39
+ description: 'Image example',
40
+ source: path.resolve(__dirname, './examples/ai/image.tsx'),
41
+ },
42
+ ],
43
+ keywords: ['image', 'picture', 'photo', 'visual', 'media'],
44
+ categories: ['data-display'],
45
+ },
46
+ ],
47
+ };
46
48
 
47
49
  export default documentation;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/image",
3
- "version": "3.0.10",
3
+ "version": "3.1.0",
4
4
  "description": "An image that changes in light or dark themes.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -27,15 +27,12 @@
27
27
  "team": "Design System Team",
28
28
  "website": {
29
29
  "name": "Image",
30
- "category": "Images and icons",
31
- "status": {
32
- "type": "beta"
33
- }
30
+ "category": "Images and icons"
34
31
  }
35
32
  },
36
33
  "dependencies": {
37
- "@atlaskit/app-provider": "^4.2.0",
38
- "@atlaskit/tokens": "^13.0.0",
34
+ "@atlaskit/app-provider": "^4.3.0",
35
+ "@atlaskit/tokens": "^13.4.0",
39
36
  "@babel/runtime": "^7.0.0",
40
37
  "@compiled/react": "^0.20.0"
41
38
  },
@@ -46,14 +43,15 @@
46
43
  "@af/accessibility-testing": "workspace:^",
47
44
  "@af/integration-testing": "workspace:^",
48
45
  "@af/visual-regression": "workspace:^",
49
- "@atlaskit/docs": "^11.7.0",
46
+ "@atlaskit/docs": "^11.8.0",
50
47
  "@atlaskit/link": "^3.4.0",
51
48
  "@atlaskit/primitives": "^19.0.0",
52
- "@atlaskit/section-message": "^8.12.0",
49
+ "@atlaskit/section-message": "^8.13.0",
53
50
  "@atlassian/react-compiler-gating": "workspace:^",
54
51
  "@atlassian/ssr-tests": "workspace:^",
55
52
  "@atlassian/structured-docs-types": "workspace:^",
56
53
  "@testing-library/react": "^16.3.0",
54
+ "react": "^18.2.0",
57
55
  "react-dom": "^18.2.0"
58
56
  },
59
57
  "techstack": {
package/offerings.json DELETED
@@ -1,34 +0,0 @@
1
- [
2
- {
3
- "name": "Image",
4
- "package": "@atlaskit/image",
5
- "import": {
6
- "name": "Image",
7
- "package": "@atlaskit/image",
8
- "type": "default"
9
- },
10
- "keywords": ["image", "picture", "photo", "visual", "media"],
11
- "categories": ["data-display"],
12
- "shortDescription": "A component for displaying images with theme support.",
13
- "status": "open-beta",
14
- "accessibilityGuidelines": [
15
- "Always provide meaningful alt text",
16
- "Ensure appropriate image sizing",
17
- "Consider loading states and error handling",
18
- "Use appropriate image formats"
19
- ],
20
- "usageGuidelines": [
21
- "Use for displaying images in content",
22
- "Provide appropriate alt text",
23
- "Consider responsive image sizing",
24
- "Handle loading and error states"
25
- ],
26
- "contentGuidelines": [
27
- "Use clear, descriptive alt text",
28
- "Choose appropriate image dimensions",
29
- "Consider image quality and file size",
30
- "Use meaningful image content"
31
- ],
32
- "examples": ["./examples/ai/image.tsx"]
33
- }
34
- ]