@atlaskit/drawer 7.10.0 → 7.12.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 (35) hide show
  1. package/CHANGELOG.md +710 -691
  2. package/dist/cjs/components/blanket.js +16 -8
  3. package/dist/cjs/components/index.js +4 -2
  4. package/dist/cjs/components/primitives/content.js +41 -14
  5. package/dist/cjs/components/primitives/drawer-wrapper.js +10 -2
  6. package/dist/cjs/components/primitives/index.js +11 -2
  7. package/dist/cjs/components/primitives/sidebar.js +5 -1
  8. package/dist/es2019/components/blanket.js +8 -1
  9. package/dist/es2019/components/index.js +4 -2
  10. package/dist/es2019/components/primitives/content.js +37 -11
  11. package/dist/es2019/components/primitives/drawer-wrapper.js +11 -2
  12. package/dist/es2019/components/primitives/index.js +12 -2
  13. package/dist/es2019/components/primitives/sidebar.js +5 -1
  14. package/dist/esm/components/blanket.js +16 -8
  15. package/dist/esm/components/index.js +4 -2
  16. package/dist/esm/components/primitives/content.js +41 -13
  17. package/dist/esm/components/primitives/drawer-wrapper.js +11 -2
  18. package/dist/esm/components/primitives/index.js +12 -2
  19. package/dist/esm/components/primitives/sidebar.js +5 -1
  20. package/dist/types/components/blanket.d.ts +3 -0
  21. package/dist/types/components/index.d.ts +2 -2
  22. package/dist/types/components/primitives/content.d.ts +4 -1
  23. package/dist/types/components/primitives/drawer-wrapper.d.ts +3 -0
  24. package/dist/types/components/primitives/index.d.ts +4 -1
  25. package/dist/types/components/primitives/sidebar.d.ts +3 -0
  26. package/dist/types/components/types.d.ts +8 -0
  27. package/dist/types-ts4.5/components/blanket.d.ts +3 -0
  28. package/dist/types-ts4.5/components/index.d.ts +2 -2
  29. package/dist/types-ts4.5/components/primitives/content.d.ts +4 -1
  30. package/dist/types-ts4.5/components/primitives/drawer-wrapper.d.ts +3 -0
  31. package/dist/types-ts4.5/components/primitives/index.d.ts +4 -1
  32. package/dist/types-ts4.5/components/primitives/sidebar.d.ts +3 -0
  33. package/dist/types-ts4.5/components/types.d.ts +8 -0
  34. package/package.json +100 -102
  35. package/report.api.md +117 -128
package/report.api.md CHANGED
@@ -2,7 +2,8 @@
2
2
 
3
3
  ## API Report File for "@atlaskit/drawer"
4
4
 
