@carbon/react 1.41.1 → 1.42.0-rc.0

package/es/components/Breadcrumb/Breadcrumb.Skeleton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 from 'react';
+export interface BreadcrumbSkeletonProps extends React.HTMLAttributes<HTMLDivElement> {
+    /**
+     * Specify an optional className to add.
+     */
+    className?: string;
+}
+declare function BreadcrumbSkeleton({ className, ...rest }: BreadcrumbSkeletonProps): JSX.Element;
+declare namespace BreadcrumbSkeleton {
+    var propTypes: {
+        /**
+         * Specify an optional className to add.
+         */
+        className: PropTypes.Requireable<string>;
+    };
+}
+export default BreadcrumbSkeleton;
+export { BreadcrumbSkeleton };

package/es/components/Breadcrumb/Breadcrumb.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 React from 'react';
+import { ForwardRefReturn } from '../../types/common';
+export interface BreadcrumbProps extends React.HTMLAttributes<HTMLElement> {
+    /**
+     * Specify the label for the breadcrumb container
+     */
+    'aria-label'?: string;
+    /**
+     * Specify an optional className to be applied to the container node
+     */
+    className?: string;
+    /**
+     * Optional prop to omit the trailing slash for the breadcrumbs
+     */
+    noTrailingSlash?: boolean;
+}
+declare const Breadcrumb: ForwardRefReturn<HTMLElement, BreadcrumbProps>;
+export default Breadcrumb;

package/es/components/Breadcrumb/Breadcrumb.js

@@ -51,6 +51,5 @@ Breadcrumb.propTypes = {
    */
   noTrailingSlash: PropTypes.bool
 };
-var Breadcrumb$1 = Breadcrumb;
 
-export { Breadcrumb$1 as default };
+export { Breadcrumb as default };

package/es/components/Breadcrumb/BreadcrumbItem.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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, { AriaAttributes } from 'react';
+import { ForwardRefReturn } from '../../types/common';
+export interface BreadcrumbItemProps extends React.HTMLAttributes<HTMLLIElement> {
+    'aria-current'?: AriaAttributes['aria-current'];
+    /**
+     * Specify an optional className to be applied to the container node
+     */
+    className?: string;
+    /**
+     * Optional string representing the link location for the BreadcrumbItem
+     */
+    href?: string;
+    /**
+     * Provide if this breadcrumb item represents the current page
+     */
+    isCurrentPage?: boolean;
+}
+declare const BreadcrumbItem: ForwardRefReturn<HTMLLIElement, BreadcrumbItemProps>;
+export default BreadcrumbItem;

package/es/components/Breadcrumb/BreadcrumbItem.js

