@atlaskit/navigation-system 2.2.0 → 2.3.1

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @atlassian/navigation-system
 
+## 2.3.1
+
+### Patch Changes
+
+- [`34635d754e047`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/34635d754e047) -
+  Update the description of the Side nav's onExpand and onCollapse props.
+
+## 2.3.0
+
+### Minor Changes
+
+- [`40dea92e11501`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/40dea92e11501) -
+  `MenuSectionHeading` has been updated to use regular text (`p` element) instead of a heading (`h2`
+  element). This change is behind a feature flag.
+
+  This has been done to resolve accessibility issues with the component. It does not need to be a
+  heading semantically.
+
 ## 2.2.0
 
 ### Minor Changes

package/dist/cjs/ui/menu-section/menu-section-heading.js

@@ -9,6 +9,7 @@ exports.MenuSectionHeading = void 0;
 require("./menu-section-heading.compiled.css");
 var React = _interopRequireWildcard(require("react"));
 var _runtime = require("@compiled/react/runtime");
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _menuSectionContext = require("./menu-section-context");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 var styles = {
@@ -23,7 +24,10 @@ var styles = {
 var MenuSectionHeading = exports.MenuSectionHeading = function MenuSectionHeading(_ref) {
   var children = _ref.children;
   var id = (0, _menuSectionContext.useMenuSectionContext)();
-  return /*#__PURE__*/React.createElement("h2", {
+  return (0, _platformFeatureFlags.fg)('platform_dst_nav4_menu_section_heading_a11y') ? /*#__PURE__*/React.createElement("p", {
+    id: "".concat(id, "-heading"),
+    className: (0, _runtime.ax)([styles.root])
+  }, children) : /*#__PURE__*/React.createElement("h2", {
     id: "".concat(id, "-heading"),
     className: (0, _runtime.ax)([styles.root])
   }, children);

package/dist/es2019/ui/menu-section/menu-section-heading.js

@@ -2,6 +2,7 @@
 import "./menu-section-heading.compiled.css";
 import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { useMenuSectionContext } from './menu-section-context';
 const styles = {
   root: "_11c81vhk _1rjcu2gc _syaz131l _bozg12x7"
@@ -16,7 +17,10 @@ export const MenuSectionHeading = ({
   children
 }) => {
   const id = useMenuSectionContext();
-  return /*#__PURE__*/React.createElement("h2", {
+  return fg('platform_dst_nav4_menu_section_heading_a11y') ? /*#__PURE__*/React.createElement("p", {
+    id: `${id}-heading`,
+    className: ax([styles.root])
+  }, children) : /*#__PURE__*/React.createElement("h2", {
     id: `${id}-heading`,
     className: ax([styles.root])
   }, children);

package/dist/esm/ui/menu-section/menu-section-heading.js

@@ -2,6 +2,7 @@
 import "./menu-section-heading.compiled.css";
 import * as React from 'react';
 import { ax, ix } from "@compiled/react/runtime";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { useMenuSectionContext } from './menu-section-context';
 var styles = {
   root: "_11c81vhk _1rjcu2gc _syaz131l _bozg12x7"
@@ -15,7 +16,10 @@ var styles = {
 export var MenuSectionHeading = function MenuSectionHeading(_ref) {
   var children = _ref.children;
   var id = useMenuSectionContext();
-  return /*#__PURE__*/React.createElement("h2", {
+  return fg('platform_dst_nav4_menu_section_heading_a11y') ? /*#__PURE__*/React.createElement("p", {
+    id: "".concat(id, "-heading"),
+    className: ax([styles.root])
+  }, children) : /*#__PURE__*/React.createElement("h2", {
     id: "".concat(id, "-heading"),
     className: ax([styles.root])
   }, children);

package/dist/types/ui/page-layout/side-nav/side-nav.d.ts

@@ -36,10 +36,14 @@ type SideNavProps = CommonSlotProps & {
     defaultWidth?: number;
     /**
      * Called when the side nav is expanded.
+     *
+     * Note: The trigger parameter is only provided when the `navx-full-height-sidebar` feature flag is enabled.
      */
     onExpand?: VisibilityCallback;
     /**
      * Called when the side nav is collapsed.
+     *
+     * Note: The trigger parameter is only provided when the `navx-full-height-sidebar` feature flag is enabled.
      */
     onCollapse?: VisibilityCallback;
 };

package/dist/types-ts4.5/ui/page-layout/side-nav/side-nav.d.ts

@@ -36,10 +36,14 @@ type SideNavProps = CommonSlotProps & {
     defaultWidth?: number;
     /**
      * Called when the side nav is expanded.
+     *
+     * Note: The trigger parameter is only provided when the `navx-full-height-sidebar` feature flag is enabled.
      */
     onExpand?: VisibilityCallback;
     /**
      * Called when the side nav is collapsed.
+     *
+     * Note: The trigger parameter is only provided when the `navx-full-height-sidebar` feature flag is enabled.
      */
     onCollapse?: VisibilityCallback;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/navigation-system",
-	"version": "2.2.0",
+	"version": "2.3.1",
 	"description": "The latest navigation system for Atlassian apps.",
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
 	"author": "Atlassian Pty Ltd",
@@ -106,7 +106,7 @@
 		"@atlaskit/link": "^3.2.0",
 		"@atlaskit/lozenge": "^13.0.0",
 		"@atlaskit/menu": "^8.3.0",
-		"@atlaskit/onboarding": "^14.3.0",
+		"@atlaskit/onboarding": "^14.4.0",
 		"@atlaskit/page-header": "^12.1.0",
 		"@atlaskit/page-layout": "^4.2.0",
 		"@atlaskit/pragmatic-drag-and-drop-auto-scroll": "^2.1.0",
@@ -187,6 +187,9 @@
 		},
 		"navx-full-height-sidebar": {
 			"type": "boolean"
+		},
+		"platform_dst_nav4_menu_section_heading_a11y": {
+			"type": "boolean"
 		}
 	},
 	"homepage": "https://atlassian.design/components/navigation-system"