5
- > Do not edit this file. This report is auto-generated using [API Extractor](https://api-extractor.com/).
5
+ > Do not edit this file. This report is auto-generated using
6
+ > [API Extractor](https://api-extractor.com/).
6
7
  > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
7
8
 
8
9
  ### Table of contents
@@ -26,15 +27,15 @@ import { WithContextProps } from '@atlaskit/analytics-next';
26
27
 
27
28
  // @public (undocumented)
28
29
  export interface BaseProps {
29
- children?: ReactNode;
30
- icon?: ComponentType<any>;
31
- onCloseComplete?: (node: HTMLElement | null) => void;
32
- onOpenComplete?: (node: HTMLElement | null) => void;
33
- overrides?: OverridesType;
34
- // @deprecated (undocumented)
35
- shouldUnmountOnExit?: boolean;
36
- testId?: string;
37
- width?: DrawerWidth;
30
+ children?: ReactNode;
31
+ icon?: ComponentType<any>;
32
+ onCloseComplete?: (node: HTMLElement | null) => void;
33
+ onOpenComplete?: (node: HTMLElement | null) => void;
34
+ overrides?: OverridesType;
35
+ // @deprecated (undocumented)
36
+ shouldUnmountOnExit?: boolean;
37
+ testId?: string;
38
+ width?: DrawerWidth;
38
39
  }
39
40
 
40
41
  // @public
@@ -45,145 +46,133 @@ export type ContentCSSProps = Omit<ContentProps, 'cssFn'>;
45
46
 
46
47
  // @public (undocumented)
47
48
  export interface ContentProps extends React.HTMLProps<HTMLDivElement> {
48
- // @deprecated (undocumented)
49
- cssFn: (defaultStyles: CSSObject) => CSSObject;
49
+ // @deprecated (undocumented)
50
+ cssFn: (defaultStyles: CSSObject) => CSSObject;
50
51
  }
51
52
 
52
53
  // @public (undocumented)
53
54
  const _default: React_2.ForwardRefExoticComponent<
54
- Pick<
55
- Pick<
56
- Omit<DrawerProps, keyof WithAnalyticsEventsProps>,
57
- | 'children'
58
- | 'icon'
59
- | 'isOpen'
60
- | 'onClose'
61
- | 'onCloseComplete'
62
- | 'onKeyDown'
63
- | 'onOpenComplete'
64
- | 'overrides'
65
- | 'shouldUnmountOnExit'
66
- | 'testId'
67
- | 'zIndex'
68
- | keyof DrawerLabel
69
- > &
70
- Partial<
71
- Pick<
72
- Omit<DrawerProps, keyof WithAnalyticsEventsProps>,
73
- 'width' | keyof FocusLockSettings
74
- >
75
- > &
76
- Partial<
77
- Pick<
78
- {
79
- autoFocusFirstElem?:
80
- | (() => HTMLElement | null)
81
- | boolean
82
- | undefined;
83
- isFocusLockEnabled?: boolean | undefined;
84
- shouldReturnFocus?: boolean | undefined;
85
- width: DrawerWidth;
86
- },
87
- never
88
- >
89
- > &
90
- React_2.RefAttributes<any> &
91
- WithContextProps,
92
- | 'analyticsContext'
93
- | 'children'
94
- | 'icon'
95
- | 'isOpen'
96
- | 'key'
97
- | 'onClose'
98
- | 'onCloseComplete'
99
- | 'onKeyDown'
100
- | 'onOpenComplete'
101
- | 'overrides'
102
- | 'shouldUnmountOnExit'
103
- | 'testId'
104
- | 'width'
105
- | 'zIndex'
106
- | keyof DrawerLabel
107
- | keyof FocusLockSettings
108
- > &
109
- React_2.RefAttributes<any>
55
+ Pick<
56
+ Pick<
57
+ Omit<DrawerProps, keyof WithAnalyticsEventsProps>,
58
+ | 'children'
59
+ | 'icon'
60
+ | 'isOpen'
61
+ | 'onClose'
62
+ | 'onCloseComplete'
63
+ | 'onKeyDown'
64
+ | 'onOpenComplete'
65
+ | 'overrides'
66
+ | 'shouldUnmountOnExit'
67
+ | 'testId'
68
+ | 'zIndex'
69
+ | keyof DrawerLabel
70
+ > &
71
+ Partial<
72
+ Pick<Omit<DrawerProps, keyof WithAnalyticsEventsProps>, 'width' | keyof FocusLockSettings>
73
+ > &
74
+ Partial<
75
+ Pick<
76
+ {
77
+ autoFocusFirstElem?: (() => HTMLElement | null) | boolean | undefined;
78
+ isFocusLockEnabled?: boolean | undefined;
79
+ shouldReturnFocus?: boolean | undefined;
80
+ width: DrawerWidth;
81
+ },
82
+ never
83
+ >
84
+ > &
85
+ React_2.RefAttributes<any> &
86
+ WithContextProps,
87
+ | 'analyticsContext'
88
+ | 'children'
89
+ | 'icon'
90
+ | 'isOpen'
91
+ | 'key'
92
+ | 'onClose'
93
+ | 'onCloseComplete'
94
+ | 'onKeyDown'
95
+ | 'onOpenComplete'
96
+ | 'overrides'
97
+ | 'shouldUnmountOnExit'
98
+ | 'testId'
99
+ | 'width'
100
+ | 'zIndex'
101
+ | keyof DrawerLabel
102
+ | keyof FocusLockSettings
103
+ > &
104
+ React_2.RefAttributes<any>
110
105
  >;
111
106
  export default _default;
112
107
 
113
108
  // @public (undocumented)
114
109
  export type DefaultsType = {
115
- Sidebar: {
116
- component: React.ComponentType<SidebarProps>;
117
- cssFn: (defaultStyles: CSSObject) => CSSObject;
118
- };
119
- Content: {
120
- component: React.ComponentType<ContentProps>;
121
- cssFn: (defaultStyles: CSSObject) => CSSObject;
122
- };
110
+ Sidebar: {
111
+ component: React.ComponentType<SidebarProps>;
112
+ cssFn: (defaultStyles: CSSObject) => CSSObject;
113
+ };
114
+ Content: {
115
+ component: React.ComponentType<ContentProps>;
116
+ cssFn: (defaultStyles: CSSObject) => CSSObject;
117
+ };
123
118
  };
124
119
 
125
120
  // @public (undocumented)
126
121
  interface DrawerLabel {
127
- label?: string;
128
- titleId?: string;
122
+ label?: string;
123
+ titleId?: string;
129
124
  }
130
125
 
131
126
  // @public (undocumented)
132
127
  export type DrawerPrimitiveDefaults = Pick<DefaultsType, 'Content' | 'Sidebar'>;
133
128
 
134
129
  // @public (undocumented)
135
- export type DrawerPrimitiveOverrides = Pick<
136
- OverridesType,
137
- 'Content' | 'Sidebar'
138
- >;
130
+ export type DrawerPrimitiveOverrides = Pick<OverridesType, 'Content' | 'Sidebar'>;
139
131
 
140
132
  // @public (undocumented)
141
- export interface DrawerPrimitiveProps
142
- extends BaseProps,
143
- FocusLockSettings,
144
- DrawerLabel {
145
- // (undocumented)
146
- in: boolean;
147
- // (undocumented)
148
- onClose: (event: SyntheticEvent<HTMLElement>) => void;
133
+ export interface DrawerPrimitiveProps extends BaseProps, FocusLockSettings, DrawerLabel {
134
+ // (undocumented)
135
+ in: boolean;
136
+ // (undocumented)
137
+ onClose: (event: SyntheticEvent<HTMLElement>) => void;
149
138
  }
150
139
 
151
140
  // @public (undocumented)
152
141
  export type DrawerProps = BaseProps &
153
- FocusLockSettings &
154
- WithAnalyticsEventsProps &
155
- DrawerLabel & {
156
- onKeyDown?: (event: SyntheticEvent) => void;
157
- onClose?: (event: SyntheticEvent<HTMLElement>, analyticsEvent: any) => void;
158
- isOpen: boolean;
159
- zIndex?: number;
160
- };
142
+ FocusLockSettings &
143
+ WithAnalyticsEventsProps &
144
+ DrawerLabel & {
145
+ onKeyDown?: (event: SyntheticEvent) => void;
146
+ onClose?: (event: SyntheticEvent<HTMLElement>, analyticsEvent: any) => void;
147
+ isOpen: boolean;
148
+ zIndex?: number;
149
+ };
161
150
 
162
151
  // @public (undocumented)
163
152
  export type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
164
153
 
165
154
  // @public (undocumented)
166
155
  export interface FocusLockProps extends FocusLockSettings {
167
- children?: ReactElement;
156
+ children?: ReactElement;
168
157
  }
169
158
 
170
159
  // @public (undocumented)
171
160
  interface FocusLockSettings {
172
- autoFocusFirstElem?: (() => HTMLElement | null) | boolean;
173
- isFocusLockEnabled?: boolean;
174
- shouldReturnFocus?: boolean;
161
+ autoFocusFirstElem?: (() => HTMLElement | null) | boolean;
162
+ isFocusLockEnabled?: boolean;
163
+ shouldReturnFocus?: boolean;
175
164
  }
176
165
 
177
166
  // @public (undocumented)
178
167
  export type OverridesType = {
179
- Sidebar?: {
180
- component?: React.ComponentType<SidebarProps>;
181
- cssFn?: (defaultStyles: CSSObject) => CSSObject;
182
- };
183
- Content?: {
184
- component?: React.ComponentType<ContentProps>;
185
- cssFn?: (defaultStyles: CSSObject) => CSSObject;
186
- };
168
+ Sidebar?: {
169
+ component?: React.ComponentType<SidebarProps>;
170
+ cssFn?: (defaultStyles: CSSObject) => CSSObject;
171
+ };
172
+ Content?: {
173
+ component?: React.ComponentType<ContentProps>;
174
+ cssFn?: (defaultStyles: CSSObject) => CSSObject;
175
+ };
187
176
  };
188
177
 
189
178
  // @public (undocumented)
@@ -191,27 +180,27 @@ export type SidebarCSSProps = Omit<SidebarProps, 'cssFn'>;
191
180
 
192
181
  // @public (undocumented)
193
182
  export interface SidebarProps extends React.HTMLProps<HTMLDivElement> {
194
- // @deprecated (undocumented)
195
- cssFn: (defaultStyles: CSSObject) => CSSObject;
183
+ // @deprecated (undocumented)
184
+ cssFn: (defaultStyles: CSSObject) => CSSObject;
196
185
  }
197
186
 
198
187
  // @public (undocumented)
199
188
  export type Widths = {
200
- extended: {
201
- width: string;
202
- };
203
- full: {
204
- width: string;
205
- };
206
- medium: {
207
- width: number;
208
- };
209
- narrow: {
210
- width: number;
211
- };
212
- wide: {
213
- width: number;
214
- };
189
+ extended: {
190
+ width: string;
191
+ };
192
+ full: {
193
+ width: string;
194
+ };
195
+ medium: {
196
+ width: number;
197
+ };
198
+ narrow: {
199
+ width: number;
200
+ };
201
+ wide: {
202
+ width: number;
203
+ };
215
204
  };
216
205
 
217
206
  // (No @packageDocumentation comment for this package)
@@ -225,7 +214,7 @@ export type Widths = {
225
214
 
226
215
  ```json
227
216
  {
228
- "react": "^16.8.0"
217
+ "react": "^16.8.0"
229
218
  }
230
219
  ```
231
220