@carbon/ibm-products 2.43.2-canary.19 → 2.43.2-canary.191

package/es/settings.d.ts

@@ -25,6 +25,7 @@ export const pkg: {
         ErrorEmptyState: boolean;
         ExportModal: boolean;
         ExpressiveCard: boolean;
+        FullPageError: boolean;
         HTTPError403: boolean;
         HTTPError404: boolean;
         HTTPErrorOther: boolean;
@@ -63,10 +64,11 @@ export const pkg: {
         EditFullPage: boolean;
         EditUpdateCards: boolean;
         Nav: boolean;
+        NavItem: boolean;
+        NavList: boolean;
         BigNumbers: boolean;
         TruncatedList: boolean;
         DelimitedList: boolean;
-        FullPageError: boolean;
         ScrollGradient: boolean;
         StringFormatter: boolean;
         StatusIndicator: boolean;

package/flags.js

@@ -1,3 +1,10 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
 const { pkg } = require('./lib/settings.js');
 const { component, feature } = pkg;
 

package/lib/components/APIKeyModal/APIKeyModal.types.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * 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 { ReactNode } from 'react';
 interface APIKeyModalCommonProps {
     /**
@@ -138,7 +144,7 @@ interface APIKeyModalCommonProps {
     /**
      * The DOM node the tearsheet should be rendered within. Defaults to document.body.
      */
-    portalTarget: ReactNode;
+    portalTarget?: ReactNode;
     /**
      * label text that's displayed when hovering over visibility toggler to show key
      */

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

@@ -1 +1,2 @@
-export { APIKeyModal } from "./APIKeyModal";
+export { APIKeyModal } from './APIKeyModal';
+export type { APIKeyModalProps } from './APIKeyModal.types';

package/lib/components/AboutModal/AboutModal.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ReactNode } from 'react';
-interface AboutModalProps {
+export interface AboutModalProps {
     /**
      * If you are legally required to display logos of technologies used
      * to build your product you can provide this in the additionalInfo.
@@ -77,4 +77,3 @@ interface AboutModalProps {
  * to completion.
  */
 export declare let AboutModal: React.ForwardRefExoticComponent<AboutModalProps & React.RefAttributes<HTMLDivElement>>;
-export {};

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

@@ -1 +1,8 @@
-export { AboutModal } from "./AboutModal";
+/**
+ * Copyright IBM Corp. 2021, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { AboutModal } from './AboutModal';
+export type { AboutModalProps } from './AboutModal';

package/lib/components/ActionBar/ActionBar.d.ts

@@ -1,5 +1,61 @@
+import React, { PropsWithChildren } from 'react';
+import { ButtonProps } from '@carbon/type';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface Action extends ButtonProps {
+    id?: string;
+    key: string;
+    iconDescription: string;
+    label: string;
+    onClick?: () => void;
+    renderIcon: CarbonIconType;
+}
+interface ActionBarProps extends PropsWithChildren {
+    /**
+     * Specifies the action bar items. Each item is specified as an object
+     * with required fields: key for array rendering, renderIcon, iconDescription and
+     * label to provide the icon to display,
+     * and optional 'onClick' to receive notifications when the button is clicked.
+     * Additional fields in the object will be passed to the
+     * Button component, and these can include 'disabled', 'ref', 'className',
+     * and any other Button props.
+     *
+     * Note that the Button props 'kind', 'size',
+     * 'tooltipPosition', 'tooltipAlignment' and 'type' are ignored, as these
+     * cannot be used for an action bar item.
+     *
+     * Carbon Button API https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+     */
+    actions?: readonly Action[];
+    /**
+     * className
+     */
+    className?: string;
+    /**
+     * maxVisible : Maximum action bar items visible before going into the overflow menu
+     */
+    maxVisible?: number;
+    /**
+     * class name applied to the overflow options
+     */
+    menuOptionsClass?: string;
+    /**
+     * onItemCountChange - event reporting maxWidth
+     */
+    onWidthChange?: (sizes: {
+        minWidth: number;
+        maxWidth: number;
+    }) => void;
+    /**
+     * overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+     */
+    overflowAriaLabel: string;
+    /**
+     * align tags to right of available space
+     */
+    rightAlign?: boolean;
+}
 /**
  * The ActionBar is used internally by the PageHeader to wrap ActionBarItems.
  */
-export let ActionBar: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let ActionBar: React.ForwardRefExoticComponent<ActionBarProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/ActionBar/ActionBar.js

@@ -29,7 +29,6 @@ var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 var _excluded = ["actions", "className", "maxVisible", "menuOptionsClass", "onWidthChange", "overflowAriaLabel", "rightAlign"],
   _excluded2 = ["key", "id"],
   _excluded3 = ["key"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--action-bar");
 var componentName = 'ActionBar';
@@ -38,7 +37,6 @@ var componentName = 'ActionBar';
 var defaults = {
   actions: Object.freeze([])
 };
-
 // NOTE: the component SCSS is not imported here: it is rolled up separately.
 
 /**
@@ -62,7 +60,7 @@ exports.ActionBar = /*#__PURE__*/React__default["default"].forwardRef(function (
     _useState4 = _rollupPluginBabelHelpers.slicedToArray(_useState3, 2),
     displayedItems = _useState4[0],
     setDisplayedItems = _useState4[1];
-  var _useState5 = React.useState([]),
+  var _useState5 = React.useState(null),
     _useState6 = _rollupPluginBabelHelpers.slicedToArray(_useState5, 2),
     hiddenSizingItems = _useState6[0],
     setHiddenSizingItems = _useState6[1];
@@ -70,7 +68,7 @@ exports.ActionBar = /*#__PURE__*/React__default["default"].forwardRef(function (
   var refDisplayedItems = React.useRef(null);
   var sizingRef = React.useRef(null);
   var sizes = React.useRef({});
-  var backupRef = React.useRef();
+  var backupRef = React.useRef(null);
   var localRef = ref || backupRef;
 
   // create hidden sizing items
@@ -130,24 +128,25 @@ exports.ActionBar = /*#__PURE__*/React__default["default"].forwardRef(function (
   var checkFullyVisibleItems = function checkFullyVisibleItems() {
     /* istanbul ignore if */
     if (sizingRef.current) {
+      var _refDisplayedItems$cu;
       var sizingItems = Array.from(sizingRef.current.querySelectorAll(".".concat(blockClass, "__hidden-sizing-item")));
 
       // first item is always the overflow even if nothing else is rendered
       var overflowItem = sizingItems.shift();
 
       // determine how many will fit
-      var spaceAvailable = refDisplayedItems.current.offsetWidth;
+      var spaceAvailable = (_refDisplayedItems$cu = refDisplayedItems.current) === null || _refDisplayedItems$cu === void 0 ? void 0 : _refDisplayedItems$cu.offsetWidth;
       var willFit = 0;
       var maxVisibleWidth = 0;
       var fitLimit = maxVisible ? Math.min(maxVisible, sizingItems.length) : sizingItems.length;
 
       // loop checking the space available
       for (var i = 0; i < fitLimit; i++) {
-        var newSpaceAvailable = spaceAvailable - sizingItems[i].offsetWidth;
+        var newSpaceAvailable = spaceAvailable && spaceAvailable - sizingItems[i].offsetWidth;
 
         // update maxVisibleWidth for later use by onWidthChange
         maxVisibleWidth += sizingItems[i].offsetWidth;
-        if (newSpaceAvailable >= 0) {
+        if (newSpaceAvailable && newSpaceAvailable >= 0) {
           spaceAvailable = newSpaceAvailable;
           willFit += 1;
         }
@@ -157,7 +156,7 @@ exports.ActionBar = /*#__PURE__*/React__default["default"].forwardRef(function (
       var overflowWidth = overflowItem.offsetWidth;
       if (willFit < sizingItems.length) {
         // Check space for overflow
-        while (willFit > 0 && spaceAvailable < overflowWidth) {
+        while (willFit > 0 && spaceAvailable && spaceAvailable < overflowWidth) {
           willFit -= 1;
 
           // Highly unlikely that any action bar item is narrower than the overflow item
@@ -170,7 +169,10 @@ exports.ActionBar = /*#__PURE__*/React__default["default"].forwardRef(function (
         sizes.current.minWidth = overflowWidth;
         sizes.current.maxWidth = maxVisibleWidth;
         // emit onWidthChange
-        onWidthChange(_rollupPluginBabelHelpers.objectSpread2({}, sizes.current));
+        onWidthChange({
+          minWidth: overflowWidth,
+          maxWidth: maxVisibleWidth
+        });
       }
       if (willFit < 1) {
         setDisplayCount(0);
@@ -221,14 +223,17 @@ exports.ActionBar.propTypes = {
    *
    * Carbon Button API https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
    */
+  /**@ts-ignore */
   actions: index["default"].arrayOf(index["default"].shape(_rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, propsHelper.prepareProps(react.Button.propTypes, [
   // props not desired from Button.propTypes
   'kind', 'size', 'tooltipPosition', 'tooltipAlignment'])), {}, {
+    id: index["default"].string,
     // Additional props
     key: index["default"].string.isRequired,
     // Redefine as form different  to Button and a key prop used by ActionBarItems
     iconDescription: index["default"].string.isRequired,
     label: index["default"].string.isRequired,
+    /**@ts-ignore */
     renderIcon: react.Button.propTypes.renderIcon.isRequired,
     // We duplicate onClick here to improve DocGen in Storybook
     onClick: index["default"].func

package/lib/components/ActionBar/ActionBarItem.d.ts

@@ -1,5 +1,39 @@
+import React, { PropsWithChildren } from 'react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface ActionBarItemProps extends PropsWithChildren {
+    /**
+     * Specify an optional className to be added to your Button
+     *
+     * (inherited from Carbon Button)
+     */
+    className?: string;
+    /**
+     * If specifying the `renderIcon` prop, provide a description for that icon that can
+     * be read by screen readers
+     *
+     * (inherited from Carbon Button)
+     */
+    label?: string;
+    /**
+     * Optional click handler
+     *
+     * (inherited from Carbon Button)
+     */
+    onClick?: () => void;
+    /**
+     * Optional prop to allow overriding the icon rendering.
+     * Can be a React component class
+     *
+     * (inherited from Carbon Button)
+     */
+    renderIcon?: CarbonIconType;
+    /**
+     * Optional tab index
+     */
+    tabIndex?: number;
+}
 /**
  * The ActionBarItem is used in the page header to populate the action bar
  */
-export let ActionBarItem: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let ActionBarItem: React.ForwardRefExoticComponent<ActionBarItemProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/ActionBar/ActionBarItem.js

@@ -22,11 +22,9 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 var _excluded = ["label", "className", "renderIcon"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var componentName = 'ActionBarItem';
 var blockClass = "".concat(settings.pkg.prefix, "--action-bar-item");
-
 // NOTE: the component SCSS is not imported here: it is rolled up separately.
 
 /**
@@ -43,7 +41,7 @@ exports.ActionBarItem = /*#__PURE__*/React__default["default"].forwardRef(functi
     className: cx__default["default"](blockClass, className),
     kind: 'ghost',
     size: 'md',
-    align: 'bottom-right',
+    align: 'bottom-end',
     type: 'button',
     label: label
   }), Icon ? /*#__PURE__*/React__default["default"].createElement(Icon, null) : null);
@@ -94,5 +92,10 @@ exports.ActionBarItem.propTypes = _rollupPluginBabelHelpers.objectSpread2(_rollu
    *
    * (inherited from Carbon Button)
    */
-  renderIcon: index["default"].oneOfType([index["default"].func, index["default"].object])
+  /**@ts-ignore */
+  renderIcon: index["default"].oneOfType([index["default"].func, index["default"].object]),
+  /**
+   * Optional tab index
+   */
+  tabIndex: index["default"].number
 });

package/lib/components/ActionBar/ActionBarOverflowItems.d.ts

@@ -1,18 +1,57 @@
-export function ActionBarOverflowItems({ className, menuOptionsClass, overflowItems, overflowAriaLabel, }: {
-    className: any;
-    menuOptionsClass: any;
-    overflowItems: any;
-    overflowAriaLabel: any;
-}): import("react/jsx-runtime").JSX.Element;
-export namespace ActionBarOverflowItems {
-    export { componentName as displayName };
-    export namespace propTypes {
-        let className: PropTypes.Requireable<string>;
-        let menuOptionsClass: PropTypes.Requireable<string>;
-        let overflowAriaLabel: PropTypes.Requireable<string>;
-        let overflowItems: PropTypes.Requireable<(PropTypes.ReactElementLike | null | undefined)[]>;
-    }
-}
-declare const componentName: "ActionBar";
+import { PropsWithChildren, ReactElement } from 'react';
 import PropTypes from 'prop-types';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+type OverflowItem = {
+    label: string;
+    onClick: () => void;
+    renderIcon: CarbonIconType;
+};
+interface ActionBarOverflowItemProps extends PropsWithChildren {
+    /**
+     * className
+     */
+    className?: string;
+    /**
+     * class name applied to the overflow options
+     */
+    menuOptionsClass?: string;
+    /**
+     * overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+     */
+    overflowAriaLabel?: string;
+    /**
+     * overflowItems: items to bre shown in the ActionBar overflow menu
+     */
+    overflowItems?: ReactElement<OverflowItem>[];
+    /**
+     * Optional tab index
+     */
+    tabIndex?: number;
+}
+export declare const ActionBarOverflowItems: {
+    ({ className, menuOptionsClass, overflowItems, overflowAriaLabel, }: ActionBarOverflowItemProps): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+    propTypes: {
+        /**
+         * className
+         */
+        className: PropTypes.Requireable<string>;
+        /**
+         * class name applied to the overflow options
+         */
+        menuOptionsClass: PropTypes.Requireable<string>;
+        /**
+         * overflowAriaLabel label for open close button overflow used for action bar items that do nto fit.
+         */
+        overflowAriaLabel: PropTypes.Requireable<string>;
+        /**
+         * overflowItems: items to bre shown in the ActionBar overflow menu
+         */
+        overflowItems: PropTypes.Requireable<(PropTypes.ReactElementLike | null | undefined)[]>;
+        /**
+         * Optional tab index
+         */
+        tabIndex: PropTypes.Requireable<number>;
+    };
+};
 export {};

package/lib/components/ActionBar/ActionBarOverflowItems.js

@@ -42,17 +42,17 @@ var ActionBarOverflowItems = function ActionBarOverflowItems(_ref) {
     // This uses a copy of a menu item option
     // NOTE: Cannot use a real Tooltip icon below as it uses a <button /> the
     // div equivalent below is based on Carbon 10.25.0
-    var ItemIcon = item.props.renderIcon;
+    var ItemIcon = item === null || item === void 0 ? void 0 : item.props.renderIcon;
     return /*#__PURE__*/React__default["default"].createElement(react.OverflowMenuItem, {
       className: "".concat(blockClass, "__item"),
-      onClick: item.props.onClick,
+      onClick: item === null || item === void 0 ? void 0 : item.props.onClick,
       itemText: /*#__PURE__*/React__default["default"].createElement("div", {
         className: "".concat(blockClass, "__item-content"),
         "aria-describedby": "".concat(internalId.current, "-").concat(index, "--item-label")
       }, /*#__PURE__*/React__default["default"].createElement("span", {
         className: "".concat(blockClass, "__item-label"),
         id: "".concat(internalId.current, "-").concat(index, "--item-label")
-      }, item.props.label), typeof item.props.renderIcon === 'function' ? /*#__PURE__*/React__default["default"].createElement(ItemIcon, null) : item.props.renderIcon)
+      }, item === null || item === void 0 ? void 0 : item.props.label), typeof (item === null || item === void 0 ? void 0 : item.props.renderIcon) === 'function' ? /*#__PURE__*/React__default["default"].createElement(ItemIcon, null) : item === null || item === void 0 ? void 0 : item.props.renderIcon)
     });
   }));
 };
@@ -74,7 +74,11 @@ ActionBarOverflowItems.propTypes = {
   /**
    * overflowItems: items to bre shown in the ActionBar overflow menu
    */
-  overflowItems: index["default"].arrayOf(index["default"].element)
+  overflowItems: index["default"].arrayOf(index["default"].element),
+  /**
+   * Optional tab index
+   */
+  tabIndex: index["default"].number
 };
 
 exports.ActionBarOverflowItems = ActionBarOverflowItems;

package/lib/components/ActionSet/ActionSet.d.ts

@@ -9,7 +9,7 @@ import React from 'react';
 import { ButtonProps } from '@carbon/react';
 export declare const ButtonSizes: readonly ["sm", "md", "lg", "xl", "2xl"];
 export type ButtonSize = (typeof ButtonSizes)[number];
-interface ActionSetProps {
+export interface ActionSetProps {
     /**
      * The action buttons to show. Each action is specified as an object
      * representation of a Carbon button.
@@ -47,4 +47,3 @@ interface ActionSetProps {
  * right.
  */
 export declare const ActionSet: React.ForwardRefExoticComponent<ActionSetProps & React.RefAttributes<HTMLDivElement>>;
-export {};

package/lib/components/ActionSet/ActionSet.js

@@ -10,12 +10,12 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
+var react = require('@carbon/react');
 var React = require('react');
+var propsHelper = require('../../global/js/utils/props-helper.js');
 var index = require('../../node_modules/prop-types/index.js');
 var cx = require('classnames');
 var settings = require('../../settings.js');
-var propsHelper = require('../../global/js/utils/props-helper.js');
-var react = require('@carbon/react');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 

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

@@ -1 +1,8 @@
-export { ActionSet } from "./ActionSet";
+/**
+ * Copyright IBM Corp. 2021, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+export { ActionSet } from './ActionSet';
+export type { ActionSetProps } from './ActionSet';

package/lib/components/AddSelect/AddSelectBody.js

@@ -14,6 +14,8 @@ var React = require('react');
 var index = require('../../node_modules/prop-types/index.js');
 var cx = require('classnames');
 var react = require('@carbon/react');
+var Tearsheet = require('../Tearsheet/Tearsheet.js');
+var TearsheetNarrow = require('../Tearsheet/TearsheetNarrow.js');
 var AddSelectSidebar = require('./AddSelectSidebar.js');
 var AddSelectBreadcrumbs = require('./AddSelectBreadcrumbs.js');
 var AddSelectList = require('./AddSelectList.js');
@@ -26,8 +28,6 @@ var useParentSelect = require('./hooks/useParentSelect.js');
 var usePath = require('./hooks/usePath.js');
 var settings = require('../../settings.js');
 var NotFoundEmptyState = require('../EmptyStates/NotFoundEmptyState/NotFoundEmptyState.js');
-var Tearsheet = require('../Tearsheet/Tearsheet.js');
-var TearsheetNarrow = require('../Tearsheet/TearsheetNarrow.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 

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

@@ -1 +1,2 @@
-export { AddSelect } from "./AddSelect";
+export { AddSelect } from './AddSelect';
+export type { AddSelectProps } from './AddSelect';

package/lib/components/AddSelect/types/index.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * 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 { ReactNode } from 'react';
 export type Theme = 'light' | 'dark';
 export interface Filter {

package/lib/components/Card/Card.d.ts

@@ -1,2 +1,69 @@
-export let Card: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+import React, { PropsWithChildren, ReactNode } from 'react';
+type ActionIcon = {
+    id?: string;
+    icon?: () => ReactNode;
+    onKeydown?: () => void;
+    onClick?: () => void;
+    iconDescription?: string;
+    href?: string;
+};
+type OverflowActions = {
+    id?: string;
+    itemText?: string;
+    onClick?: () => void;
+    onKeydown?: () => void;
+};
+type Metadata = {
+    id?: string;
+    icon?: () => ReactNode;
+    iconDescription?: string;
+    onClick?: () => void;
+    href?: string;
+};
+interface CardProp extends PropsWithChildren {
+    actionIcons?: readonly ActionIcon[];
+    actionsPlacement?: 'top' | 'bottom';
+    children?: ReactNode;
+    className?: string;
+    clickZone?: 'one' | 'two' | 'three';
+    description?: ReactNode;
+    disabled?: boolean;
+    footerActionIcon?: React.ElementType;
+    getStarted?: boolean;
+    label?: ReactNode;
+    media?: ReactNode;
+    mediaPosition?: 'top' | 'left';
+    metadata?: readonly Metadata[];
+    onClick?: () => void;
+    onKeyDown?: () => void;
+    onPrimaryButtonClick?: () => void;
+    onSecondaryButtonClick?: () => void;
+    overflowActions?: readonly OverflowActions[];
+    overflowAriaLabel?: string;
+    pictogram?: () => ReactNode;
+    primaryButtonDisabled?: boolean;
+    primaryButtonHref?: string;
+    primaryButtonIcon?: React.ElementType;
+    primaryButtonKind?: 'primary' | 'ghost';
+    primaryButtonPlacement?: 'top' | 'bottom';
+    primaryButtonText?: string;
+    productive?: boolean;
+    secondaryButtonDisabled?: boolean;
+    secondaryButtonHref?: string;
+    secondaryButtonIcon?: React.ElementType;
+    secondaryButtonKind?: 'secondary' | 'ghost';
+    secondaryButtonPlacement?: 'top' | 'bottom';
+    secondaryButtonText?: string;
+    sequence?: number;
+    iconDescription?: string;
+    /**
+     * **Experimental?** For all cases a `Slug` component can be provided.
+     * Clickable tiles only accept a boolean value of true and display a hollow slug.
+     */
+    slug?: ReactNode | boolean;
+    status?: 'complete' | 'incomplete';
+    title?: ReactNode;
+    titleSize?: 'default' | 'large';
+}
+export declare const Card: React.ForwardRefExoticComponent<CardProp & React.RefAttributes<HTMLDivElement>>;
+export {};