@@ -19,7 +19,7 @@ const BreadcrumbItem = /*#__PURE__*/React__default.forwardRef(function Breadcrum
   let {
     'aria-current': ariaCurrent,
     children,
-    className: customClassName,
+    className: customClassName = '',
     href,
     isCurrentPage,
     ...rest
@@ -32,13 +32,14 @@ const BreadcrumbItem = /*#__PURE__*/React__default.forwardRef(function Breadcrum
     [`${prefix}--breadcrumb-item--current`]: isCurrentPage && ariaCurrent !== 'page',
     [customClassName]: !!customClassName
   });
-  if (children.type && children.type.displayName !== undefined && children.type.displayName.includes('OverflowMenu')) {
+  const child = children;
+  if (child.type && child.type.displayName !== undefined && child.type.displayName.includes('OverflowMenu')) {
     const horizontalOverflowIcon = /*#__PURE__*/React__default.createElement(OverflowMenuHorizontal, {
       className: `${prefix}--overflow-menu__icon`
     });
     return /*#__PURE__*/React__default.createElement("li", _extends({
       className: className
-    }, rest), /*#__PURE__*/React__default.cloneElement(children, {
+    }, rest), /*#__PURE__*/React__default.cloneElement(child, {
       menuOptionsClass: `${prefix}--breadcrumb-menu-options`,
       menuOffset: {
         top: 10,
@@ -61,13 +62,14 @@ const BreadcrumbItem = /*#__PURE__*/React__default.forwardRef(function Breadcrum
   return /*#__PURE__*/React__default.createElement("li", _extends({
     className: className,
     ref: ref
-  }, rest), /*#__PURE__*/React__default.cloneElement(children, {
+  }, rest), /*#__PURE__*/React__default.cloneElement(child, {
     'aria-current': ariaCurrent,
-    className: cx(`${prefix}--link`, children.props.className)
+    className: cx(`${prefix}--link`, child.props.className)
   }));
 });
 BreadcrumbItem.displayName = 'BreadcrumbItem';
 BreadcrumbItem.propTypes = {
+  // @ts-expect-error - v12 TODO: BREAKING: This should match AriaAttributes['aria-current']
   'aria-current': PropTypes.oneOfType([PropTypes.string, PropTypes.bool]),
   /**
    * Pass in content that will be inside of the BreadcrumbItem
@@ -86,6 +88,5 @@ BreadcrumbItem.propTypes = {
    */
   isCurrentPage: PropTypes.bool
 };
-var BreadcrumbItem$1 = BreadcrumbItem;
 
-export { BreadcrumbItem$1 as default };
+export { BreadcrumbItem as default };

package/es/components/ComboBox/ComboBox.d.ts

@@ -9,10 +9,16 @@ import { type ComponentProps, type ReactNode, type ComponentType, type ReactElem
 import { ListBoxSize } from '../ListBox';
 type ExcludedAttributes = 'id' | 'onChange' | 'onClick' | 'type' | 'size';
 interface OnChangeData<ItemType> {
-    selectedItem: ItemType | null;
+    selectedItem: ItemType | null | undefined;
+    inputValue?: string | null;
 }
 type ItemToStringHandler<ItemType> = (item: ItemType | null) => string;
 export interface ComboBoxProps<ItemType> extends Omit<InputHTMLAttributes<HTMLInputElement>, ExcludedAttributes> {
+    /**
+     * Specify whether or not the ComboBox should allow a value that is
+     * not in the list to be entered in the input
+     */
+    allowCustomValue?: boolean;
     /**
      * Specify a label to be read by screen readers on the container node
      * 'aria-label' of the ListBox component.

package/es/components/ComboBox/ComboBox.js

@@ -32,7 +32,8 @@ const {
   keyDownEscape,
   clickButton,
   blurButton,
-  changeInput
+  changeInput,
+  blurInput
 } = Downshift.stateChangeTypes;
 const defaultItemToString = item => {
   if (typeof item === 'string') {
@@ -110,6 +111,7 @@ const ComboBox = /*#__PURE__*/forwardRef((props, ref) => {
     translateWithId,
     warn,
     warnText,
+    allowCustomValue = false,
     ...rest
   } = props;
   const prefix = usePrefix();
@@ -204,6 +206,17 @@ const ComboBox = /*#__PURE__*/forwardRef((props, ref) => {
       case changeInput:
         updateHighlightedIndex(getHighlightedIndex(changes));
         break;
+      case blurInput:
+        if (allowCustomValue) {
+          setInputValue(inputValue);
+          if (onChange) {
+            onChange({
+              selectedItem,
+              inputValue
+            });
+          }
+        }
+        break;
     }
   };
   const handleToggleClick = isOpen => event => {
@@ -302,8 +315,18 @@ const ComboBox = /*#__PURE__*/forwardRef((props, ref) => {
         if (match(event, Space)) {
           event.stopPropagation();
         }
-        if (match(event, Enter) && !inputValue) {
+        if (match(event, Enter) && (!inputValue || allowCustomValue)) {
           toggleMenu();
+
+          // Since `onChange` does not normally fire when the menu is closed, we should
+          // manually fire it when `allowCustomValue` is provided, the menu is closing,
+          // and there is a value.
+          if (allowCustomValue && isOpen && inputValue) {
+            onChange({
+              selectedItem,
+              inputValue
+            });
+          }
         }
         if (match(event, Escape) && inputValue) {
           if (event.target === textInput.current && isOpen) {
@@ -411,6 +434,11 @@ const ComboBox = /*#__PURE__*/forwardRef((props, ref) => {
 });
 ComboBox.displayName = 'ComboBox';
 ComboBox.propTypes = {
+  /**
+   * Specify whether or not the ComboBox should allow a value that is
+   * not in the list to be entered in the input
+   */
+  allowCustomValue: PropTypes.bool,
   /**
    * 'aria-label' of the ListBox component.
    * Specify a label to be read by screen readers on the container node

package/es/components/ContentSwitcher/ContentSwitcher.d.ts

@@ -40,7 +40,7 @@ export interface ContentSwitcherProps extends Omit<HTMLAttributes<HTMLElement>,
     /**
      * Choose whether or not to automatically change selection on focus
      */
-    selectionMode: 'automatic' | 'manual';
+    selectionMode?: 'automatic' | 'manual';
     /**
      * Specify the size of the Content Switcher. Currently supports either `sm`, 'md' (default) or 'lg` as an option.
      */

package/es/components/DataTable/TableBatchAction.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 from 'react';
+export interface TableBatchActionProps extends React.ButtonHTMLAttributes<HTMLButtonElement> {
+    /**
+     * Specify if the button is an icon-only button
+     */
+    hasIconOnly?: boolean;
+    /**
+     * If specifying the `renderIcon` prop, provide a description for that icon that can
+     * be read by screen readers
+     */
+    iconDescription?: string;
+    /**
+     * Optional function to render your own icon in the underlying button
+     */
+    renderIcon?: React.ElementType;
+}
+declare const TableBatchAction: {
+    ({ renderIcon, iconDescription, ...props }: {
+        [x: string]: any;
+        renderIcon?: import("@carbon/icons-react/lib/CarbonIcon").CarbonIconType | undefined;
+        iconDescription?: string | undefined;
+    }): JSX.Element;
+    propTypes: {
+        /**
+         * Specify if the button is an icon-only button
+         */
+        hasIconOnly: PropTypes.Requireable<boolean>;
+        /**
+         * If specifying the `renderIcon` prop, provide a description for that icon that can
+         * be read by screen readers
+         */
+        iconDescription: (props: any) => Error | undefined;
+        /**
+         * Optional function to render your own icon in the underlying button
+         */
+        renderIcon: PropTypes.Requireable<object>;
+    };
+};
+export default TableBatchAction;

package/es/components/DataTable/TableBatchAction.js

@@ -43,6 +43,5 @@ TableBatchAction.propTypes = {
    */
   renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object])
 };
-var TableBatchAction$1 = TableBatchAction;
 
-export { TableBatchAction$1 as default };
+export { TableBatchAction as default };

package/es/components/DataTable/TableExpandRow.d.ts

@@ -4,8 +4,7 @@
  * 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 { MouseEventHandler, PropsWithChildren } from 'react';
+import React, { MouseEventHandler, PropsWithChildren } from 'react';
 import { TableRowProps } from './TableRow';
 interface TableExpandRowProps extends PropsWithChildren<TableRowProps> {
     /**
@@ -41,48 +40,5 @@ interface TableExpandRowProps extends PropsWithChildren<TableRowProps> {
      */
     onExpand: MouseEventHandler<HTMLButtonElement>;
 }
-declare const TableExpandRow: {
-    ({ ["aria-controls"]: ariaControls, ["aria-label"]: ariaLabel, ariaLabel: deprecatedAriaLabel, className: rowClassName, children, isExpanded, onExpand, expandIconDescription, isSelected, expandHeader, ...rest }: TableExpandRowProps): JSX.Element;
-    propTypes: {
-        /**
-         * Space separated list of one or more ID values referencing the TableExpandedRow(s) being controlled by the TableExpandRow
-         * TODO: make this required in v12
-         */
-        "aria-controls": PropTypes.Requireable<string>;
-        /**
-         * Specify the string read by a voice reader when the expand trigger is
-         * focused
-         */
-        "aria-label": PropTypes.Requireable<string>;
-        /**
-         * Deprecated, please use `aria-label` instead.
-         * Specify the string read by a voice reader when the expand trigger is
-         * focused
-         */
-        ariaLabel: PropTypes.Requireable<string>;
-        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        className: PropTypes.Requireable<string>;
-        /**
-         * The id of the matching th node in the table head. Addresses a11y concerns outlined here: https://www.ibm.com/able/guidelines/ci162/info_and_relationships.html and https://www.w3.org/TR/WCAG20-TECHS/H43
-         */
-        expandHeader: PropTypes.Requireable<string>;
-        /**
-         * The description of the chevron right icon, to be put in its SVG `<title>` element.
-         */
-        expandIconDescription: PropTypes.Requireable<string>;
-        /**
-         * Specify whether this row is expanded or not. This helps coordinate data
-         * attributes so that `TableExpandRow` and `TableExpandedRow` work together
-         */
-        isExpanded: PropTypes.Validator<boolean>;
-        /**
-         * Specify if the row is selected
-         */
-        isSelected: PropTypes.Requireable<boolean>;
-        /**
-         * Hook for when a listener initiates a request to expand the given row
-         */
-        onExpand: PropTypes.Validator<(...args: any[]) => any>;
-    };
-};
+declare const TableExpandRow: React.ForwardRefExoticComponent<TableExpandRowProps & React.RefAttributes<HTMLTableCellElement>>;
 export default TableExpandRow;

package/es/components/DataTable/TableExpandRow.js

@@ -13,7 +13,7 @@ import { ChevronRight } from '@carbon/icons-react';
 import TableCell from './TableCell.js';
 import { usePrefix } from '../../internal/usePrefix.js';
 
-const TableExpandRow = _ref => {
+const TableExpandRow = /*#__PURE__*/React__default.forwardRef((_ref, ref) => {
   let {
     ['aria-controls']: ariaControls,
     ['aria-label']: ariaLabel,
@@ -35,6 +35,7 @@ const TableExpandRow = _ref => {
   }, rowClassName);
   const previousValue = isExpanded ? 'collapsed' : undefined;
   return /*#__PURE__*/React__default.createElement("tr", _extends({}, rest, {
+    ref: ref,
     className: className,
     "data-parent-row": true
   }), /*#__PURE__*/React__default.createElement(TableCell, {
@@ -53,17 +54,19 @@ const TableExpandRow = _ref => {
     className: `${prefix}--table-expand__svg`,
     "aria-label": expandIconDescription
   }))), children);
-};
+});
 TableExpandRow.propTypes = {
   /**
    * Space separated list of one or more ID values referencing the TableExpandedRow(s) being controlled by the TableExpandRow
    * TODO: make this required in v12
    */
+  /**@ts-ignore*/
   ['aria-controls']: PropTypes.string,
   /**
    * Specify the string read by a voice reader when the expand trigger is
    * focused
    */
+  /**@ts-ignore*/
   ['aria-label']: PropTypes.string,
   /**
    * Deprecated, please use `aria-label` instead.
@@ -95,5 +98,6 @@ TableExpandRow.propTypes = {
    */
   onExpand: PropTypes.func.isRequired
 };
+TableExpandRow.displayName = 'TableExpandRow';
 
 export { TableExpandRow as default };

package/es/components/Dropdown/Dropdown.d.ts

@@ -101,7 +101,7 @@ export interface DropdownProps<ItemType> extends Omit<ReactAttr<HTMLDivElement>,
      * An optional callback to render the currently selected item as a react element instead of only
      * as a string.
      */
-    renderSelectedItem?(item: ItemType): string;
+    renderSelectedItem?(item: ItemType): React.JSXElementConstructor<ItemType> | null;
     /**
      * In the case you want to control the dropdown selection entirely.
      */

package/es/components/FileUploader/FileUploaderDropContainer.d.ts

@@ -28,7 +28,7 @@ export interface FileUploaderDropContainerProps extends Omit<ReactAttr<HTMLButto
      * Provide the label text to be read by screen readers when interacting with
      * this control
      */
-    labelText: string;
+    labelText?: string;
     /**
      * Specify if the component should accept multiple files to upload
      */

package/es/components/Notification/Notification.d.ts

@@ -151,7 +151,7 @@ export interface ToastNotificationProps extends HTMLAttributes<HTMLDivElement> {
     /**
      * Specify what state the notification represents
      */
-    kind: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
     /**
      * Specify whether you are using the low contrast variant of the ToastNotification.
      */
@@ -163,12 +163,12 @@ export interface ToastNotificationProps extends HTMLAttributes<HTMLDivElement> {
     /**
      * Provide a function that is called when the close button is clicked
      */
-    onCloseButtonClick(event: MouseEvent): void;
+    onCloseButtonClick?(event: MouseEvent): void;
     /**
      * By default, this value is "status". You can also provide an alternate
      * role if it makes sense from the accessibility-side
      */
-    role: 'alert' | 'log' | 'status';
+    role?: 'alert' | 'log' | 'status';
     /**
      * Provide a description for "status" icon that can be read by screen readers
      */
@@ -277,7 +277,7 @@ export interface InlineNotificationProps extends HTMLAttributes<HTMLDivElement>
     /**
      * Specify what state the notification represents
      */
-    kind: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
     /**
      * Specify whether you are using the low contrast variant of the InlineNotification.
      */
@@ -289,12 +289,12 @@ export interface InlineNotificationProps extends HTMLAttributes<HTMLDivElement>
     /**
      * Provide a function that is called when the close button is clicked
      */
-    onCloseButtonClick(event: MouseEvent): void;
+    onCloseButtonClick?(event: MouseEvent): void;
     /**
      * By default, this value is "status". You can also provide an alternate
      * role if it makes sense from the accessibility-side.
      */
-    role: 'alert' | 'log' | 'status';
+    role?: 'alert' | 'log' | 'status';
     /**
      * Provide a description for "status" icon that can be read by screen readers
      */
@@ -399,7 +399,7 @@ export interface ActionableNotificationProps extends HTMLAttributes<HTMLDivEleme
     /**
      * Specify what state the notification represents
      */
-    kind: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
     /**
      * Specify whether you are using the low contrast variant of the ActionableNotification.
      */
@@ -416,7 +416,7 @@ export interface ActionableNotificationProps extends HTMLAttributes<HTMLDivEleme
     /**
      * Provide a function that is called when the close button is clicked
      */
-    onCloseButtonClick(event: MouseEvent): void;
+    onCloseButtonClick?(event: MouseEvent): void;
     /**
      * By default, this value is "alertdialog". You can also provide an alternate
      * role if it makes sense from from an accessibility perspective.

package/es/components/Tabs/Tabs.js

@@ -587,8 +587,7 @@ const Tab = /*#__PURE__*/forwardRef(function Tab(_ref5, forwardRef) {
   }, /*#__PURE__*/React__default.createElement(Icon, {
     size: 16
   })), /*#__PURE__*/React__default.createElement(Text, {
-    className: `${prefix}--tabs__nav-item-label`,
-    title: children
+    className: `${prefix}--tabs__nav-item-label`
   }, children), /*#__PURE__*/React__default.createElement("div", {
     className: cx(`${prefix}--tabs__nav-item--icon`, {
       [`${prefix}--visually-hidden`]: !hasIcon

package/es/components/TreeView/TreeNode.js

@@ -15,7 +15,7 @@ import { usePrefix } from '../../internal/usePrefix.js';
 import { matches, match } from '../../internal/keyboard/match.js';
 import { ArrowLeft, ArrowRight, Enter, Space } from '../../internal/keyboard/keys.js';
 
-function TreeNode(_ref) {
+const TreeNode = /*#__PURE__*/React__default.forwardRef((_ref, ref) => {
   let {
     active,
     children,
@@ -220,7 +220,8 @@ function TreeNode(_ref) {
     /*#__PURE__*/
     // eslint-disable-next-line jsx-a11y/role-supports-aria-props
     React__default.createElement("li", _extends({}, treeNodeProps, {
-      "aria-expanded": !!expanded
+      "aria-expanded": !!expanded,
+      ref: ref
     }), /*#__PURE__*/React__default.createElement("div", {
       className: `${prefix}--tree-node__label`,
       ref: currentNodeLabel
@@ -239,7 +240,7 @@ function TreeNode(_ref) {
       className: `${prefix}--tree-node__children`
     }, nodesWithProps))
   );
-}
+});
 TreeNode.propTypes = {
   /**
    * The value of the active node in the tree
@@ -299,5 +300,7 @@ TreeNode.propTypes = {
    */
   value: PropTypes.string
 };
+TreeNode.displayName = 'TreeNode';
+var TreeNode$1 = TreeNode;
 
-export { TreeNode as default };
+export { TreeNode$1 as default };

package/es/components/UIShell/HeaderMenu.js

@@ -148,7 +148,7 @@ class HeaderMenu extends React__default.Component {
       onKeyDown,
       ...rest
     } = this.props;
-    const hasActiveChildren = React__default.Children.toArray(children).some(child => child.props.isActive || child.props.isCurrentPage);
+    const hasActiveDescendant = childrenArg => React__default.Children.toArray(childrenArg).some(child => child.props.isActive || child.props.isCurrentPage || child.props.children instanceof Array && hasActiveDescendant(child.props.children));
     const accessibilityLabel = {
       'aria-label': ariaLabel,
       'aria-labelledby': ariaLabelledBy
@@ -163,7 +163,7 @@ class HeaderMenu extends React__default.Component {
       [`${prefix}--header__menu-title`]: true,
       // We set the current class only if `isActive` is passed in and we do
       // not have an `aria-current="page"` set for the breadcrumb item
-      [`${prefix}--header__menu-item--current`]: isActivePage || hasActiveChildren && !this.state.expanded
+      [`${prefix}--header__menu-item--current`]: isActivePage || hasActiveDescendant(children) && !this.state.expanded
     });
 
     // Notes on eslint comments and based on the examples in:

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

@@ -25,5 +25,5 @@ interface SideNavContextData {
     isRail?: boolean | undefined;
 }
 export declare const SideNavContext: React.Context<SideNavContextData>;
-declare const SideNav: React.ForwardRefExoticComponent<Pick<SideNavProps, "children" | "slot" | "style" | "title" | "className" | "dir" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "onToggle" | "key" | "id" | "aria-controls" | "aria-expanded" | "onClick" | "onAnimationEnd" | "onKeyDown" | "tabIndex" | "color" | "lang" | "role" | "href" | "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" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "translate" | "radioGroup" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "expanded" | "enterDelayMs" | "defaultExpanded" | "addFocusListeners" | "isChildOfHeader" | "isFixedNav" | "isRail" | "isPersistent" | "addMouseListeners" | "onOverlayClick" | "onSideNavBlur" | "inert"> & React.RefAttributes<HTMLElement>>;
+declare const SideNav: React.ForwardRefExoticComponent<Pick<SideNavProps, "children" | "slot" | "style" | "title" | "className" | "dir" | "defaultChecked" | "defaultValue" | "suppressContentEditableWarning" | "suppressHydrationWarning" | "accessKey" | "onToggle" | "key" | "id" | "aria-controls" | "aria-expanded" | "onClick" | "onAnimationEnd" | "onKeyDown" | "tabIndex" | "color" | "lang" | "role" | "href" | "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" | "contentEditable" | "contextMenu" | "draggable" | "hidden" | "placeholder" | "spellCheck" | "translate" | "radioGroup" | "about" | "datatype" | "inlist" | "prefix" | "property" | "resource" | "typeof" | "vocab" | "autoCapitalize" | "autoCorrect" | "autoSave" | "itemProp" | "itemScope" | "itemType" | "itemID" | "itemRef" | "results" | "security" | "unselectable" | "inputMode" | "is" | "expanded" | "enterDelayMs" | "defaultExpanded" | "inert" | "addFocusListeners" | "isChildOfHeader" | "isFixedNav" | "isRail" | "isPersistent" | "addMouseListeners" | "onOverlayClick" | "onSideNavBlur"> & React.RefAttributes<HTMLElement>>;
 export default SideNav;

package/es/components/UIShell/SideNavFooter.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 from 'react';
+import PropTypes from 'prop-types';
+export interface SideNavFooterProps {
+    /**
+     * Provide text to be read to screen readers and shown as a tooltip when
+     * interacting with the toggle button in the footer
+     */
+    assistiveText: string;
+    className?: string;
+    /**
+     * Specify whether the side navigation is expanded or collapsed
+     */
+    expanded: boolean;
+    /**
+     * Provide a function that is called when the toggle button is interacted
+     * with. Useful for controlling the expansion state of the side navigation.
+     */
+    onToggle: (event: React.MouseEvent<HTMLButtonElement>) => void;
+}
+/**
+ * SideNavFooter is used for rendering the button at the bottom of the side
+ * navigation that is a part of the UI Shell. It is responsible for handling the
+ * user interaction to expand or collapse the side navigation.
+ */
+declare function SideNavFooter({ assistiveText, className: customClassName, expanded, onToggle, }: SideNavFooterProps): JSX.Element;
+declare namespace SideNavFooter {
+    var displayName: string;
+    var propTypes: {
+        /**
+         * Provide text to be read to screen readers and shown as a tooltip when
+         * interacting with the toggle button in the footer
+         */
+        assistiveText: PropTypes.Requireable<string>;
+        className: PropTypes.Requireable<string>;
+        /**
+         * Specify whether the side navigation is expanded or collapsed
+         */
+        expanded: PropTypes.Validator<boolean>;
+        /**
+         * Provide a function that is called when the toggle button is interacted
+         * with. Useful for controlling the expansion state of the side navigation.
+         */
+        onToggle: PropTypes.Validator<(...args: any[]) => any>;
+    };
+}
+export default SideNavFooter;

package/es/components/UIShell/SideNavFooter.js

@@ -12,7 +12,6 @@ import PropTypes from 'prop-types';
 import { usePrefix } from '../../internal/usePrefix.js';
 
 var _Close, _ChevronRight;
-
 /**
  * SideNavFooter is used for rendering the button at the bottom of the side
  * navigation that is a part of the UI Shell. It is responsible for handling the