@atlaskit/navigation-system 11.8.4 → 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.
Files changed (34) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/dist/cjs/index.js +0 -21
  3. package/dist/cjs/ui/page-layout/side-nav/toggle-button.js +2 -1
  4. package/dist/es2019/index.js +0 -3
  5. package/dist/es2019/ui/page-layout/side-nav/toggle-button.js +2 -1
  6. package/dist/esm/index.js +0 -3
  7. package/dist/esm/ui/page-layout/side-nav/toggle-button.js +2 -1
  8. package/dist/types/index.d.ts +0 -3
  9. package/package.json +2 -2
  10. package/dist/cjs/entry-points/fhs-rollout.js +0 -26
  11. package/dist/cjs/ui/fhs-rollout/is-custom-is-fhs-enabled-context.js +0 -14
  12. package/dist/cjs/ui/fhs-rollout/is-fhs-enabled-context.js +0 -17
  13. package/dist/cjs/ui/fhs-rollout/is-fhs-enabled-provider.js +0 -25
  14. package/dist/cjs/ui/fhs-rollout/types.js +0 -1
  15. package/dist/cjs/ui/fhs-rollout/use-is-fhs-enabled.js +0 -17
  16. package/dist/es2019/entry-points/fhs-rollout.js +0 -3
  17. package/dist/es2019/ui/fhs-rollout/is-custom-is-fhs-enabled-context.js +0 -9
  18. package/dist/es2019/ui/fhs-rollout/is-fhs-enabled-context.js +0 -11
  19. package/dist/es2019/ui/fhs-rollout/is-fhs-enabled-provider.js +0 -18
  20. package/dist/es2019/ui/fhs-rollout/types.js +0 -0
  21. package/dist/es2019/ui/fhs-rollout/use-is-fhs-enabled.js +0 -9
  22. package/dist/esm/entry-points/fhs-rollout.js +0 -3
  23. package/dist/esm/ui/fhs-rollout/is-custom-is-fhs-enabled-context.js +0 -9
  24. package/dist/esm/ui/fhs-rollout/is-fhs-enabled-context.js +0 -11
  25. package/dist/esm/ui/fhs-rollout/is-fhs-enabled-provider.js +0 -19
  26. package/dist/esm/ui/fhs-rollout/types.js +0 -0
  27. package/dist/esm/ui/fhs-rollout/use-is-fhs-enabled.js +0 -11
  28. package/dist/types/entry-points/fhs-rollout.d.ts +0 -3
  29. package/dist/types/ui/fhs-rollout/is-custom-is-fhs-enabled-context.d.ts +0 -7
  30. package/dist/types/ui/fhs-rollout/is-fhs-enabled-context.d.ts +0 -11
  31. package/dist/types/ui/fhs-rollout/is-fhs-enabled-provider.d.ts +0 -17
  32. package/dist/types/ui/fhs-rollout/types.d.ts +0 -1
  33. package/dist/types/ui/fhs-rollout/use-is-fhs-enabled.d.ts +0 -9
  34. package/fhs-rollout/package.json +0 -10
package/CHANGELOG.md CHANGED
@@ -1,5 +1,44 @@
1
1
  # @atlassian/navigation-system
2
2
 
3
+ ## 12.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - [`ca32e066cf0f9`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ca32e066cf0f9) -
8
+ Remove the deprecated Full Height Sidebar (FHS) rollout API. The
9
+ `@atlaskit/navigation-system/fhs-rollout` entry point and the following exports from
10
+ `@atlaskit/navigation-system` are no longer available:
11
+
12
+ - `IsFhsEnabledProvider`
13
+ - `IsFhsEnabledProviderProps`
14
+ - `IsFhsEnabledContext`
15
+ - `useIsFhsEnabled`
16
+
17
+ FHS was rolled back in version 11.3.0. Since then, the provider has rendered its children without
18
+ using `value`, the hook has always returned `false`, and platform components have no longer read
19
+ the context. Removing these APIs does not change the current navigation layout.
20
+
21
+ Before upgrading:
22
+
23
+ - Remove imports from `@atlaskit/navigation-system/fhs-rollout` and imports of the removed APIs
24
+ from the package root.
25
+ - Remove `IsFhsEnabledProvider` wrappers, preserving their children, and remove usages of
26
+ `IsFhsEnabledProviderProps`.
27
+ - Replace `useIsFhsEnabled()` calls with `false`, then simplify conditional code to keep the
28
+ FHS-off behavior.
29
+ - Remove `IsFhsEnabledContext` providers and consumers. Preserve provider children and use the
30
+ FHS-off behavior instead of reading the context.
31
+
32
+ The unused internal `IsCustomIsFhsEnabledContext` and the FHS rollout tests have also been
33
+ removed.
34
+
35
+ ### Patch Changes
36
+
37
+ - [`446fe16440842`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/446fe16440842) -
38
+ Add aria-expanded to the side nav toggle button so assistive technology can tell whether the side
39
+ nav is expanded or collapsed.
40
+ - Updated dependencies
41
+
3
42
  ## 11.8.4
