@carbon/react 1.28.0-rc.0 → 1.29.0-rc.0

package/lib/components/Heading/index.js

@@ -18,21 +18,19 @@ var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
 const HeadingContext = /*#__PURE__*/React__default["default"].createContext(1);
-
 function Section(_ref) {
   let {
     as: BaseComponent = 'section',
     level: levelOverride,
-    children,
     ...rest
   } = _ref;
   const parentLevel = React__default["default"].useContext(HeadingContext);
-  const level = typeof levelOverride !== 'undefined' ? levelOverride : parentLevel + 1;
+  const level = levelOverride ?? parentLevel + 1;
+  const BaseComponentAsAny = BaseComponent;
   return /*#__PURE__*/React__default["default"].createElement(HeadingContext.Provider, {
     value: Math.min(level, 6)
-  }, /*#__PURE__*/React__default["default"].createElement(BaseComponent, rest, children));
+  }, /*#__PURE__*/React__default["default"].createElement(BaseComponentAsAny, rest));
 }
-
 Section.propTypes = {
   /**
    * Provide an alternative tag or component to use instead of the default
@@ -55,12 +53,10 @@ Section.propTypes = {
    */
   level: PropTypes__default["default"].number
 };
-
 function Heading(props) {
-  const level = React__default["default"].useContext(HeadingContext);
-  return /*#__PURE__*/React__default["default"].createElement(`h${level}`, props);
+  const HeadingIntrinsic = `h${React__default["default"].useContext(HeadingContext)}`;
+  return /*#__PURE__*/React__default["default"].createElement(HeadingIntrinsic, props);
 }
-
 Heading.propTypes = {
   /**
    * Specify the content that will be placed in the component

package/lib/components/OverflowMenu/OverflowMenu.js

@@ -385,6 +385,7 @@ class OverflowMenu extends React.Component {
       onClick: this.handleClick,
       id: id,
       ref: mergeRefs["default"](this._triggerRef, ref),
+      size: size,
       label: iconDescription
     }), /*#__PURE__*/React__default["default"].createElement(IconElement, iconProps)), open && this.state.hasMountedTrigger && wrappedMenuBody));
   }

package/lib/components/StructuredList/StructuredList.Skeleton.js

