@atlaskit/drawer 12.1.2 → 12.1.4

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 (6) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/drawer.js +3 -3
  3. package/dist/es2019/drawer.js +3 -3
  4. package/dist/esm/drawer.js +3 -3
  5. package/drawer.docs.tsx +131 -129
  6. package/package.json +7 -6
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/drawer
2
2
 
3
+ ## 12.1.4
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 12.1.3
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies
14
+
3
15
  ## 12.1.2
4
16
 
5
17
  ### Patch Changes
package/dist/cjs/drawer.js CHANGED
@@ -67,7 +67,7 @@ var Drawer = exports.Drawer = function Drawer(_ref2) {
67
67
  action: 'dismissed',
68
68
  componentName: 'drawer',
69
69
  packageName: "@atlaskit/drawer",
70
- packageVersion: "12.1.1",
70
+ packageVersion: "12.1.3",
71
71
  analyticsData: {
72
72
  trigger: 'escKey'
73
73
  }
@@ -90,7 +90,7 @@ var Drawer = exports.Drawer = function Drawer(_ref2) {
90
90
  action: 'dismissed',
91
91
  componentName: 'drawer',
92
92
  packageName: "@atlaskit/drawer",
93
- packageVersion: "12.1.1",
93
+ packageVersion: "12.1.3",
94
94
  analyticsData: {
95
95
  trigger: 'blanket'
96
96
  }
@@ -102,7 +102,7 @@ var Drawer = exports.Drawer = function Drawer(_ref2) {
102
102
  action: 'dismissed',
103
103
  componentName: 'drawer',
104
104
  packageName: "@atlaskit/drawer",
105
- packageVersion: "12.1.1",
105
+ packageVersion: "12.1.3",
106
106
  analyticsData: {
107
107
  trigger: 'backButton'
108
108
  }
package/dist/es2019/drawer.js CHANGED
@@ -52,7 +52,7 @@ export const Drawer = ({
52
52
  action: 'dismissed',
53
53
  componentName: 'drawer',
54
54
  packageName: "@atlaskit/drawer",
55
- packageVersion: "12.1.1",
55
+ packageVersion: "12.1.3",
56
56
  analyticsData: {
57
57
  trigger: 'escKey'
58
58
  }
@@ -73,7 +73,7 @@ export const Drawer = ({
73
73
  action: 'dismissed',
74
74
  componentName: 'drawer',
75
75
  packageName: "@atlaskit/drawer",
76
- packageVersion: "12.1.1",
76
+ packageVersion: "12.1.3",
77
77
  analyticsData: {
78
78
  trigger: 'blanket'
79
79
  }
@@ -83,7 +83,7 @@ export const Drawer = ({
83
83
  action: 'dismissed',
84
84
  componentName: 'drawer',
85
85
  packageName: "@atlaskit/drawer",
86
- packageVersion: "12.1.1",
86
+ packageVersion: "12.1.3",
87
87
  analyticsData: {
88
88
  trigger: 'backButton'
89
89
  }
package/dist/esm/drawer.js CHANGED
@@ -57,7 +57,7 @@ export var Drawer = function Drawer(_ref2) {
57
57
  action: 'dismissed',
58
58
  componentName: 'drawer',
59
59
  packageName: "@atlaskit/drawer",
60
- packageVersion: "12.1.1",
60
+ packageVersion: "12.1.3",
61
61
  analyticsData: {
62
62
  trigger: 'escKey'
63
63
  }
@@ -80,7 +80,7 @@ export var Drawer = function Drawer(_ref2) {
80
80
  action: 'dismissed',
81
81
  componentName: 'drawer',
82
82
  packageName: "@atlaskit/drawer",
83
- packageVersion: "12.1.1",
83
+ packageVersion: "12.1.3",
84
84
  analyticsData: {
85
85
  trigger: 'blanket'
86
86
  }
@@ -92,7 +92,7 @@ export var Drawer = function Drawer(_ref2) {
92
92
  action: 'dismissed',
93
93
  componentName: 'drawer',
94
94
  packageName: "@atlaskit/drawer",
95
- packageVersion: "12.1.1",
95
+ packageVersion: "12.1.3",
96
96
  analyticsData: {
97
97
  trigger: 'backButton'
98
98
  }
package/drawer.docs.tsx CHANGED
@@ -1,143 +1,145 @@
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: 'Drawer',
8
- description:
9
- 'A drawer is a panel that slides in from the left side of the screen for navigation or additional content.',
10
- status: 'intent-to-deprecate',
11
- import: {
5
+ const documentation: StructuredContentSource = {
6
+ components: [
7
+ {
12
8
  name: 'Drawer',
13
- package: '@atlaskit/drawer',
14
- type: 'default',
15
- packagePath: path.resolve(__dirname),
16
- packageJson: require('./package.json'),
17
- },
18
- usageGuidelines: [
19
- 'Use for navigation or secondary content',
20
- 'Provide clear open/close mechanisms',
21
- 'Consider screen size and drawer width',
22
- 'Use appropriate backdrop behavior',
23
- 'Consider alternative patterns like Modal for better UX',
24
- ],
25
- contentGuidelines: [
26
- 'Organize content logically within the drawer',
27
- 'Use clear navigation labels',
28
- 'Provide appropriate close actions',
29
- 'Consider content hierarchy and grouping',
30
- ],
31
- accessibilityGuidelines: [
32
- 'Ensure proper focus management when drawer opens/closes',
33
- 'Provide keyboard navigation support',
34
- 'Use appropriate ARIA attributes for drawer state',
35
- 'Ensure content is accessible when drawer is open',
36
- 'Provide clear close mechanisms',
37
- ],
38
- examples: [
39
- {
9
+ description:
10
+ 'A drawer is a panel that slides in from the left side of the screen for navigation or additional content.',
11
+ status: 'intent-to-deprecate',
12
+ import: {
40
13
  name: 'Drawer',
41
- description: 'Drawer example',
42
- source: path.resolve(__dirname, './examples/ai/drawer.tsx'),
14
+ package: '@atlaskit/drawer',
15
+ type: 'default',
16
+ packagePath: path.resolve(__dirname),
17
+ packageJson: require('./package.json'),
43
18
  },
44
- ],
45
- keywords: ['drawer', 'panel', 'slide', 'overlay', 'navigation', 'sidebar'],
46
- categories: ['overlays-and-layering'],
47
- },
48
- {
49
- name: 'DrawerContent',
50
- description: 'The main content area of a drawer panel.',
51
- status: 'intent-to-deprecate',
52
- import: {
53
- name: 'DrawerContent',
54
- package: '@atlaskit/drawer',
55
- type: 'named',
56
- packagePath: path.resolve(__dirname),
57
- packageJson: require('./package.json'),
19
+ usageGuidelines: [
20
+ 'Use for navigation or secondary content',
21
+ 'Provide clear open/close mechanisms',
22
+ 'Consider screen size and drawer width',
23
+ 'Use appropriate backdrop behavior',
24
+ 'Consider alternative patterns like Modal for better UX',
25
+ ],
26
+ contentGuidelines: [
27
+ 'Organize content logically within the drawer',
28
+ 'Use clear navigation labels',
29
+ 'Provide appropriate close actions',
30
+ 'Consider content hierarchy and grouping',
31
+ ],
32
+ accessibilityGuidelines: [
33
+ 'Ensure proper focus management when drawer opens/closes',
34
+ 'Provide keyboard navigation support',
35
+ 'Use appropriate ARIA attributes for drawer state',
36
+ 'Ensure content is accessible when drawer is open',
37
+ 'Provide clear close mechanisms',
38
+ ],
39
+ examples: [
40
+ {
41
+ name: 'Drawer',
42
+ description: 'Drawer example',
43
+ source: path.resolve(__dirname, './examples/ai/drawer.tsx'),
44
+ },
45
+ ],
46
+ keywords: ['drawer', 'panel', 'slide', 'overlay', 'navigation', 'sidebar'],
47
+ categories: ['overlays-and-layering'],
58
48
  },
59
- usageGuidelines: [
60
- 'Use as the main content container within a drawer',
61
- 'Place primary content and actions here',
62
- 'Ensure proper scrolling behavior for long content',
63
- ],
64
- contentGuidelines: [
65
- 'Organize content logically',
66
- 'Use appropriate spacing and layout',
67
- 'Consider content hierarchy',
68
- ],
69
- examples: [
70
- {
71
- name: 'Drawer Content',
72
- description: 'Drawer Content example',
73
- source: path.resolve(__dirname, './examples/ai/drawer-content.tsx'),
49
+ {
50
+ name: 'DrawerContent',
51
+ description: 'The main content area of a drawer panel.',
52
+ status: 'intent-to-deprecate',
53
+ import: {
54
+ name: 'DrawerContent',
55
+ package: '@atlaskit/drawer',
56
+ type: 'named',
57
+ packagePath: path.resolve(__dirname),
58
+ packageJson: require('./package.json'),
74
59
  },
75
- ],
76
- keywords: ['drawer', 'content', 'panel', 'body'],
77
- categories: ['overlays-and-layering'],
78
- },
79
- {
80
- name: 'DrawerSidebar',
81
- description: 'A sidebar component within a drawer for navigation or secondary content.',
82
- status: 'intent-to-deprecate',
83
- import: {
84
- name: 'DrawerSidebar',
85
- package: '@atlaskit/drawer',
86
- type: 'named',
87
- packagePath: path.resolve(__dirname),
88
- packageJson: require('./package.json'),
60
+ usageGuidelines: [
61
+ 'Use as the main content container within a drawer',
62
+ 'Place primary content and actions here',
63
+ 'Ensure proper scrolling behavior for long content',
64
+ ],
65
+ contentGuidelines: [
66
+ 'Organize content logically',
67
+ 'Use appropriate spacing and layout',
68
+ 'Consider content hierarchy',
69
+ ],
70
+ examples: [
71
+ {
72
+ name: 'Drawer Content',
73
+ description: 'Drawer Content example',
74
+ source: path.resolve(__dirname, './examples/ai/drawer-content.tsx'),
75
+ },
76
+ ],
77
+ keywords: ['drawer', 'content', 'panel', 'body'],
78
+ categories: ['overlays-and-layering'],
89
79
  },
90
- usageGuidelines: [
91
- 'Use for navigation or secondary content in a drawer',
92
- 'Keep sidebar content focused and organized',
93
- 'Consider responsive behavior',
94
- ],
95
- contentGuidelines: [
96
- 'Use clear navigation labels',
97
- 'Organize content hierarchically',
98
- 'Keep sidebar content concise',
99
- ],
100
- examples: [
101
- {
102
- name: 'Drawer Sidebar',
103
- description: 'Drawer Sidebar example',
104
- source: path.resolve(__dirname, './examples/ai/drawer-sidebar.tsx'),
80
+ {
81
+ name: 'DrawerSidebar',
82
+ description: 'A sidebar component within a drawer for navigation or secondary content.',
83
+ status: 'intent-to-deprecate',
84
+ import: {
85
+ name: 'DrawerSidebar',
86
+ package: '@atlaskit/drawer',
87
+ type: 'named',
88
+ packagePath: path.resolve(__dirname),
89
+ packageJson: require('./package.json'),
105
90
  },
106
- ],
107
- keywords: ['drawer', 'sidebar', 'navigation', 'panel'],
108
- categories: ['overlays-and-layering'],
109
- },
110
- {
111
- name: 'DrawerCloseButton',
112
- description: 'A close button specifically designed for drawer components.',
113
- status: 'intent-to-deprecate',
114
- import: {
115
- name: 'DrawerCloseButton',
116
- package: '@atlaskit/drawer',
117
- type: 'named',
118
- packagePath: path.resolve(__dirname),
119
- packageJson: require('./package.json'),
91
+ usageGuidelines: [
92
+ 'Use for navigation or secondary content in a drawer',
93
+ 'Keep sidebar content focused and organized',
94
+ 'Consider responsive behavior',
95
+ ],
96
+ contentGuidelines: [
97
+ 'Use clear navigation labels',
98
+ 'Organize content hierarchically',
99
+ 'Keep sidebar content concise',
100
+ ],
101
+ examples: [
102
+ {
103
+ name: 'Drawer Sidebar',
104
+ description: 'Drawer Sidebar example',
105
+ source: path.resolve(__dirname, './examples/ai/drawer-sidebar.tsx'),
106
+ },
107
+ ],
108
+ keywords: ['drawer', 'sidebar', 'navigation', 'panel'],
109
+ categories: ['overlays-and-layering'],
120
110
  },
121
- usageGuidelines: [
122
- 'Use to provide clear close functionality for drawers',
123
- 'Position prominently for easy access',
124
- 'Ensure keyboard accessibility',
125
- ],
126
- contentGuidelines: [
127
- 'Use clear close icon or text',
128
- 'Ensure button is easily discoverable',
129
- 'Provide appropriate hover/focus states',
130
- ],
131
- examples: [
132
- {
133
- name: 'Drawer Close Button',
134
- description: 'Drawer Close Button example',
135
- source: path.resolve(__dirname, './examples/ai/drawer-close-button.tsx'),
111
+ {
112
+ name: 'DrawerCloseButton',
113
+ description: 'A close button specifically designed for drawer components.',
114
+ status: 'intent-to-deprecate',
115
+ import: {
116
+ name: 'DrawerCloseButton',
117
+ package: '@atlaskit/drawer',
118
+ type: 'named',
119
+ packagePath: path.resolve(__dirname),
120
+ packageJson: require('./package.json'),
136
121
  },
137
- ],
138
- keywords: ['drawer', 'close', 'button', 'action'],
139
- categories: ['overlays-and-layering'],
140
- },
141
- ];
122
+ usageGuidelines: [
123
+ 'Use to provide clear close functionality for drawers',
124
+ 'Position prominently for easy access',
125
+ 'Ensure keyboard accessibility',
126
+ ],
127
+ contentGuidelines: [
128
+ 'Use clear close icon or text',
129
+ 'Ensure button is easily discoverable',
130
+ 'Provide appropriate hover/focus states',
131
+ ],
132
+ examples: [
133
+ {
134
+ name: 'Drawer Close Button',
135
+ description: 'Drawer Close Button example',
136
+ source: path.resolve(__dirname, './examples/ai/drawer-close-button.tsx'),
137
+ },
138
+ ],
139
+ keywords: ['drawer', 'close', 'button', 'action'],
140
+ categories: ['overlays-and-layering'],
141
+ },
142
+ ],
143
+ };
142
144
 
143
145
  export default documentation;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/drawer",
3
- "version": "12.1.2",
3
+ "version": "12.1.4",
4
4
  "description": "A drawer is a panel that slides in from the left side of the screen.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -48,11 +48,11 @@
48
48
  "@atlaskit/blanket": "^15.0.0",
49
49
  "@atlaskit/button": "^23.11.0",
50
50
  "@atlaskit/css": "^0.19.0",
51
- "@atlaskit/icon": "^35.0.0",
51
+ "@atlaskit/icon": "^35.1.0",
52
52
  "@atlaskit/layering": "^3.7.0",
53
53
  "@atlaskit/motion": "^6.2.0",
54
54
  "@atlaskit/portal": "^5.5.0",
55
- "@atlaskit/theme": "^23.2.0",
55
+ "@atlaskit/theme": "^25.0.0",
56
56
  "@atlaskit/tokens": "^13.0.0",
57
57
  "@babel/runtime": "^7.0.0",
58
58
  "@compiled/react": "^0.20.0",
@@ -72,21 +72,22 @@
72
72
  "@af/visual-regression": "workspace:^",
73
73
  "@atlaskit/code": "^17.5.0",
74
74
  "@atlaskit/docs": "^11.8.0",
75
- "@atlaskit/dropdown-menu": "^16.8.0",
75
+ "@atlaskit/dropdown-menu": "^16.9.0",
76
76
  "@atlaskit/ds-lib": "^7.0.0",
77
77
  "@atlaskit/form": "^15.5.0",
78
78
  "@atlaskit/inline-message": "^15.6.0",
79
79
  "@atlaskit/link": "^3.4.0",
80
80
  "@atlaskit/menu": "^8.5.0",
81
- "@atlaskit/modal-dialog": "^15.0.0",
81
+ "@atlaskit/modal-dialog": "^15.2.0",
82
82
  "@atlaskit/primitives": "^19.0.0",
83
- "@atlaskit/section-message": "^8.12.0",
83
+ "@atlaskit/section-message": "^8.13.0",
84
84
  "@atlassian/react-compiler-gating": "workspace:^",
85
85
  "@atlassian/ssr-tests": "workspace:^",
86
86
  "@atlassian/structured-docs-types": "workspace:^",
87
87
  "@testing-library/react": "^16.3.0",
88
88
  "@testing-library/user-event": "^14.4.3",
89
89
  "@types/exenv": "^1.2.0",
90
+ "react": "^18.2.0",
90
91
  "react-dom": "^18.2.0",
91
92
  "react-lorem-component": "^0.13.0"
92
93
  },