4
43
 
5
44
  ### Patch Changes
package/dist/cjs/index.js CHANGED
@@ -57,18 +57,6 @@ Object.defineProperty(exports, "Help", {
57
57
  return _help.Help;
58
58
  }
59
59
  });
60
- Object.defineProperty(exports, "IsFhsEnabledContext", {
61
- enumerable: true,
62
- get: function get() {
63
- return _isFhsEnabledContext.IsFhsEnabledContext;
64
- }
65
- });
66
- Object.defineProperty(exports, "IsFhsEnabledProvider", {
67
- enumerable: true,
68
- get: function get() {
69
- return _isFhsEnabledProvider.IsFhsEnabledProvider;
70
- }
71
- });
72
60
  Object.defineProperty(exports, "LogIn", {
73
61
  enumerable: true,
74
62
  get: function get() {
@@ -189,21 +177,12 @@ Object.defineProperty(exports, "TopNavStart", {
189
177
  return _topNavStart.TopNavStart;
190
178
  }
191
179
  });
192
- Object.defineProperty(exports, "useIsFhsEnabled", {
193
- enumerable: true,
194
- get: function get() {
195
- return _useIsFhsEnabled.useIsFhsEnabled;
196
- }
197
- });
198
180
  Object.defineProperty(exports, "useToggleSideNav", {
199
181
  enumerable: true,
200
182
  get: function get() {
201
183
  return _useToggleSideNav.useToggleSideNav;
202
184
  }
203
185
  });
204
- var _isFhsEnabledContext = require("./ui/fhs-rollout/is-fhs-enabled-context");
205
- var _isFhsEnabledProvider = require("./ui/fhs-rollout/is-fhs-enabled-provider");
206
- var _useIsFhsEnabled = require("./ui/fhs-rollout/use-is-fhs-enabled");
207
186
  var _aside = require("./ui/page-layout/aside");
208
187
  var _banner = require("./ui/page-layout/banner");
209
188
  var _main = require("./ui/page-layout/main/main");
@@ -171,6 +171,7 @@ var SideNavToggleButton = exports.SideNavToggleButton = function SideNavToggleBu
171
171
  isTooltipDisabled: false,
172
172
  interactionName: interactionName,
173
173
  ref: setElement,
174
- tooltip: tooltipProps
174
+ tooltip: tooltipProps,
175
+ "aria-expanded": isSideNavExpanded
175
176
  });
176
177
  };
@@ -1,6 +1,3 @@
1
- export { IsFhsEnabledContext } from './ui/fhs-rollout/is-fhs-enabled-context';
2
- export { IsFhsEnabledProvider } from './ui/fhs-rollout/is-fhs-enabled-provider';
3
- export { useIsFhsEnabled } from './ui/fhs-rollout/use-is-fhs-enabled';
4
1
  export { Aside } from './ui/page-layout/aside';
5
2
  export { Banner } from './ui/page-layout/banner';
6
3
  export { Main } from './ui/page-layout/main/main';
@@ -152,6 +152,7 @@ export const SideNavToggleButton = ({
152
152
  isTooltipDisabled: false,
153
153
  interactionName: interactionName,
154
154
  ref: setElement,
155
- tooltip: tooltipProps
155
+ tooltip: tooltipProps,
156
+ "aria-expanded": isSideNavExpanded
156
157
  });
157
158
  };
package/dist/esm/index.js CHANGED
@@ -1,6 +1,3 @@
1
- export { IsFhsEnabledContext } from './ui/fhs-rollout/is-fhs-enabled-context';
2
- export { IsFhsEnabledProvider } from './ui/fhs-rollout/is-fhs-enabled-provider';
3
- export { useIsFhsEnabled } from './ui/fhs-rollout/use-is-fhs-enabled';
4
1
  export { Aside } from './ui/page-layout/aside';
5
2
  export { Banner } from './ui/page-layout/banner';