@@ -26,15 +26,13 @@ var _span, _span2, _span3;
 const StructuredListSkeleton = _ref => {
   let {
     rowCount,
-    border,
     className,
     ...rest
   } = _ref;
   const prefix = usePrefix.usePrefix();
   const StructuredListSkeletonClasses = cx__default["default"](className, {
     [`${prefix}--skeleton`]: true,
-    [`${prefix}--structured-list`]: true,
-    [`${prefix}--structured-list--border`]: border
+    [`${prefix}--structured-list`]: true
   });
   const rows = [];
 
@@ -69,11 +67,6 @@ const StructuredListSkeleton = _ref => {
 };
 
 StructuredListSkeleton.propTypes = {
-  /**
-   * Specify whether a border should be added to your StructuredListSkeleton
-   */
-  border: PropTypes__default["default"].bool,
-
   /**
    * Specify an optional className to add.
    */
@@ -85,8 +78,7 @@ StructuredListSkeleton.propTypes = {
   rowCount: PropTypes__default["default"].number
 };
 StructuredListSkeleton.defaultProps = {
-  rowCount: 5,
-  border: false
+  rowCount: 5
 };
 var StructuredListSkeleton$1 = StructuredListSkeleton;
 

package/lib/components/StructuredList/StructuredList.js

@@ -40,7 +40,7 @@ function StructuredListWrapper(props) {
   const classes = cx__default["default"](`${prefix}--structured-list`, className, {
     [`${prefix}--structured-list--selection`]: selection,
     [`${prefix}--structured-list--condensed`]: isCondensed,
-    [`${prefix}--structured-list--flush`]: isFlush
+    [`${prefix}--structured-list--flush`]: isFlush && !selection
   });
   const [selectedRow, setSelectedRow] = React__default["default"].useState(null);
   return /*#__PURE__*/React__default["default"].createElement(GridSelectedRowStateContext.Provider, {
@@ -82,7 +82,7 @@ StructuredListWrapper.propTypes = {
   isCondensed: PropTypes__default["default"].bool,
 
   /**
-   * Specify if structured list is flush, default is false
+   * Specify if structured list is flush, not valid for selection variant, default is false
    */
   isFlush: PropTypes__default["default"].bool,
 

package/lib/components/Theme/index.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import PropTypes from 'prop-types';
+import React, { ElementType, type PropsWithChildren } from 'react';
+import { PolymorphicProps } from '../../types/common';
+interface GlobalThemeProps {
+    theme?: 'white' | 'g10' | 'g90' | 'g100';
+}
+export declare const ThemeContext: React.Context<GlobalThemeProps>;
+export declare function GlobalTheme({ children, theme, }: PropsWithChildren<GlobalThemeProps>): JSX.Element;
+export declare namespace GlobalTheme {
+    var propTypes: {
+        /**
+         * Provide child elements to be rendered inside of `GlobalTheme`, this is
+         * typically the root of your app
+         */
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Specify the global theme for your app
+         */
+        theme: PropTypes.Requireable<string>;
+    };
+}
+type ThemeBaseProps = GlobalThemeProps & {
+    className?: string;
+};
+type ThemeProps<E extends ElementType> = PolymorphicProps<E, ThemeBaseProps>;
+/**
+ * Specify the theme to be applied to a page, or a region in a page
+ */
+export declare function Theme<E extends ElementType = 'div'>({ as: BaseComponent, className: customClassName, theme, ...rest }: ThemeProps<E>): JSX.Element;
+export declare namespace Theme {
+    var propTypes: {
+        /**
+         * Specify a custom component or element to be rendered as the top-level
+         * element in the component
+         */
+        as: PropTypes.Requireable<NonNullable<((...args: any[]) => any) | PropTypes.ReactComponentLike | null | undefined>>;
+        /**
+         * Provide child elements to be rendered inside of `Theme`
+         */
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Provide a custom class name to be used on the outermost element rendered by
+         * the component
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * Specify the theme
+         */
+        theme: PropTypes.Requireable<string>;
+    };
+}
+/**
+ * Get access to the current theme
+ */
+export declare function useTheme(): GlobalThemeProps;
+export {};

package/lib/components/Theme/index.js

@@ -51,14 +51,13 @@ GlobalTheme.propTypes = {
    */
   theme: PropTypes__default["default"].oneOf(['white', 'g10', 'g90', 'g100'])
 };
+
 /**
  * Specify the theme to be applied to a page, or a region in a page
  */
-
 function Theme(_ref2) {
   let {
     as: BaseComponent = 'div',
-    children,
     className: customClassName,
     theme,
     ...rest
@@ -76,13 +75,14 @@ function Theme(_ref2) {
       theme
     };
   }, [theme]);
+  const BaseComponentAsAny = BaseComponent;
   return /*#__PURE__*/React__default["default"].createElement(ThemeContext.Provider, {
     value: value
   }, /*#__PURE__*/React__default["default"].createElement(LayerContext.LayerContext.Provider, {
     value: 1
-  }, /*#__PURE__*/React__default["default"].createElement(BaseComponent, _rollupPluginBabelHelpers["extends"]({}, rest, {
+  }, /*#__PURE__*/React__default["default"].createElement(BaseComponentAsAny, _rollupPluginBabelHelpers["extends"]({}, rest, {
     className: className
-  }), children)));
+  }))));
 }
 Theme.propTypes = {
   /**

package/lib/components/UIShell/HeaderContainer.js

@@ -11,6 +11,9 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var PropTypes = require('prop-types');
 var React = require('react');
+var useEvent = require('../../internal/useEvent.js');
+var match = require('../../internal/keyboard/match.js');
+var keys = require('../../internal/keyboard/keys.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -24,6 +27,11 @@ const HeaderContainer = _ref => {
   } = _ref;
   //state for expandable sidenav
   const [isSideNavExpandedState, setIsSideNavExpandedState] = React.useState(isSideNavExpanded);
+  useEvent.useEvent(window, 'keydown', event => {
+    if (match.match(event, keys.Escape)) {
+      setIsSideNavExpandedState(false);
+    }
+  });
   const handleHeaderMenuButtonClick = React.useCallback(() => {
     setIsSideNavExpandedState(prevIsSideNavExpanded => !prevIsSideNavExpanded);
   }, [setIsSideNavExpandedState]);

package/lib/components/UIShell/HeaderMenuButton.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { type ComponentProps } from 'react';
+import PropTypes from 'prop-types';
+type HeaderMenuButtonBaseProps = Omit<ComponentProps<'button'>, 'title' | 'type'>;
+interface HeaderMenuButtonProps extends HeaderMenuButtonBaseProps {
+    'aria-label'?: string;
+    'aria-labelledby'?: string;
+    className?: string;
+    renderMenuIcon?: JSX.Element;
+    renderCloseIcon?: JSX.Element;
+    isActive?: boolean;
+    isCollapsible?: boolean;
+}
+declare function HeaderMenuButton({ 'aria-label': ariaLabel, 'aria-labelledby': ariaLabelledBy, className: customClassName, renderMenuIcon, renderCloseIcon, isActive, isCollapsible, ...rest }: HeaderMenuButtonProps): JSX.Element;
+declare namespace HeaderMenuButton {
+    var propTypes: {
+        /**
+         * Optionally provide a custom class name that is applied to the underlying
+         * button
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * Specify whether the menu button is "active".
+         */
+        isActive: PropTypes.Requireable<boolean>;
+        /**
+         * Optionally provide an onClick handler that is called when the underlying
+         * button fires it's onclick event
+         */
+        onClick: PropTypes.Requireable<(...args: any[]) => any>;
+    };
+}
+export default HeaderMenuButton;

package/lib/components/UIShell/HeaderMenuButton.js

@@ -24,7 +24,6 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 
 var _Menu, _Close;
-
 function HeaderMenuButton(_ref) {
   let {
     'aria-label': ariaLabel,
@@ -32,38 +31,34 @@ function HeaderMenuButton(_ref) {
     className: customClassName,
     renderMenuIcon,
     renderCloseIcon,
-    onClick,
     isActive,
     isCollapsible,
     ...rest
   } = _ref;
   const prefix = usePrefix.usePrefix();
-  const className = cx__default["default"]({
-    [customClassName]: !!customClassName,
+  const className = cx__default["default"]({ ...(typeof customClassName === 'string' && {
+      [customClassName]: !!customClassName
+    }),
     [`${prefix}--header__action`]: true,
     [`${prefix}--header__menu-trigger`]: true,
     [`${prefix}--header__action--active`]: isActive,
     [`${prefix}--header__menu-toggle`]: true,
     [`${prefix}--header__menu-toggle__hidden`]: !isCollapsible
   });
-  const accessibilityLabel = {
-    'aria-label': ariaLabel,
-    'aria-labelledby': ariaLabelledBy
-  };
   const menuIcon = renderMenuIcon ? renderMenuIcon : _Menu || (_Menu = /*#__PURE__*/React__default["default"].createElement(iconsReact.Menu, {
     size: 20
   }));
   const closeIcon = renderCloseIcon ? renderCloseIcon : _Close || (_Close = /*#__PURE__*/React__default["default"].createElement(iconsReact.Close, {
     size: 20
   }));
-  return /*#__PURE__*/React__default["default"].createElement("button", _rollupPluginBabelHelpers["extends"]({}, rest, accessibilityLabel, {
+  return /*#__PURE__*/React__default["default"].createElement("button", _rollupPluginBabelHelpers["extends"]({}, rest, {
+    "aria-label": ariaLabel,
+    "aria-labelledby": ariaLabelledBy,
     className: className,
     title: ariaLabel,
-    type: "button",
-    onClick: onClick
+    type: "button"
   }), isActive ? closeIcon : menuIcon);
 }
-
 HeaderMenuButton.propTypes = {
   /**
    * Required props for accessibility label on the underlying menu button

package/lib/components/UIShell/HeaderNavigation.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { type ComponentProps } from 'react';
+import PropTypes from 'prop-types';
+type HeaderNavigationProps = ComponentProps<'nav'>;
+declare function HeaderNavigation({ 'aria-label': ariaLabel, 'aria-labelledby': ariaLabelledBy, children, className: customClassName, ...rest }: HeaderNavigationProps): JSX.Element;
+declare namespace HeaderNavigation {
+    var propTypes: {
+        /**
+         * Provide valid children of HeaderNavigation, for example `HeaderMenuItem`
+         * or `HeaderMenu`
+         */
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Optionally provide a custom class to apply to the underlying <nav> node
+         */
+        className: PropTypes.Requireable<string>;
+    };
+}
+export default HeaderNavigation;

package/lib/components/UIShell/HeaderNavigation.js

@@ -22,29 +22,24 @@ var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 
-function HeaderNavigation(props) {
-  const {
+function HeaderNavigation(_ref) {
+  let {
     'aria-label': ariaLabel,
     'aria-labelledby': ariaLabelledBy,
     children,
     className: customClassName,
     ...rest
-  } = props;
+  } = _ref;
   const prefix = usePrefix.usePrefix();
-  const className = cx__default["default"](`${prefix}--header__nav`, customClassName); // Assign both label strategies in this option, only one should be defined
-  // so when we spread that should be the one that is applied to the node
-
-  const accessibilityLabel = {
-    'aria-label': ariaLabel,
-    'aria-labelledby': ariaLabelledBy
-  };
-  return /*#__PURE__*/React__default["default"].createElement("nav", _rollupPluginBabelHelpers["extends"]({}, rest, accessibilityLabel, {
+  const className = cx__default["default"](`${prefix}--header__nav`, customClassName);
+  return /*#__PURE__*/React__default["default"].createElement("nav", _rollupPluginBabelHelpers["extends"]({}, rest, {
+    "aria-label": ariaLabel,
+    "aria-labelledby": ariaLabelledBy,
     className: className
   }), /*#__PURE__*/React__default["default"].createElement("ul", {
     className: `${prefix}--header__menu-bar`
   }, children));
 }
-
 HeaderNavigation.propTypes = {
   /**
    * Required props for accessibility label on the underlying menu
@@ -63,5 +58,4 @@ HeaderNavigation.propTypes = {
   className: PropTypes__default["default"].string
 };
 
-exports.HeaderNavigation = HeaderNavigation;
 exports["default"] = HeaderNavigation;

package/lib/components/UIShell/HeaderSideNavItems.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { type ReactNode } from 'react';
+import PropTypes from 'prop-types';
+interface HeaderSideNavItemsProps {
+    className?: string | undefined;
+    children?: ReactNode;
+    hasDivider?: boolean | undefined;
+}
+declare function HeaderSideNavItems({ className: customClassName, children, hasDivider, }: HeaderSideNavItemsProps): JSX.Element;
+declare namespace HeaderSideNavItems {
+    var propTypes: {
+        /**
+         * The child nodes to be rendered
+         */
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        /**
+         * Optionally provide a custom class name that is applied to the underlying
+         * button
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * Optionally specify if container will have a bottom divider to differentiate
+         * between original sidenav items and header menu items. False by default.
+         */
+        hasDivider: PropTypes.Requireable<boolean>;
+    };
+}
+export default HeaderSideNavItems;

package/lib/components/UIShell/HeaderSideNavItems.js

@@ -20,11 +20,11 @@ var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 
-const HeaderSideNavItems = _ref => {
+function HeaderSideNavItems(_ref) {
   let {
     className: customClassName,
     children,
-    hasDivider
+    hasDivider = false
   } = _ref;
   const prefix = usePrefix.usePrefix();
   const className = cx__default["default"]({
@@ -34,8 +34,7 @@ const HeaderSideNavItems = _ref => {
   return /*#__PURE__*/React__default["default"].createElement("ul", {
     className: className
   }, children);
-};
-
+}
 HeaderSideNavItems.propTypes = {
   /**
    * The child nodes to be rendered
@@ -54,9 +53,5 @@ HeaderSideNavItems.propTypes = {
    */
   hasDivider: PropTypes__default["default"].bool
 };
-HeaderSideNavItems.defaultProps = {
-  hasDivider: false
-};
-var HeaderSideNavItems$1 = HeaderSideNavItems;
 
-exports["default"] = HeaderSideNavItems$1;
+exports["default"] = HeaderSideNavItems;

package/lib/components/UIShell/SideNav.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright IBM Corp. 2016, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import React, { type ComponentProps, type FocusEvent, type KeyboardEvent, type MouseEventHandler } from 'react';
+interface SideNavProps extends ComponentProps<'nav'> {
+    expanded?: boolean | undefined;
+    defaultExpanded?: boolean | undefined;
+    isChildOfHeader?: boolean | undefined;
+    onToggle?: (event: FocusEvent<HTMLElement> | KeyboardEvent<HTMLElement> | boolean, value: boolean) => void | undefined;
+    isFixedNav?: boolean | undefined;
+    isRail?: boolean | undefined;
+    isPersistent?: boolean | undefined;
+    addFocusListeners?: boolean | undefined;
+    addMouseListeners?: boolean | undefined;
+    onOverlayClick?: MouseEventHandler<HTMLDivElement> | undefined;
+}
+declare const SideNav: React.ForwardRefExoticComponent<Pick<SideNavProps, "children" | "className" | "slot" | "style" | "title" | "dir" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "onToggle" | "key" | "id" | "onAnimationEnd" | "aria-controls" | "aria-expanded" | "onClick" | "onKeyDown" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "lang" | "placeholder" | "spellCheck" | "tabIndex" | "translate" | "radioGroup" | "role" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "color" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colspan" | "aria-current" | "aria-describedby" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onReset" | "onResetCapture" | "onSubmit" | "onSubmitCapture" | "onInvalid" | "onInvalidCapture" | "onLoad" | "onLoadCapture" | "onError" | "onErrorCapture" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onAbort" | "onAbortCapture" | "onCanPlay" | "onCanPlayCapture" | "onCanPlayThrough" | "onCanPlayThroughCapture" | "onDurationChange" | "onDurationChangeCapture" | "onEmptied" | "onEmptiedCapture" | "onEncrypted" | "onEncryptedCapture" | "onEnded" | "onEndedCapture" | "onLoadedData" | "onLoadedDataCapture" | "onLoadedMetadata" | "onLoadedMetadataCapture" | "onLoadStart" | "onLoadStartCapture" | "onPause" | "onPauseCapture" | "onPlay" | "onPlayCapture" | "onPlaying" | "onPlayingCapture" | "onProgress" | "onProgressCapture" | "onRateChange" | "onRateChangeCapture" | "onSeeked" | "onSeekedCapture" | "onSeeking" | "onSeekingCapture" | "onStalled" | "onStalledCapture" | "onSuspend" | "onSuspendCapture" | "onTimeUpdate" | "onTimeUpdateCapture" | "onVolumeChange" | "onVolumeChangeCapture" | "onWaiting" | "onWaitingCapture" | "onAuxClick" | "onAuxClickCapture" | "onClickCapture" | "onContextMenu" | "onContextMenuCapture" | "onDoubleClick" | "onDoubleClickCapture" | "onDrag" | "onDragCapture" | "onDragEnd" | "onDragEndCapture" | "onDragEnter" | "onDragEnterCapture" | "onDragExit" | "onDragExitCapture" | "onDragLeave" | "onDragLeaveCapture" | "onDragOver" | "onDragOverCapture" | "onDragStart" | "onDragStartCapture" | "onDrop" | "onDropCapture" | "onMouseDown" | "onMouseDownCapture" | "onMouseEnter" | "onMouseLeave" | "onMouseMove" | "onMouseMoveCapture" | "onMouseOut" | "onMouseOutCapture" | "onMouseOver" | "onMouseOverCapture" | "onMouseUp" | "onMouseUpCapture" | "onSelect" | "onSelectCapture" | "onTouchCancel" | "onTouchCancelCapture" | "onTouchEnd" | "onTouchEndCapture" | "onTouchMove" | "onTouchMoveCapture" | "onTouchStart" | "onTouchStartCapture" | "onPointerDown" | "onPointerDownCapture" | "onPointerMove" | "onPointerMoveCapture" | "onPointerUp" | "onPointerUpCapture" | "onPointerCancel" | "onPointerCancelCapture" | "onPointerEnter" | "onPointerEnterCapture" | "onPointerLeave" | "onPointerLeaveCapture" | "onPointerOver" | "onPointerOverCapture" | "onPointerOut" | "onPointerOutCapture" | "onGotPointerCapture" | "onGotPointerCaptureCapture" | "onLostPointerCapture" | "onLostPointerCaptureCapture" | "onScroll" | "onScrollCapture" | "onWheel" | "onWheelCapture" | "onAnimationStart" | "onAnimationStartCapture" | "onAnimationEndCapture" | "onAnimationIteration" | "onAnimationIterationCapture" | "onTransitionEnd" | "onTransitionEndCapture" | "expanded" | "defaultExpanded" | "isChildOfHeader" | "isFixedNav" | "isRail" | "isPersistent" | "addFocusListeners" | "addMouseListeners" | "onOverlayClick"> & React.RefAttributes<HTMLElement>>;
+export default SideNav;

package/lib/components/UIShell/SideNav.js

@@ -16,6 +16,8 @@ var PropTypes = require('prop-types');
 var AriaPropTypes = require('../../prop-types/AriaPropTypes.js');
 var _utils = require('./_utils.js');
 var usePrefix = require('../../internal/usePrefix.js');
+var match = require('../../internal/keyboard/match.js');
+var keys = require('../../internal/keyboard/keys.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -25,26 +27,26 @@ var PropTypes__default = /*#__PURE__*/_interopDefaultLegacy(PropTypes);
 
 // import SideNavFooter from './SideNavFooter';
 
-const SideNav = /*#__PURE__*/React__default["default"].forwardRef(function SideNav(props, ref) {
-  const {
+function SideNavRenderFunction(_ref, ref) {
+  let {
     expanded: expandedProp,
-    defaultExpanded,
-    isChildOfHeader,
+    defaultExpanded = false,
+    isChildOfHeader = true,
     'aria-label': ariaLabel,
     'aria-labelledby': ariaLabelledBy,
     children,
     onToggle,
     className: customClassName,
     // TO-DO: comment back in when footer is added for rails
-    // translateById: t,
-    isFixedNav,
+    // translateById: t = (id) => translations[id],
+    isFixedNav = false,
     isRail,
-    isPersistent,
-    addFocusListeners,
-    addMouseListeners,
+    isPersistent = true,
+    addFocusListeners = true,
+    addMouseListeners = true,
     onOverlayClick,
     ...other
-  } = props;
+  } = _ref;
   const prefix = usePrefix.usePrefix();
   const {
     current: controlled
@@ -77,12 +79,11 @@ const SideNav = /*#__PURE__*/React__default["default"].forwardRef(function SideN
   //   ? t('carbon.sidenav.state.open')
   //   : t('carbon.sidenav.state.closed');
 
-  const className = cx__default["default"]({
+  const className = cx__default["default"](customClassName, {
     [`${prefix}--side-nav`]: true,
     [`${prefix}--side-nav--expanded`]: expanded || expandedViaHoverState,
     [`${prefix}--side-nav--collapsed`]: !expanded && isFixedNav,
     [`${prefix}--side-nav--rail`]: isRail,
-    [customClassName]: !!customClassName,
     [`${prefix}--side-nav--ux`]: isChildOfHeader,
     [`${prefix}--side-nav--hidden`]: !isPersistent
   });
@@ -94,19 +95,25 @@ const SideNav = /*#__PURE__*/React__default["default"].forwardRef(function SideN
 
   if (isRail) {
     childrenToRender = React__default["default"].Children.map(children, child => {
-      var _child$type, _child$type2;
-
       // if we are controlled, check for if we have hovered over or the expanded state, else just use the expanded state (uncontrolled)
-      let currentExpansionState = controlled ? expandedViaHoverState || expanded : expanded; // avoid spreading `isSideNavExpanded` to non-Carbon UI Shell children
+      const currentExpansionState = controlled ? expandedViaHoverState || expanded : expanded;
+
+      if ( /*#__PURE__*/React.isValidElement(child)) {
+        var _childJsxElement$type, _childJsxElement$type2;
+
+        const childJsxElement = child; // avoid spreading `isSideNavExpanded` to non-Carbon UI Shell children
+
+        return /*#__PURE__*/React__default["default"].cloneElement(childJsxElement, { ...(_utils.CARBON_SIDENAV_ITEMS.includes(((_childJsxElement$type = childJsxElement.type) === null || _childJsxElement$type === void 0 ? void 0 : _childJsxElement$type.displayName) ?? ((_childJsxElement$type2 = childJsxElement.type) === null || _childJsxElement$type2 === void 0 ? void 0 : _childJsxElement$type2.name)) ? {
+            isSideNavExpanded: currentExpansionState
+          } : {})
+        });
+      }
 
-      return /*#__PURE__*/React__default["default"].cloneElement(child, { ...(_utils.CARBON_SIDENAV_ITEMS.includes(((_child$type = child.type) === null || _child$type === void 0 ? void 0 : _child$type.displayName) ?? ((_child$type2 = child.type) === null || _child$type2 === void 0 ? void 0 : _child$type2.name)) ? {
-          isSideNavExpanded: currentExpansionState
-        } : {})
-      });
+      return child;
     });
   }
 
-  let eventHandlers = {};
+  const eventHandlers = {};
 
   if (addFocusListeners) {
     eventHandlers.onFocus = event => {
@@ -120,6 +127,12 @@ const SideNav = /*#__PURE__*/React__default["default"].forwardRef(function SideN
         handleToggle(event, false);
       }
     };
+
+    eventHandlers.onKeyDown = event => {
+      if (match.match(event, keys.Escape)) {
+        handleToggle(event, false);
+      }
+    };
   }
 
   if (addMouseListeners && isRail) {
@@ -138,24 +151,10 @@ const SideNav = /*#__PURE__*/React__default["default"].forwardRef(function SideN
     ref: ref,
     className: `${prefix}--side-nav__navigation ${className}`
   }, accessibilityLabel, eventHandlers, other), childrenToRender));
-});
+}
+
+const SideNav = /*#__PURE__*/React__default["default"].forwardRef(SideNavRenderFunction);
 SideNav.displayName = 'SideNav';
-SideNav.defaultProps = {
-  // TO-DO: comment back in when footer is added for rails
-  // translateById: (id) => {
-  //   const translations = {
-  //     'carbon.sidenav.state.open': 'Close',
-  //     'carbon.sidenav.state.closed': 'Open',
-  //   };
-  //   return translations[id];
-  // },
-  defaultExpanded: false,
-  isChildOfHeader: true,
-  isFixedNav: false,
-  isPersistent: true,
-  addFocusListeners: true,
-  addMouseListeners: true
-};
 SideNav.propTypes = {
   /**
    * Required props for accessibility label on the underlying menu

package/lib/components/UIShell/SideNavFooter.js

@@ -55,6 +55,7 @@ function SideNavFooter(_ref) {
   }, assistiveText)));
 }
 
+SideNavFooter.displayName = 'SideNavFooter';
 SideNavFooter.propTypes = {
   /**
    * Provide text to be read to screen readers and shown as a tooltip when

package/lib/components/UIShell/SideNavHeader.js

@@ -34,6 +34,7 @@ const SideNavHeader = _ref => {
   }, /*#__PURE__*/React__default["default"].createElement(SideNavIcon["default"], null, /*#__PURE__*/React__default["default"].createElement(IconElement, null)), children);
 };
 
+SideNavHeader.displayName = 'SideNavHeader';
 SideNavHeader.propTypes = {
   /**
    * The child nodes to be rendered

package/lib/components/UIShell/SideNavItems.js

@@ -45,6 +45,7 @@ const SideNavItems = _ref => {
   }, childrenWithExpandedState);
 };
 
+SideNavItems.displayName = 'SideNavItems';
 SideNavItems.propTypes = {
   /**
    * Provide a single icon as the child to `SideNavIcon` to render in the

package/lib/components/UIShell/SideNavMenu.js

@@ -86,6 +86,7 @@ const SideNavMenu = /*#__PURE__*/React__default["default"].forwardRef(function S
     }, children))
   );
 });
+SideNavMenu.displayName = 'SideNavMenu';
 SideNavMenu.propTypes = {
   /**
    * Provide <SideNavMenuItem>'s inside of the `SideNavMenu`