@atlaskit/menu 5.0.1 → 6.0.0

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/menu
 
+## 6.0.0
+
+### Major Changes
+
+- [#148607](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/pull-requests/148607)
+  [`474e66c7b2f54`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/474e66c7b2f54) -
+  Removed deprecated `overrides` prop from Section. Introduced `isSideNavSection` prop on Section
+  which when true renders headings with reduced padding. This prop was added exclusively to support
+  existing functionality in `@atlaskit/side-navigation` and will be removed once the new navigation
+  system fully rolls out. It should not be used outside of the Side Navigation component. Removed
+  deprecated `Overrides` and `TitleOverrides` types.
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 5.0.1
 
 ### Patch Changes

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

@@ -9,10 +9,9 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _react = require("react");
 var _react2 = require("@emotion/react");
-var _deprecationWarning = require("@atlaskit/ds-lib/deprecation-warning");
 var _colors = require("@atlaskit/theme/colors");
 var _headingItem = _interopRequireDefault(require("../menu-item/heading-item"));
-var _excluded = ["children", "overrides", "title", "titleId", "testId", "isScrollable", "hasSeparator", "id", "isList", "className"];
+var _excluded = ["children", "title", "titleId", "testId", "isScrollable", "hasSeparator", "id", "isList", "isSideNavSection", "className"];
 /**
  * @jsxRuntime classic
  * @jsx jsx
@@ -88,6 +87,11 @@ var noSeparatorStyles = (0, _react2.css)({
     marginBlockStart: -6
   }
 });
+var sideNavSectionHeadingStyles = function sideNavSectionHeadingStyles() {
+  return {
+    paddingInline: "var(--ds-space-100, 8px)"
+  };
+};
 
 /**
  * __Section__
@@ -99,7 +103,6 @@ var noSeparatorStyles = (0, _react2.css)({
  */
 var Section = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var children = _ref.children,
-    overrides = _ref.overrides,
     title = _ref.title,
     titleId = _ref.titleId,
     testId = _ref.testId,
@@ -108,11 +111,10 @@ var Section = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
     id = _ref.id,
     _ref$isList = _ref.isList,
     isList = _ref$isList === void 0 ? false : _ref$isList,
+    _ref$isSideNavSection = _ref.isSideNavSection,
+    isSideNavSection = _ref$isSideNavSection === void 0 ? false : _ref$isSideNavSection,
     UNSAFE_className = _ref.className,
     rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
-  (0, _deprecationWarning.propDeprecationWarning)("@atlaskit/menu" || '', 'overrides', overrides !== undefined, '' // TODO: Create DAC post when primitives/xcss are available as alternatives
-  );
-  var UNSAFE_headingOverrides = overrides && overrides.HeadingItem && overrides.HeadingItem.cssFn;
   var content = isList ? (0, _react2.jsx)("ul", {
     style: {
       // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
@@ -134,7 +136,7 @@ var Section = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
   var childrenMarkup = title !== undefined ? (0, _react2.jsx)(_react.Fragment, null, (0, _react2.jsx)(_headingItem.default
   // eslint-disable-next-line @repo/internal/react/no-unsafe-overrides
   , {
-    cssFn: UNSAFE_headingOverrides,
+    cssFn: isSideNavSection ? sideNavSectionHeadingStyles : undefined,
     testId: testId && "".concat(testId, "--heading"),
     "aria-hidden": true
   }, title), content) : (0, _react2.jsx)(_react.Fragment, null, content);

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

@@ -7,7 +7,6 @@ import { Children, forwardRef, Fragment } from 'react';
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
-import { propDeprecationWarning } from '@atlaskit/ds-lib/deprecation-warning';
 import { N30A } from '@atlaskit/theme/colors';
 import HeadingItem from '../menu-item/heading-item';
 const gridSize = 8;
@@ -80,6 +79,11 @@ const noSeparatorStyles = css({
     marginBlockStart: -6
   }
 });
+const sideNavSectionHeadingStyles = () => {
+  return {
+    paddingInline: "var(--ds-space-100, 8px)"
+  };
+};
 
 /**
  * __Section__
@@ -91,7 +95,6 @@ const noSeparatorStyles = css({
  */
 const Section = /*#__PURE__*/forwardRef(({
   children,
-  overrides,
   title,
   titleId,
   testId,
@@ -99,6 +102,7 @@ const Section = /*#__PURE__*/forwardRef(({
   hasSeparator,
   id,
   isList = false,
+  isSideNavSection = false,
   // Although this isn't defined on props it is available because we've used
   // Spread props below and on the jsx element. To forcibly block usage I've
   // picked it out and supressed the expected type error.
@@ -106,9 +110,6 @@ const Section = /*#__PURE__*/forwardRef(({
   className: UNSAFE_className,
   ...rest
 }, ref) => {
-  propDeprecationWarning("@atlaskit/menu" || '', 'overrides', overrides !== undefined, '' // TODO: Create DAC post when primitives/xcss are available as alternatives
-  );
-  const UNSAFE_headingOverrides = overrides && overrides.HeadingItem && overrides.HeadingItem.cssFn;
   const content = isList ? jsx("ul", {
     style: {
       // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
@@ -128,7 +129,7 @@ const Section = /*#__PURE__*/forwardRef(({
   const childrenMarkup = title !== undefined ? jsx(Fragment, null, jsx(HeadingItem
   // eslint-disable-next-line @repo/internal/react/no-unsafe-overrides
   , {
-    cssFn: UNSAFE_headingOverrides,
+    cssFn: isSideNavSection ? sideNavSectionHeadingStyles : undefined,
     testId: testId && `${testId}--heading`,
     "aria-hidden": true
   }, title), content) : jsx(Fragment, null, content);

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

@@ -1,6 +1,6 @@
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["children", "overrides", "title", "titleId", "testId", "isScrollable", "hasSeparator", "id", "isList", "className"];
+var _excluded = ["children", "title", "titleId", "testId", "isScrollable", "hasSeparator", "id", "isList", "isSideNavSection", "className"];
 /**
  * @jsxRuntime classic
  * @jsx jsx
@@ -9,7 +9,6 @@ import { Children, forwardRef, Fragment } from 'react';
 
 // eslint-disable-next-line @atlaskit/ui-styling-standard/use-compiled -- Ignored via go/DSP-18766
 import { css, jsx } from '@emotion/react';
-import { propDeprecationWarning } from '@atlaskit/ds-lib/deprecation-warning';
 import { N30A } from '@atlaskit/theme/colors';
 import HeadingItem from '../menu-item/heading-item';
 var gridSize = 8;
@@ -82,6 +81,11 @@ var noSeparatorStyles = css({
     marginBlockStart: -6
   }
 });
+var sideNavSectionHeadingStyles = function sideNavSectionHeadingStyles() {
+  return {
+    paddingInline: "var(--ds-space-100, 8px)"
+  };
+};
 
 /**
  * __Section__
@@ -93,7 +97,6 @@ var noSeparatorStyles = css({
  */
 var Section = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var children = _ref.children,
-    overrides = _ref.overrides,
     title = _ref.title,
     titleId = _ref.titleId,
     testId = _ref.testId,
@@ -102,11 +105,10 @@ var Section = /*#__PURE__*/forwardRef(function (_ref, ref) {
     id = _ref.id,
     _ref$isList = _ref.isList,
     isList = _ref$isList === void 0 ? false : _ref$isList,
+    _ref$isSideNavSection = _ref.isSideNavSection,
+    isSideNavSection = _ref$isSideNavSection === void 0 ? false : _ref$isSideNavSection,
     UNSAFE_className = _ref.className,
     rest = _objectWithoutProperties(_ref, _excluded);
-  propDeprecationWarning("@atlaskit/menu" || '', 'overrides', overrides !== undefined, '' // TODO: Create DAC post when primitives/xcss are available as alternatives
-  );
-  var UNSAFE_headingOverrides = overrides && overrides.HeadingItem && overrides.HeadingItem.cssFn;
   var content = isList ? jsx("ul", {
     style: {
       // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Ignored via go/DSP-18766
@@ -128,7 +130,7 @@ var Section = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var childrenMarkup = title !== undefined ? jsx(Fragment, null, jsx(HeadingItem
   // eslint-disable-next-line @repo/internal/react/no-unsafe-overrides
   , {
-    cssFn: UNSAFE_headingOverrides,
+    cssFn: isSideNavSection ? sideNavSectionHeadingStyles : undefined,
     testId: testId && "".concat(testId, "--heading"),
     "aria-hidden": true
   }, title), content) : jsx(Fragment, null, content);

package/dist/types/index.d.ts

@@ -8,4 +8,4 @@ export { default as SkeletonHeadingItem } from './menu-item/skeleton-heading-ite
 export { default as Section } from './menu-section/section';
 export { default as MenuGroup } from './menu-section/menu-group';
 export { default as PopupMenuGroup } from './menu-section/popup-menu-group';
-export type { ButtonItemProps, CSSFn, StatelessCSSFn, CustomItemComponentProps, CustomItemProps, HeadingItemProps, ItemState, LinkItemProps, MenuGroupProps, SectionProps, SkeletonHeadingItemProps, SkeletonItemProps, Dimension, MenuItemProps as BaseItemProps, Overrides, MenuGroupSizing, RenderFunction, SectionProps as SectionBaseProps, TitleOverrides, } from './types';
+export type { ButtonItemProps, CSSFn, StatelessCSSFn, CustomItemComponentProps, CustomItemProps, HeadingItemProps, ItemState, LinkItemProps, MenuGroupProps, SectionProps, SkeletonHeadingItemProps, SkeletonItemProps, Dimension, MenuItemProps as BaseItemProps, MenuGroupSizing, RenderFunction, SectionProps as SectionBaseProps, } from './types';

package/dist/types/types.d.ts

@@ -1,25 +1,9 @@
-import { type ComponentType, type PropsWithChildren, type ReactNode, type Ref } from 'react';
+import { type ComponentType, type PropsWithChildren, type Ref } from 'react';
 import { type CSSObject } from '@emotion/react';
 import type { SpacingMode } from './internal/components/menu-context';
 export interface RenderFunction<TProps = {}> {
     (Component: ComponentType | string, props: TProps): React.ReactNode;
 }
-/**
- * @deprecated This type is deprecated and will be removed in a future release. See DSP-2676 for more information.
- */
-export interface TitleOverrides {
-    render?: RenderFunction<{
-        className?: string;
-        children: ReactNode;
-        'data-item-title': boolean;
-    }>;
-}
-/**
- * @deprecated This type is deprecated and will be removed in a future release. See DSP-2676 for more information.
- */
-export interface Overrides {
-    Title?: TitleOverrides;
-}
 export type Dimension = string | number;
 export interface MenuGroupSizing {
     /**
@@ -97,18 +81,6 @@ export interface SectionProps {
      * serving as a hook for automated tests.
      */
     testId?: string;
-    /**
-     * @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
-     */
-    overrides?: {
-        HeadingItem?: {
-            /**
-             * A function that overrides the styles of the component.
-             * It receives the current styles and state and expects a styles object.
-             */
-            cssFn?: StatelessCSSFn;
-        };
-    };
     /**
      * The text passed into the internal `HeadingItem`. If a title isn't provided,
      * the `HeadingItem` won't be rendered, and this component will act as a regular `Section`.
@@ -123,6 +95,11 @@ export interface SectionProps {
      * If your menu contains a list, use this to add `<ul>` and `<li>` tags around the items. This is essential for offering better, accessible semantic markup in a list of items.
      */
     isList?: boolean;
+    /**
+     * When `true`, section header inline padding is reduced.
+     * @deprecated This API exists to support functionality in `@atlaskit/side-navigation` and should not be used. Once the new navigation is fully rolled out, this prop will be removed.
+     */
+    isSideNavSection?: boolean;
 }
 export interface MenuItemPrimitiveProps {
     children: (props: {

package/dist/types-ts4.5/index.d.ts

@@ -8,4 +8,4 @@ export { default as SkeletonHeadingItem } from './menu-item/skeleton-heading-ite
 export { default as Section } from './menu-section/section';
 export { default as MenuGroup } from './menu-section/menu-group';
 export { default as PopupMenuGroup } from './menu-section/popup-menu-group';
-export type { ButtonItemProps, CSSFn, StatelessCSSFn, CustomItemComponentProps, CustomItemProps, HeadingItemProps, ItemState, LinkItemProps, MenuGroupProps, SectionProps, SkeletonHeadingItemProps, SkeletonItemProps, Dimension, MenuItemProps as BaseItemProps, Overrides, MenuGroupSizing, RenderFunction, SectionProps as SectionBaseProps, TitleOverrides, } from './types';
+export type { ButtonItemProps, CSSFn, StatelessCSSFn, CustomItemComponentProps, CustomItemProps, HeadingItemProps, ItemState, LinkItemProps, MenuGroupProps, SectionProps, SkeletonHeadingItemProps, SkeletonItemProps, Dimension, MenuItemProps as BaseItemProps, MenuGroupSizing, RenderFunction, SectionProps as SectionBaseProps, } from './types';

package/dist/types-ts4.5/types.d.ts

@@ -1,25 +1,9 @@
-import { type ComponentType, type PropsWithChildren, type ReactNode, type Ref } from 'react';
+import { type ComponentType, type PropsWithChildren, type Ref } from 'react';
 import { type CSSObject } from '@emotion/react';
 import type { SpacingMode } from './internal/components/menu-context';
 export interface RenderFunction<TProps = {}> {
     (Component: ComponentType | string, props: TProps): React.ReactNode;
 }
-/**
- * @deprecated This type is deprecated and will be removed in a future release. See DSP-2676 for more information.
- */
-export interface TitleOverrides {
-    render?: RenderFunction<{
-        className?: string;
-        children: ReactNode;
-        'data-item-title': boolean;
-    }>;
-}
-/**
- * @deprecated This type is deprecated and will be removed in a future release. See DSP-2676 for more information.
- */
-export interface Overrides {
-    Title?: TitleOverrides;
-}
 export type Dimension = string | number;
 export interface MenuGroupSizing {
     /**
@@ -97,18 +81,6 @@ export interface SectionProps {
      * serving as a hook for automated tests.
      */
     testId?: string;
-    /**
-     * @deprecated This API is deprecated and will be removed in a future release. See DSP-2676 for more information.
-     */
-    overrides?: {
-        HeadingItem?: {
-            /**
-             * A function that overrides the styles of the component.
-             * It receives the current styles and state and expects a styles object.
-             */
-            cssFn?: StatelessCSSFn;
-        };
-    };
     /**
      * The text passed into the internal `HeadingItem`. If a title isn't provided,
      * the `HeadingItem` won't be rendered, and this component will act as a regular `Section`.
@@ -123,6 +95,11 @@ export interface SectionProps {
      * If your menu contains a list, use this to add `<ul>` and `<li>` tags around the items. This is essential for offering better, accessible semantic markup in a list of items.
      */
     isList?: boolean;
+    /**
+     * When `true`, section header inline padding is reduced.
+     * @deprecated This API exists to support functionality in `@atlaskit/side-navigation` and should not be used. Once the new navigation is fully rolled out, this prop will be removed.
+     */
+    isSideNavSection?: boolean;
 }
 export interface MenuItemPrimitiveProps {
     children: (props: {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/menu",
-	"version": "5.0.1",
+	"version": "6.0.0",
 	"description": "A list of options to help users navigate, or perform actions.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -63,7 +63,7 @@
 		"@af/visual-regression": "workspace:^",
 		"@atlaskit/button": "^23.0.0",
 		"@atlaskit/docs": "^10.0.0",
-		"@atlaskit/icon": "^25.6.0",
+		"@atlaskit/icon": "^26.0.0",
 		"@atlaskit/icon-file-type": "^7.0.0",
 		"@atlaskit/icon-object": "^7.1.0",
 		"@atlaskit/link": "^3.1.0",