6
3
  export { Main } from './ui/page-layout/main/main';
@@ -162,6 +162,7 @@ export var SideNavToggleButton = function SideNavToggleButton(_ref) {
162
162
  isTooltipDisabled: false,
163
163
  interactionName: interactionName,
164
164
  ref: setElement,
165
- tooltip: tooltipProps
165
+ tooltip: tooltipProps,
166
+ "aria-expanded": isSideNavExpanded
166
167
  });
167
168
  };
@@ -1,6 +1,3 @@
1
- export { IsFhsEnabledContext } from './ui/fhs-rollout/is-fhs-enabled-context';
2
- export { IsFhsEnabledProvider, type IsFhsEnabledProviderProps, } from './ui/fhs-rollout/is-fhs-enabled-provider';
3
- export { useIsFhsEnabled } from './ui/fhs-rollout/use-is-fhs-enabled';
4
1
  export { Aside } from './ui/page-layout/aside';
5
2
  export { Banner } from './ui/page-layout/banner';
6
3
  export { Main } from './ui/page-layout/main/main';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/navigation-system",
3
- "version": "11.8.4",
3
+ "version": "12.0.0",
4
4
  "description": "The latest navigation system for Atlassian apps.",
5
5
  "repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
6
6
  "license": "Apache-2.0",
@@ -101,7 +101,7 @@
101
101
  "@atlaskit/flag": "^19.0.0",
102
102
  "@atlaskit/form": "^18.3.0",
103
103
  "@atlaskit/heading": "^8.0.0",
104
- "@atlaskit/icon-lab": "^7.11.0",
104
+ "@atlaskit/icon-lab": "^7.12.0",
105
105
  "@atlaskit/image": "^5.2.0",
106
106
  "@atlaskit/inline-dialog": "^20.3.0",
107
107
  "@atlaskit/link": "^5.1.0",
