@atlaskit/drawer 7.7.0 → 7.7.2

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 CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/drawer
2
2
 
3
+ ## 7.7.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [#94316](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/94316) [`35fd5ed8e1d7`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/35fd5ed8e1d7) - Upgrading internal dependency `bind-event-listener` to `@^3.0.0`
8
+
9
+ ## 7.7.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [#83116](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/83116) [`8d4e99057fe0`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/8d4e99057fe0) - Upgrade Typescript from `4.9.5` to `5.4.2`
14
+
3
15
  ## 7.7.0
4
16
 
5
17
  ### Minor Changes
@@ -6,7 +6,7 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/constants.d.ts",
8
8
  "typesVersions": {
9
- ">=4.5 <4.9": {
9
+ ">=4.5 <5.4": {
10
10
  "*": [
11
11
  "../dist/types-ts4.5/constants.d.ts"
12
12
  ]
@@ -27,7 +27,7 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
27
27
  function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
28
28
  function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); } /* eslint-disable @repo/internal/dom-events/no-unsafe-event-listeners */
29
29
  var packageName = "@atlaskit/drawer";
30
- var packageVersion = "7.7.0";
30
+ var packageVersion = "7.7.2";
31
31
  var createAndFireEventOnAtlaskit = (0, _analyticsNext.createAndFireEvent)('atlaskit');
32
32
  var createAndFireOnClick = function createAndFireOnClick(createAnalyticsEvent, trigger) {
33
33
  return createAndFireEventOnAtlaskit({
@@ -8,7 +8,7 @@ import { defaultFocusLockSettings } from '../constants';
8
8
  import Blanket from './blanket';
9
9
  import DrawerPrimitive from './primitives';
10
10
  const packageName = "@atlaskit/drawer";
11
- const packageVersion = "7.7.0";
11
+ const packageVersion = "7.7.2";
12
12
  const createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
13
13
  const createAndFireOnClick = (createAnalyticsEvent, trigger) => createAndFireEventOnAtlaskit({
14
14
  action: 'dismissed',
@@ -18,7 +18,7 @@ import { defaultFocusLockSettings } from '../constants';
18
18
  import Blanket from './blanket';
19
19
  import DrawerPrimitive from './primitives';
20
20
  var packageName = "@atlaskit/drawer";
21
- var packageVersion = "7.7.0";
21
+ var packageVersion = "7.7.2";
22
22
  var createAndFireEventOnAtlaskit = createAndFireEvent('atlaskit');
23
23
  var createAndFireOnClick = function createAndFireOnClick(createAnalyticsEvent, trigger) {
24
24
  return createAndFireEventOnAtlaskit({
@@ -21,7 +21,7 @@ export type Widths = {
21
21
  export type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
22
22
  export interface BaseProps {
23
23
  /**
24
- * A unique hook to be used for testing.
24
+ * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
25
25
  */
26
26
  testId?: string;
27
27
  /**
@@ -33,11 +33,11 @@ export interface BaseProps {
33
33
  */
34
34
  icon?: ComponentType<any>;
35
35
  /**
36
- * Provides an accessible name for the close/back control of the drawer. Default is "Close drawer".
36
+ * This is the accessible name for the close/back control of the drawer. The default is "Close drawer".
37
37
  */
38
38
  closeLabel?: string;
39
39
  /**
40
- * Available drawer sizes.
40
+ * Sets the width of the drawer.
41
41
  */
42
42
  width?: DrawerWidth;
43
43
  /**
@@ -54,18 +54,18 @@ export interface BaseProps {
54
54
  */
55
55
  shouldUnmountOnExit?: boolean;
56
56
  /**
57
- * Override drawer components.
57
+ * Avoid overrides whenever possible. The `overrides` prop allows granular customisation of the drawer. Both the sidebar and content components can be overridden.
58
58
  */
59
59
  overrides?: OverridesType;
60
60
  }
61
61
  export interface DrawerLabel {
62
62
  /**
63
- * Refers to an aria-label attribute. Sets an accessible name for drawer wrapper to announce it to users of assistive technology.
63
+ * This is an `aria-label` attribute. It sets an accessible name for the drawer wrapper, for people who use assistive technology.
64
64
  * Usage of either this, or the `titleId` attribute is strongly recommended.
65
65
  */
66
66
  label?: string;
67
67
  /**
68
- * Id referenced by the drawer wrapper's aria-labelledby attribute. This id should be assigned to the drawer title element.
68
+ * This is an ID referenced by the drawer wrapper's `aria-labelledby` attribute. This ID should be assigned to the drawer `title` element.
69
69
  * Usage of either this, or the `label` attribute is strongly recommended.
70
70
  */
71
71
  titleId?: string;
@@ -142,11 +142,11 @@ export interface FocusLockSettings {
142
142
  */
143
143
  autoFocusFirstElem?: boolean | (() => HTMLElement | null);
144
144
  /**
145
- * Whether the focus lock is active or not.
145
+ * Enable this to keep focus inside the component until it’s closed. This is strongly recommended, as it prevents people who use assistive technology from accidentally navigating out of the drawer using the tab key.
146
146
  */
147
147
  isFocusLockEnabled?: boolean;
148
148
  /**
149
- * Controls whether to return the focus to the previous active element on closing the drawer. Set to `true` by default.
149
+ * Controls whether to return the focus to the previous active element on closing the drawer. Set to `true` by default. Changing this is not recommended as returning focus is required for accessibility.
150
150
  */
151
151
  shouldReturnFocus?: boolean;
152
152
  }
@@ -21,7 +21,7 @@ export type Widths = {
21
21
  export type DrawerWidth = 'extended' | 'full' | 'medium' | 'narrow' | 'wide';
22
22
  export interface BaseProps {
23
23
  /**
24
- * A unique hook to be used for testing.
24
+ * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests.
25
25
  */
26
26
  testId?: string;
27
27
  /**
@@ -33,11 +33,11 @@ export interface BaseProps {
33
33
  */
34
34
  icon?: ComponentType<any>;
35
35
  /**
36
- * Provides an accessible name for the close/back control of the drawer. Default is "Close drawer".
36
+ * This is the accessible name for the close/back control of the drawer. The default is "Close drawer".
37
37
  */
38
38
  closeLabel?: string;
39
39
  /**
40
- * Available drawer sizes.
40
+ * Sets the width of the drawer.
41
41
  */
42
42
  width?: DrawerWidth;
43
43
  /**
@@ -54,18 +54,18 @@ export interface BaseProps {
54
54
  */
55
55
  shouldUnmountOnExit?: boolean;
56
56
  /**
57
- * Override drawer components.
57
+ * Avoid overrides whenever possible. The `overrides` prop allows granular customisation of the drawer. Both the sidebar and content components can be overridden.
58
58
  */
59
59
  overrides?: OverridesType;
60
60
  }
61
61
  export interface DrawerLabel {
62
62
  /**
63
- * Refers to an aria-label attribute. Sets an accessible name for drawer wrapper to announce it to users of assistive technology.
63
+ * This is an `aria-label` attribute. It sets an accessible name for the drawer wrapper, for people who use assistive technology.
64
64
  * Usage of either this, or the `titleId` attribute is strongly recommended.
65
65
  */
66
66
  label?: string;
67
67
  /**
68
- * Id referenced by the drawer wrapper's aria-labelledby attribute. This id should be assigned to the drawer title element.
68
+ * This is an ID referenced by the drawer wrapper's `aria-labelledby` attribute. This ID should be assigned to the drawer `title` element.
69
69
  * Usage of either this, or the `label` attribute is strongly recommended.
70
70
  */
71
71
  titleId?: string;
@@ -142,11 +142,11 @@ export interface FocusLockSettings {
142
142
  */
143
143
  autoFocusFirstElem?: boolean | (() => HTMLElement | null);
144
144
  /**
145
- * Whether the focus lock is active or not.
145
+ * Enable this to keep focus inside the component until it’s closed. This is strongly recommended, as it prevents people who use assistive technology from accidentally navigating out of the drawer using the tab key.
146
146
  */
147
147
  isFocusLockEnabled?: boolean;
148
148
  /**
149
- * Controls whether to return the focus to the previous active element on closing the drawer. Set to `true` by default.
149
+ * Controls whether to return the focus to the previous active element on closing the drawer. Set to `true` by default. Changing this is not recommended as returning focus is required for accessibility.
150
150
  */
151
151
  shouldReturnFocus?: boolean;
152
152
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/drawer",
3
- "version": "7.7.0",
3
+ "version": "7.7.2",
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
  }
40
40
  },
41
41
  "dependencies": {
42
- "@atlaskit/analytics-next": "^9.2.0",
43
- "@atlaskit/blanket": "^13.0.0",
42
+ "@atlaskit/analytics-next": "^9.3.0",
43
+ "@atlaskit/blanket": "^13.1.0",
44
44
  "@atlaskit/icon": "^22.1.0",
45
45
  "@atlaskit/motion": "^1.5.0",
46
46
  "@atlaskit/portal": "^4.4.0",
47
- "@atlaskit/theme": "^12.6.0",
48
- "@atlaskit/tokens": "^1.41.0",
47
+ "@atlaskit/theme": "^12.7.0",
48
+ "@atlaskit/tokens": "^1.43.0",
49
49
  "@babel/runtime": "^7.0.0",
50
50
  "@emotion/react": "^11.7.1",
51
- "bind-event-listener": "^2.1.1",
51
+ "bind-event-listener": "^3.0.0",
52
52
  "exenv": "^1.2.2",
53
53
  "react-focus-lock": "^2.9.5",
54
54
  "react-scrolllock": "^5.0.1",
@@ -62,7 +62,7 @@
62
62
  "@af/accessibility-testing": "*",
63
63
  "@af/integration-testing": "*",
64
64
  "@af/visual-regression": "*",
65
- "@atlaskit/ds-lib": "^2.2.0",
65
+ "@atlaskit/ds-lib": "^2.3.0",
66
66
  "@atlaskit/ssr": "*",
67
67
  "@atlaskit/visual-regression": "*",
68
68
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
@@ -72,7 +72,7 @@
72
72
  "lodash": "^4.17.21",
73
73
  "react-dom": "^16.8.0",
74
74
  "react-lorem-component": "^0.13.0",
75
- "typescript": "~4.9.5",
75
+ "typescript": "~5.4.2",
76
76
  "wait-for-expect": "^1.2.0"
77
77
  },
78
78
  "techstack": {
@@ -98,4 +98,4 @@
98
98
  }
99
99
  },
100
100
  "prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
101
- }
101
+ }