@atlaskit/drawer 11.0.28 → 12.0.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.
- package/CHANGELOG.md +18 -0
- package/dist/cjs/blanket.js +1 -1
- package/dist/cjs/drawer-panel/drawer-content.js +1 -1
- package/dist/cjs/drawer-panel/drawer-panel.js +1 -1
- package/dist/cjs/drawer-panel/drawer-sidebar.js +1 -1
- package/dist/es2019/blanket.js +1 -1
- package/dist/es2019/drawer-panel/drawer-content.js +1 -1
- package/dist/es2019/drawer-panel/drawer-panel.js +1 -1
- package/dist/es2019/drawer-panel/drawer-sidebar.js +1 -1
- package/dist/esm/blanket.js +1 -1
- package/dist/esm/drawer-panel/drawer-content.js +1 -1
- package/dist/esm/drawer-panel/drawer-panel.js +1 -1
- package/dist/esm/drawer-panel/drawer-sidebar.js +1 -1
- package/dist/types/types.d.ts +1 -1
- package/dist/types-ts4.5/types.d.ts +1 -1
- package/drawer.docs.tsx +143 -0
- package/package.json +12 -12
- package/constants/package.json +0 -17
- package/dist/cjs/constants.js +0 -8
- package/dist/es2019/constants.js +0 -2
- package/dist/esm/constants.js +0 -2
- package/dist/types/constants.d.ts +0 -4
- package/dist/types-ts4.5/constants.d.ts +0 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @atlaskit/drawer
|
|
2
2
|
|
|
3
|
+
## 12.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [`d2ad22e31f982`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d2ad22e31f982) -
|
|
8
|
+
Removes unused entrypoint @ak/drawer/constants from public API given it is unused by package
|
|
9
|
+
source code.
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- Updated dependencies
|
|
14
|
+
|
|
15
|
+
## 11.0.29
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- Updated dependencies
|
|
20
|
+
|
|
3
21
|
## 11.0.28
|
|
4
22
|
|
|
5
23
|
### Patch Changes
|
package/dist/cjs/blanket.js
CHANGED
package/dist/es2019/blanket.js
CHANGED
package/dist/esm/blanket.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
/* drawer-content.tsx generated by @compiled/babel-plugin v0.
|
|
1
|
+
/* drawer-content.tsx generated by @compiled/babel-plugin v0.39.1 */
|
|
2
2
|
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
|
|
3
3
|
import "./drawer-content.compiled.css";
|
|
4
4
|
import * as React from 'react';
|
package/dist/types/types.d.ts
CHANGED
|
@@ -60,7 +60,7 @@ export interface DrawerContentProps {
|
|
|
60
60
|
* When the content is scrollable, this is the accessible name for the the drawer region. The default is "Scrollable content".
|
|
61
61
|
*/
|
|
62
62
|
scrollContentLabel?: string;
|
|
63
|
-
xcss?: StrictXCSSProp<'padding' | 'paddingTop' | 'paddingBottom' | 'paddingLeft' | 'paddingRight' | 'marginTop' | 'backgroundColor', never>;
|
|
63
|
+
xcss?: StrictXCSSProp<'padding' | 'paddingTop' | 'paddingBottom' | 'paddingLeft' | 'paddingRight' | 'marginTop' | 'backgroundColor' | 'marginBlockStart' | 'paddingInlineStart' | 'paddingInlineEnd' | 'marginBlockStart' | 'paddingBlockStart' | 'paddingInlineEnd' | 'paddingBlockEnd' | 'paddingInlineStart', never>;
|
|
64
64
|
}
|
|
65
65
|
export interface DrawerCloseButtonProps {
|
|
66
66
|
/**
|
|
@@ -60,7 +60,7 @@ export interface DrawerContentProps {
|
|
|
60
60
|
* When the content is scrollable, this is the accessible name for the the drawer region. The default is "Scrollable content".
|
|
61
61
|
*/
|
|
62
62
|
scrollContentLabel?: string;
|
|
63
|
-
xcss?: StrictXCSSProp<'padding' | 'paddingTop' | 'paddingBottom' | 'paddingLeft' | 'paddingRight' | 'marginTop' | 'backgroundColor', never>;
|
|
63
|
+
xcss?: StrictXCSSProp<'padding' | 'paddingTop' | 'paddingBottom' | 'paddingLeft' | 'paddingRight' | 'marginTop' | 'backgroundColor' | 'marginBlockStart' | 'paddingInlineStart' | 'paddingInlineEnd' | 'marginBlockStart' | 'paddingBlockStart' | 'paddingInlineEnd' | 'paddingBlockEnd' | 'paddingInlineStart', never>;
|
|
64
64
|
}
|
|
65
65
|
export interface DrawerCloseButtonProps {
|
|
66
66
|
/**
|
package/drawer.docs.tsx
ADDED
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
import path from 'path';
|
|
2
|
+
|
|
3
|
+
import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
|
|
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: {
|
|
12
|
+
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
|
+
{
|
|
40
|
+
name: 'Drawer',
|
|
41
|
+
description: 'Drawer example',
|
|
42
|
+
source: path.resolve(__dirname, './examples/ai/drawer.tsx'),
|
|
43
|
+
},
|
|
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'),
|
|
58
|
+
},
|
|
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'),
|
|
74
|
+
},
|
|
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'),
|
|
89
|
+
},
|
|
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'),
|
|
105
|
+
},
|
|
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'),
|
|
120
|
+
},
|
|
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'),
|
|
136
|
+
},
|
|
137
|
+
],
|
|
138
|
+
keywords: ['drawer', 'close', 'button', 'action'],
|
|
139
|
+
categories: ['overlays-and-layering'],
|
|
140
|
+
},
|
|
141
|
+
];
|
|
142
|
+
|
|
143
|
+
export default documentation;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/drawer",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "12.0.0",
|
|
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/"
|
|
@@ -39,16 +39,16 @@
|
|
|
39
39
|
"dependencies": {
|
|
40
40
|
"@atlaskit/analytics-next": "^11.1.0",
|
|
41
41
|
"@atlaskit/blanket": "^15.0.0",
|
|
42
|
-
"@atlaskit/button": "^23.
|
|
42
|
+
"@atlaskit/button": "^23.10.0",
|
|
43
43
|
"@atlaskit/css": "^0.19.0",
|
|
44
|
-
"@atlaskit/icon": "^
|
|
44
|
+
"@atlaskit/icon": "^33.0.0",
|
|
45
45
|
"@atlaskit/layering": "^3.6.0",
|
|
46
|
-
"@atlaskit/motion": "^5.
|
|
46
|
+
"@atlaskit/motion": "^5.4.0",
|
|
47
47
|
"@atlaskit/portal": "^5.2.0",
|
|
48
|
-
"@atlaskit/theme": "^
|
|
49
|
-
"@atlaskit/tokens": "^11.
|
|
48
|
+
"@atlaskit/theme": "^22.0.0",
|
|
49
|
+
"@atlaskit/tokens": "^11.1.0",
|
|
50
50
|
"@babel/runtime": "^7.0.0",
|
|
51
|
-
"@compiled/react": "^0.
|
|
51
|
+
"@compiled/react": "^0.20.0",
|
|
52
52
|
"bind-event-listener": "^3.0.0",
|
|
53
53
|
"exenv": "^1.2.2",
|
|
54
54
|
"react-focus-lock": "^2.9.5",
|
|
@@ -64,11 +64,11 @@
|
|
|
64
64
|
"@af/integration-testing": "workspace:^",
|
|
65
65
|
"@af/visual-regression": "workspace:^",
|
|
66
66
|
"@atlaskit/code": "^17.4.0",
|
|
67
|
-
"@atlaskit/docs": "^11.
|
|
68
|
-
"@atlaskit/dropdown-menu": "^16.
|
|
69
|
-
"@atlaskit/ds-lib": "^
|
|
70
|
-
"@atlaskit/form": "^15.
|
|
71
|
-
"@atlaskit/inline-message": "^15.
|
|
67
|
+
"@atlaskit/docs": "^11.7.0",
|
|
68
|
+
"@atlaskit/dropdown-menu": "^16.7.0",
|
|
69
|
+
"@atlaskit/ds-lib": "^6.0.0",
|
|
70
|
+
"@atlaskit/form": "^15.4.0",
|
|
71
|
+
"@atlaskit/inline-message": "^15.6.0",
|
|
72
72
|
"@atlaskit/link": "^3.3.0",
|
|
73
73
|
"@atlaskit/menu": "^8.4.0",
|
|
74
74
|
"@atlaskit/modal-dialog": "^14.11.0",
|
package/constants/package.json
DELETED
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@atlaskit/drawer/constants",
|
|
3
|
-
"main": "../dist/cjs/constants.js",
|
|
4
|
-
"module": "../dist/esm/constants.js",
|
|
5
|
-
"module:es2019": "../dist/es2019/constants.js",
|
|
6
|
-
"sideEffects": [
|
|
7
|
-
"**/*.compiled.css"
|
|
8
|
-
],
|
|
9
|
-
"types": "../dist/types/constants.d.ts",
|
|
10
|
-
"typesVersions": {
|
|
11
|
-
">=4.5 <5.9": {
|
|
12
|
-
"*": [
|
|
13
|
-
"../dist/types-ts4.5/constants.d.ts"
|
|
14
|
-
]
|
|
15
|
-
}
|
|
16
|
-
}
|
|
17
|
-
}
|
package/dist/cjs/constants.js
DELETED
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.widths = exports.directions = void 0;
|
|
7
|
-
var widths = exports.widths = ['narrow', 'medium', 'wide', 'extended', 'full'];
|
|
8
|
-
var directions = exports.directions = ['top', 'right', 'bottom', 'left'];
|
package/dist/es2019/constants.js
DELETED
package/dist/esm/constants.js
DELETED