@@ -1,26 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- Object.defineProperty(exports, "IsFhsEnabledContext", {
7
- enumerable: true,
8
- get: function get() {
9
- return _isFhsEnabledContext.IsFhsEnabledContext;
10
- }
11
- });
12
- Object.defineProperty(exports, "IsFhsEnabledProvider", {
13
- enumerable: true,
14
- get: function get() {
15
- return _isFhsEnabledProvider.IsFhsEnabledProvider;
16
- }
17
- });
18
- Object.defineProperty(exports, "useIsFhsEnabled", {
19
- enumerable: true,
20
- get: function get() {
21
- return _useIsFhsEnabled.useIsFhsEnabled;
22
- }
23
- });
24
- var _isFhsEnabledContext = require("../ui/fhs-rollout/is-fhs-enabled-context");
25
- var _isFhsEnabledProvider = require("../ui/fhs-rollout/is-fhs-enabled-provider");
26
- var _useIsFhsEnabled = require("../ui/fhs-rollout/use-is-fhs-enabled");
@@ -1,14 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.IsCustomIsFhsEnabledContext = void 0;
7
- var _react = require("react");
8
- /**
9
- * __Is custom is fhs enabled context__
10
- *
11
- * @deprecated Full height sidebar (FHS) has been rolled back. This context is no longer used and
12
- * will be deleted in a future major release.
13
- */
14
- var IsCustomIsFhsEnabledContext = exports.IsCustomIsFhsEnabledContext = /*#__PURE__*/(0, _react.createContext)(false);
@@ -1,17 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.IsFhsEnabledContext = void 0;
7
- var _react = require("react");
8
- /**
9
- * __Is fhs enabled context__
10
- *
11
- * @deprecated Full height sidebar (FHS) has been rolled back and this context is no longer read by
12
- * any platform component. Its value is ignored. Remove usages of it; it will be deleted in a future
13
- * major release.
14
- *
15
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
16
- */
17
- var IsFhsEnabledContext = exports.IsFhsEnabledContext = /*#__PURE__*/(0, _react.createContext)(false);
@@ -1,25 +0,0 @@
1
- "use strict";
2
-
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
- Object.defineProperty(exports, "__esModule", {
5
- value: true
6
- });
7
- exports.IsFhsEnabledProvider = void 0;
8
- var _react = _interopRequireDefault(require("react"));
9
- /**
10
- * __Is fhs enabled provider__
11
- *
12
- * @deprecated Full height sidebar (FHS) has been rolled back. This provider is now a passthrough:
13
- * it renders its children and ignores `value`. Remove it from your app; it will be deleted in a
14
- * future major release.
15
- *
16
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
17
- */
18
- var IsFhsEnabledProvider = exports.IsFhsEnabledProvider = function IsFhsEnabledProvider(_ref) {
19
- var children = _ref.children;
20
- return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, children);
21
- };
22
-
23
- /**
24
- * @deprecated Full height sidebar (FHS) has been rolled back. `value` is ignored.
25
- */
@@ -1 +0,0 @@
1
- "use strict";
@@ -1,17 +0,0 @@
1
- "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.useIsFhsEnabled = void 0;
7
- /**
8
- * __Use is fhs enabled__
9
- *
10
- * @deprecated Full height sidebar (FHS) has been rolled back. This hook always returns `false`.
11
- * Remove usages of it (treat it as `false`); it will be deleted in a future major release.
12
- *
13
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
14
- */
15
- var useIsFhsEnabled = exports.useIsFhsEnabled = function useIsFhsEnabled() {
16
- return false;
17
- };
@@ -1,3 +0,0 @@
1
- export { IsFhsEnabledContext } from '../ui/fhs-rollout/is-fhs-enabled-context';
2
- export { IsFhsEnabledProvider } from '../ui/fhs-rollout/is-fhs-enabled-provider';
3
- export { useIsFhsEnabled } from '../ui/fhs-rollout/use-is-fhs-enabled';
@@ -1,9 +0,0 @@
1
- import { createContext } from 'react';
2
-
3
- /**
4
- * __Is custom is fhs enabled context__
5
- *
6
- * @deprecated Full height sidebar (FHS) has been rolled back. This context is no longer used and
7
- * will be deleted in a future major release.
8
- */
9
- export const IsCustomIsFhsEnabledContext = /*#__PURE__*/createContext(false);
@@ -1,11 +0,0 @@
1
- import { createContext } from 'react';
2
- /**
3
- * __Is fhs enabled context__
4
- *
5
- * @deprecated Full height sidebar (FHS) has been rolled back and this context is no longer read by
6
- * any platform component. Its value is ignored. Remove usages of it; it will be deleted in a future
7
- * major release.
8
- *
9
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
10
- */
11
- export const IsFhsEnabledContext = /*#__PURE__*/createContext(false);
@@ -1,18 +0,0 @@
1
- import React from 'react';
2
-
3
- /**
4
- * __Is fhs enabled provider__
5
- *
6
- * @deprecated Full height sidebar (FHS) has been rolled back. This provider is now a passthrough:
7
- * it renders its children and ignores `value`. Remove it from your app; it will be deleted in a
8
- * future major release.
9
- *
10
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
11
- */
12
- export const IsFhsEnabledProvider = ({
13
- children
14
- }) => /*#__PURE__*/React.createElement(React.Fragment, null, children);
15
-
16
- /**
17
- * @deprecated Full height sidebar (FHS) has been rolled back. `value` is ignored.
18
- */
File without changes
@@ -1,9 +0,0 @@
1
- /**
2
- * __Use is fhs enabled__
3
- *
4
- * @deprecated Full height sidebar (FHS) has been rolled back. This hook always returns `false`.
5
- * Remove usages of it (treat it as `false`); it will be deleted in a future major release.
6
- *
7
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
8
- */
9
- export const useIsFhsEnabled = () => false;
@@ -1,3 +0,0 @@
1
- export { IsFhsEnabledContext } from '../ui/fhs-rollout/is-fhs-enabled-context';
2
- export { IsFhsEnabledProvider } from '../ui/fhs-rollout/is-fhs-enabled-provider';
3
- export { useIsFhsEnabled } from '../ui/fhs-rollout/use-is-fhs-enabled';
@@ -1,9 +0,0 @@
1
- import { createContext } from 'react';
2
-
3
- /**
4
- * __Is custom is fhs enabled context__
5
- *
6
- * @deprecated Full height sidebar (FHS) has been rolled back. This context is no longer used and
7
- * will be deleted in a future major release.
8
- */
9
- export var IsCustomIsFhsEnabledContext = /*#__PURE__*/createContext(false);
@@ -1,11 +0,0 @@
1
- import { createContext } from 'react';
2
- /**
3
- * __Is fhs enabled context__
4
- *
5
- * @deprecated Full height sidebar (FHS) has been rolled back and this context is no longer read by
6
- * any platform component. Its value is ignored. Remove usages of it; it will be deleted in a future
7
- * major release.
8
- *
9
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
10
- */
11
- export var IsFhsEnabledContext = /*#__PURE__*/createContext(false);
@@ -1,19 +0,0 @@
1
- import React from 'react';
2
-
3
- /**
4
- * __Is fhs enabled provider__
5
- *
6
- * @deprecated Full height sidebar (FHS) has been rolled back. This provider is now a passthrough:
7
- * it renders its children and ignores `value`. Remove it from your app; it will be deleted in a
8
- * future major release.
9
- *
10
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
11
- */
12
- export var IsFhsEnabledProvider = function IsFhsEnabledProvider(_ref) {
13
- var children = _ref.children;
14
- return /*#__PURE__*/React.createElement(React.Fragment, null, children);
15
- };
16
-
17
- /**
18
- * @deprecated Full height sidebar (FHS) has been rolled back. `value` is ignored.
19
- */
File without changes
@@ -1,11 +0,0 @@
1
- /**
2
- * __Use is fhs enabled__
3
- *
4
- * @deprecated Full height sidebar (FHS) has been rolled back. This hook always returns `false`.
5
- * Remove usages of it (treat it as `false`); it will be deleted in a future major release.
6
- *
7
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
8
- */
9
- export var useIsFhsEnabled = function useIsFhsEnabled() {
10
- return false;
11
- };
@@ -1,3 +0,0 @@
1
- export { IsFhsEnabledContext } from '../ui/fhs-rollout/is-fhs-enabled-context';
2
- export { IsFhsEnabledProvider, type IsFhsEnabledProviderProps, } from '../ui/fhs-rollout/is-fhs-enabled-provider';
3
- export { useIsFhsEnabled } from '../ui/fhs-rollout/use-is-fhs-enabled';
@@ -1,7 +0,0 @@
1
- /**
2
- * __Is custom is fhs enabled context__
3
- *
4
- * @deprecated Full height sidebar (FHS) has been rolled back. This context is no longer used and
5
- * will be deleted in a future major release.
6
- */
7
- export declare const IsCustomIsFhsEnabledContext: import('react').Context<boolean>;
@@ -1,11 +0,0 @@
1
- import type { Get } from './types';
2
- /**
3
- * __Is fhs enabled context__
4
- *
5
- * @deprecated Full height sidebar (FHS) has been rolled back and this context is no longer read by
6
- * any platform component. Its value is ignored. Remove usages of it; it will be deleted in a future
7
- * major release.
8
- *
9
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
10
- */
11
- export declare const IsFhsEnabledContext: import('react').Context<boolean | Get<boolean>>;
@@ -1,17 +0,0 @@
1
- import React, { type PropsWithChildren } from 'react';
2
- /**
3
- * __Is fhs enabled provider__
4
- *
5
- * @deprecated Full height sidebar (FHS) has been rolled back. This provider is now a passthrough:
6
- * it renders its children and ignores `value`. Remove it from your app; it will be deleted in a
7
- * future major release.
8
- *
9
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
10
- */
11
- export declare const IsFhsEnabledProvider: ({ children, }: IsFhsEnabledProviderProps) => React.JSX.Element;
12
- /**
13
- * @deprecated Full height sidebar (FHS) has been rolled back. `value` is ignored.
14
- */
15
- export type IsFhsEnabledProviderProps = PropsWithChildren<{
16
- value: boolean;
17
- }>;
@@ -1 +0,0 @@
1
- export type Get<T> = () => T;
@@ -1,9 +0,0 @@
1
- /**
2
- * __Use is fhs enabled__
3
- *
4
- * @deprecated Full height sidebar (FHS) has been rolled back. This hook always returns `false`.
5
- * Remove usages of it (treat it as `false`); it will be deleted in a future major release.
6
- *
7
- * See https://hello.atlassian.net/wiki/spaces/navx/pages/7189669176/Full+Height+Sidebar+FHS+Rollback+Plan
8
- */
9
- export declare const useIsFhsEnabled: () => boolean;
@@ -1,10 +0,0 @@
1
- {
2
- "name": "@atlaskit/navigation-system/fhs-rollout",
3
- "main": "../dist/cjs/entry-points/fhs-rollout.js",
4
- "module": "../dist/esm/entry-points/fhs-rollout.js",
5
- "module:es2019": "../dist/es2019/entry-points/fhs-rollout.js",
6
- "sideEffects": [
7
- "*.compiled.css"
8
- ],
9
- "types": "../dist/types/entry-points/fhs-rollout.d.ts"
10
- }