@carbon/ibm-products 2.36.0-alpha.27 → 2.37.0

package/lib/components/CreateTearsheet/CreateTearsheet.d.ts

@@ -1,4 +1,106 @@
-export const StepsContext: React.Context<null>;
-export const StepNumberContext: React.Context<number>;
-export let CreateTearsheet: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+/**
+ * Copyright IBM Corp. 2021, 2022
+ *
+ * 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, { ReactNode, PropsWithChildren, Dispatch, SetStateAction } from 'react';
+export interface StepsContextType {
+    currentStep: number;
+    setIsDisabled: Dispatch<SetStateAction<boolean>>;
+    setOnPrevious: (fn: any) => void;
+    setOnNext: (fn: any) => void;
+    setOnMount: (fn: any) => void;
+    setStepData: Dispatch<SetStateAction<Step[]>>;
+    stepData: Step[];
+}
+export declare const StepsContext: React.Context<StepsContextType | null>;
+export declare const StepNumberContext: React.Context<number>;
+interface CreateTearsheetProps extends PropsWithChildren {
+    /**
+     * The back button text
+     */
+    backButtonText: string;
+    /**
+     * The cancel button text
+     */
+    cancelButtonText: string;
+    /**
+     * The main content of the tearsheet
+     */
+    /**
+     * An optional class or classes to be added to the outermost element.
+     */
+    className?: string;
+    /**
+     * A description of the flow, displayed in the header area of the tearsheet.
+     */
+    description?: ReactNode;
+    /**
+     * Specifies elements to focus on first on render.
+     */
+    firstFocusElement?: string;
+    /**
+     * Used to set the size of the influencer
+     */
+    influencerWidth?: 'narrow' | 'wide';
+    /**
+     * This can be used to open the component to a step other than the first step.
+     * For example, a create flow was previously in progress, data was saved, and
+     * is now being completed.
+     */
+    initialStep?: number;
+    /**
+     * A label for the tearsheet, displayed in the header area of the tearsheet
+     * to maintain context for the tearsheet (e.g. as the title changes from page
+     * to page of a multi-page task).
+     */
+    label?: ReactNode;
+    /**
+     * The next button text
+     */
+    nextButtonText: string;
+    /**
+     * An optional handler that is called when the user closes the tearsheet (by
+     * clicking the close button, if enabled, or clicking outside, if enabled).
+     * Returning `false` here prevents the modal from closing.
+     */
+    onClose?: () => void;
+    /**
+     * Specify a handler for submitting the multi step tearsheet (final step).
+     * This function can _optionally_ return a promise that is either resolved or rejected and the CreateTearsheet will handle the submitting state of the create button.
+     */
+    onRequestSubmit: () => void;
+    /**
+     * Specifies whether the tearsheet is currently open.
+     */
+    open?: boolean;
+    /**
+     *  **Experimental:** Provide a `Slug` component to be rendered inside the `Tearsheet` component
+     */
+    slug?: ReactNode;
+    /**
+     * The submit button text
+     */
+    submitButtonText: string;
+    /**
+     * The main title of the tearsheet, displayed in the header area.
+     */
+    title?: ReactNode;
+    /**
+     * The position of the top of tearsheet in the viewport. The 'normal'
+     * position (the default) is a short distance down from the top of the
+     * viewport, leaving room at the top for a global header bar to show through
+     * from below. The 'lower' position provides a little extra room at the top
+     * to allow an action bar navigation or breadcrumbs to also show through.
+     */
+    verticalPosition?: 'normal' | 'lower';
+}
+interface Step {
+    introStep?: boolean;
+    secondaryLabel?: string;
+    shouldIncludeStep?: boolean;
+    title?: string;
+}
+export declare let CreateTearsheet: React.ForwardRefExoticComponent<CreateTearsheetProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/CreateTearsheet/CreateTearsheet.js

@@ -14,7 +14,6 @@ var React = require('react');
 var index = require('../../node_modules/prop-types/index.js');
 var cx = require('classnames');
 var react = require('@carbon/react');
-var wrapFocus = require('../../global/js/utils/wrapFocus.js');
 var TearsheetShell = require('../Tearsheet/TearsheetShell.js');
 var settings = require('../../settings.js');
 var devtools = require('../../global/js/utils/devtools.js');
@@ -39,17 +38,12 @@ var blockClass = "".concat(settings.pkg.prefix, "--tearsheet-create");
 // This is a general context for the steps container
 // containing information about the state of the container
 // and providing some callback methods for steps to use
+
 var StepsContext = /*#__PURE__*/React.createContext(null);
 
 // This is a context supplied separately to each step in the container
 // to let it know what number it is in the sequence of steps
 var StepNumberContext = /*#__PURE__*/React.createContext(-1);
-
-// Default values for props
-var defaults = {
-  verticalPosition: 'normal',
-  influencerWidth: 'narrow'
-};
 exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   var backButtonText = _ref.backButtonText,
     cancelButtonText = _ref.cancelButtonText,
@@ -57,7 +51,7 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     className = _ref.className,
     description = _ref.description,
     _ref$influencerWidth = _ref.influencerWidth,
-    influencerWidth = _ref$influencerWidth === void 0 ? defaults.influencerWidth : _ref$influencerWidth,
+    influencerWidth = _ref$influencerWidth === void 0 ? 'narrow' : _ref$influencerWidth,
     initialStep = _ref.initialStep,
     label = _ref.label,
     nextButtonText = _ref.nextButtonText,
@@ -69,7 +63,7 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     submitButtonText = _ref.submitButtonText,
     title = _ref.title,
     _ref$verticalPosition = _ref.verticalPosition,
-    verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+    verticalPosition = _ref$verticalPosition === void 0 ? 'normal' : _ref$verticalPosition,
     rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
   var _useState = React.useState([]),
     _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
@@ -115,7 +109,7 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     _useState22 = _rollupPluginBabelHelpers.slicedToArray(_useState21, 2),
     firstIncludedStep = _useState22[0],
     setFirstIncludedStep = _useState22[1];
-  var _useState23 = React.useState(null),
+  var _useState23 = React.useState(),
     _useState24 = _rollupPluginBabelHelpers.slicedToArray(_useState23, 2),
     lastIncludedStep = _useState24[0],
     setLastIncludedStep = _useState24[1];
@@ -123,7 +117,7 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     currentStep: currentStep,
     open: open
   });
-  var contentRef = React.useRef();
+  var contentRef = React.useRef(null);
   React.useEffect(function () {
     var firstItem = stepData.findIndex(function (item) {
       return item === null || item === void 0 ? void 0 : item.shouldIncludeStep;
@@ -153,9 +147,11 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   useResetCreateComponent.useResetCreateComponent({
     firstIncludedStep: firstIncludedStep,
     previousState: previousState,
+    /**@ts-ignore */
     open: open,
     setCurrentStep: setCurrentStep,
     stepData: stepData,
+    /**@ts-ignore */
     initialStep: initialStep,
     totalSteps: stepData === null || stepData === void 0 ? void 0 : stepData.length,
     componentName: componentName
@@ -170,6 +166,7 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     setCurrentStep: setCurrentStep,
     setIsSubmitting: setIsSubmitting,
     setShouldViewAll: setShouldViewAll,
+    /**@ts-ignore */
     setLoadingPrevious: setLoadingPrevious,
     loadingPrevious: loadingPrevious,
     onClose: onClose,
@@ -185,43 +182,26 @@ exports.CreateTearsheet = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     componentBlockClass: blockClass,
     setCreateComponentActions: setCreateTearsheetActions
   });
-
-  // adds focus trap functionality
-  /* istanbul ignore next */
-  var handleBlur = function handleBlur(_ref2) {
-    var oldActiveNode = _ref2.target,
-      currentActiveNode = _ref2.relatedTarget;
-    var visibleStepInnerContent = document.querySelector(".".concat(settings.pkg.prefix, "--tearsheet__body"));
-    if (open && visibleStepInnerContent) {
-      wrapFocus["default"]({
-        bodyNode: visibleStepInnerContent,
-        currentActiveNode: currentActiveNode,
-        oldActiveNode: oldActiveNode
-      });
-    }
-  };
-  return /*#__PURE__*/React__default["default"].createElement(TearsheetShell.TearsheetShell, _rollupPluginBabelHelpers["extends"]({}, rest, devtools.getDevtoolsProps(componentName), {
+  return /*#__PURE__*/React__default["default"].createElement(TearsheetShell.TearsheetShell, _rollupPluginBabelHelpers["extends"]({}, devtools.getDevtoolsProps(componentName), rest, {
+    ref: ref,
     actions: createTearsheetActions,
     className: cx__default["default"](blockClass, className),
     description: description,
-    hasCloseIcon: false,
     influencer: /*#__PURE__*/React__default["default"].createElement(CreateInfluencer.CreateInfluencer, {
       currentStep: currentStep,
       stepData: stepData
     }),
-    influencerPosition: "left",
     influencerWidth: influencerWidth,
     label: label,
     onClose: onClose,
     open: open,
-    size: "wide",
+    size: 'wide',
     slug: slug,
     title: title,
     verticalPosition: verticalPosition,
-    ref: ref
+    closeIconDescription: ''
   }), /*#__PURE__*/React__default["default"].createElement("div", {
     className: "".concat(blockClass, "__content"),
-    onBlur: handleBlur,
     ref: contentRef
   }, /*#__PURE__*/React__default["default"].createElement(react.Form, {
     "aria-label": title

package/lib/components/Datagrid/useParentDimensions.js

@@ -48,7 +48,7 @@ var useParentDimensions = function useParentDimensions(hooks) {
       setTableHeight(newHeight);
     };
     Object.assign(instance, {
-      tableHeight: tableHeight,
+      tableHeight: tableHeight || instance.tableHeight,
       rootRef: rootRef,
       headRef: headRef,
       innerListRef: innerListRef,

package/lib/components/EditUpdateCards/EditUpdateCards.d.ts

@@ -1,7 +1,109 @@
+/**
+ * Copyright IBM Corp. 2022, 2022
+ *
+ * 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, { ReactNode } from 'react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+type ActionIcon = {
+    id: string;
+    icon: CarbonIconType;
+    onKeyDown?(): void;
+    onClick?(): void;
+    iconDescription: string;
+    href?: string;
+};
+interface EditUpdateCardsProps {
+    /**
+     * Icons that are displayed on card. Refer to design documentation for implementation guidelines
+     */
+    actionIcons?: Array<ActionIcon>;
+    /**
+     * Determines if the action icons are on the top or bottom of the card
+     */
+    actionsPlacement?: 'top' | 'bottom';
+    /**
+     * Optional label for the top of the card.
+     */
+    className?: string;
+    /**
+     * Optional header description
+     */
+    description?: string;
+    /**
+     * Edit mode children
+     */
+    editChildren?: ReactNode;
+    /**
+     * Edit mode
+     */
+    editMode?: boolean;
+    /**
+     * Optional label for the top of the card
+     */
+    label?: string;
+    /**
+     * Function that's called from the primary button or action icon
+     */
+    onPrimaryButtonClick?(): void;
+    /**
+     * Function that's called from the secondary button or action icon
+     */
+    onSecondaryButtonClick?(): void;
+    /**
+     * Preview mode children
+     */
+    previewChildren?: ReactNode;
+    /**
+     * Optional prop to allow overriding the icon rendering. Can be a React component class
+     */
+    primaryButtonIcon?: CarbonIconType;
+    /**
+     * Establishes the kind of button displayed for the primary button
+     */
+    primaryButtonKind?: 'primary' | 'ghost';
+    /**
+     * Determines if the primary button is on the top or bottom of the card
+     */
+    primaryButtonPlacement?: 'top' | 'bottom';
+    /**
+     * The text that's displayed in the primary button
+     */
+    primaryButtonText?: string;
+    /**
+     * Optionally specify an href for your Button to become an <a> element
+     */
+    secondaryButtonHref?: string;
+    /**
+     * Optional prop to allow overriding the icon rendering. Can be a React component class
+     */
+    secondaryButtonIcon?: CarbonIconType;
+    /**
+     * Establishes the kind of button displayed for the secondary button
+     */
+    secondaryButtonKind?: 'secondary' | 'ghost';
+    /**
+     * Determines if the secondary button is on the top or bottom of the card
+     */
+    secondaryButtonPlacement?: 'top' | 'bottom';
+    /**
+     * The text that's displayed in the secondary button
+     */
+    secondaryButtonText?: string;
+    /**
+     * Title that's displayed at the top of the card
+     */
+    title?: string;
+    /**
+     * Determines title size
+     */
+    titleSize?: 'default' | 'large';
+}
 /**
  Editable cards allow a user to view, modify, and save the content contained within the card.
  These cards are generally used in instances where a user needs to make changes to a resource instances
  (ex. configuration details), account plan, etc. Editable cards allow a user to edit something within context.
  */
-export let EditUpdateCards: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let EditUpdateCards: React.ForwardRefExoticComponent<EditUpdateCardsProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EditUpdateCards/EditUpdateCards.js

@@ -118,6 +118,7 @@ exports.EditUpdateCards.propTypes = {
   /**
    * Icons that are displayed on card. Refer to design documentation for implementation guidelines
    */
+  /**@ts-ignore */
   actionIcons: index["default"].arrayOf(index["default"].shape({
     id: index["default"].string,
     icon: index["default"].oneOfType([index["default"].func, index["default"].object]),
@@ -165,6 +166,7 @@ exports.EditUpdateCards.propTypes = {
   /**
    * Optional prop to allow overriding the icon rendering. Can be a React component class
    */
+  /**@ts-ignore */
   primaryButtonIcon: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Establishes the kind of button displayed for the primary button
@@ -185,6 +187,7 @@ exports.EditUpdateCards.propTypes = {
   /**
    * Optional prop to allow overriding the icon rendering. Can be a React component class
    */
+  /**@ts-ignore */
   secondaryButtonIcon: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Establishes the kind of button displayed for the secondary button

package/lib/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.d.ts

@@ -1,5 +1,64 @@
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+/// <reference path="../../../../src/custom-typings/index.d.ts" />
+import React, { ReactNode } from 'react';
+import { ButtonProps } from '@carbon/react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+interface NotificationsEmptyStateProps {
+    /**
+     * Empty state action button
+     */
+    action?: {
+        kind?: 'primary' | 'secondary' | 'tertiary';
+        renderIcon?: CarbonIconType;
+        onClick?: ButtonProps['onClick'];
+        text?: string;
+    };
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * The alt text for empty state svg images. If not provided , title will be used.
+     */
+    illustrationDescription?: string;
+    /**
+     * Designates the position of the illustration relative to the content
+     */
+    illustrationPosition?: 'top' | 'right' | 'bottom' | 'left';
+    /**
+     * Empty state illustration theme variations.
+     * To ensure you use the correct themed illustrations, you can conditionally specify light or dark
+     * based on your app's current theme value. Example:
+     * `illustrationTheme={appTheme === ('carbon--g100' || 'carbon--g90') ? 'dark' : 'light'}`
+     */
+    illustrationTheme?: 'light' | 'dark';
+    /**
+     * Empty state link object
+     */
+    link?: {
+        text?: string | ReactNode;
+        href?: string;
+    };
+    /**
+     * Empty state size
+     */
+    size?: 'lg' | 'sm';
+    /**
+     * Empty state subtitle
+     */
+    subtitle: ReactNode;
+    /**
+     * Empty state title
+     */
+    title: ReactNode;
+}
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
-export let NotificationsEmptyState: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let NotificationsEmptyState: React.ForwardRefExoticComponent<NotificationsEmptyStateProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js

@@ -26,11 +26,9 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 var _excluded = ["action", "className", "illustrationPosition", "illustrationTheme", "illustrationDescription", "link", "size", "subtitle", "title"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(settings.pkg.prefix, "--empty-state");
 var componentName = 'NotificationsEmptyState';
-
 /**
  * The `EmptyState` component follows the Carbon guidelines for empty states with some added specifications around illustration usage. For additional usage guidelines and documentation please refer to the links above.
  */
@@ -59,7 +57,7 @@ exports.NotificationsEmptyState = /*#__PURE__*/React__default["default"].forward
     link: link,
     size: size,
     subtitle: subtitle,
-    title: title
+    title: title || ''
   }));
 });
 

package/lib/components/ExpressiveCard/ExpressiveCard.d.ts

@@ -1,2 +1,97 @@
-export let ExpressiveCard: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+import React, { PropsWithChildren, ReactNode } from 'react';
+type ActionIcon = {
+    id?: string;
+    icon?: () => void | object;
+    onKeydown?: () => void;
+    onClick?: () => void;
+    iconDescription?: string;
+    href?: string;
+};
+interface ExpressiveCardProps extends PropsWithChildren {
+    /**
+     * Icons that are displayed on card. Refer to design documentation for implementation guidelines. Note- href will supersede onClick
+     */
+    actionIcons?: ActionIcon[];
+    /**
+     * Content that shows in the body of the card
+     */
+    /**
+     * Optional user provided class
+     */
+    className?: string;
+    /**
+     * Optional header description
+     */
+    description?: string | object | ReactNode;
+    /**
+     * Optional label for the top of the card
+     */
+    label?: string | object | ReactNode;
+    /**
+     * Optional media content like an image to be placed in the card
+     */
+    media?: ReactNode;
+    /**
+     * Establishes the position of the media in the card
+     */
+    mediaPosition?: 'top' | 'left';
+    /**
+     * Provides the callback for a clickable card
+     */
+    onClick?: () => void;
+    /**
+     * Function that's called from the primary button or action icon
+     */
+    onPrimaryButtonClick?: () => void;
+    /**
+     * Function that's called from the secondary button
+     */
+    onSecondaryButtonClick?: () => void;
+    /**
+     * Provides the icon that's displayed at the top of the card
+     */
+    pictogram?: () => void | object;
+    /**
+     * Optionally specify an href for your Button to become an <a> element
+     */
+    primaryButtonHref?: string;
+    /**
+     * Optional prop to allow overriding the icon rendering. Can be a React component class
+     */
+    primaryButtonIcon?: () => void | object;
+    /**
+     * Establishes the kind of button displayed for the primary button
+     */
+    primaryButtonKind?: 'primary' | 'ghost';
+    /**
+     * The text that's displayed in the primary button
+     */
+    primaryButtonText?: string;
+    /**
+     * Optionally specify an href for your Button to become an <a> element
+     */
+    secondaryButtonHref?: string;
+    /**
+     * Optional prop to allow overriding the icon rendering. Can be a React component class
+     */
+    secondaryButtonIcon?: () => void | object;
+    /**
+     * Establishes the kind of button displayed for the secondary button
+     */
+    secondaryButtonKind?: 'secondary' | 'ghost';
+    /**
+     * The text that's displayed in the secondary button
+     */
+    secondaryButtonText?: 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;
+    /**
+     * Title that's displayed at the top of the card
+     */
+    title?: string | object | ReactNode;
+}
+export declare let ExpressiveCard: React.ForwardRefExoticComponent<ExpressiveCardProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/ExpressiveCard/ExpressiveCard.js

@@ -35,6 +35,7 @@ exports.ExpressiveCard.propTypes = {
   /**
    * Icons that are displayed on card. Refer to design documentation for implementation guidelines. Note- href will supersede onClick
    */
+  /**@ts-ignore */
   actionIcons: index["default"].arrayOf(index["default"].shape({
     id: index["default"].string,
     icon: index["default"].oneOfType([index["default"].func, index["default"].object]),
@@ -82,6 +83,7 @@ exports.ExpressiveCard.propTypes = {
   /**
    * Provides the icon that's displayed at the top of the card
    */
+  /**@ts-ignore */
   pictogram: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Optionally specify an href for your Button to become an <a> element
@@ -90,6 +92,7 @@ exports.ExpressiveCard.propTypes = {
   /**
    * Optional prop to allow overriding the icon rendering. Can be a React component class
    */
+  /**@ts-ignore */
   primaryButtonIcon: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Establishes the kind of button displayed for the primary button
@@ -106,6 +109,7 @@ exports.ExpressiveCard.propTypes = {
   /**
    * Optional prop to allow overriding the icon rendering. Can be a React component class
    */
+  /**@ts-ignore */
   secondaryButtonIcon: index["default"].oneOfType([index["default"].func, index["default"].object]),
   /**
    * Establishes the kind of button displayed for the secondary button

package/lib/components/InlineTip/InlineTipButton.d.ts

@@ -1,5 +1,24 @@
+/**
+ * Copyright IBM Corp. 2023, 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 React, { ReactNode } from 'react';
+interface InlineTipButtonProps {
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * Provide the contents of the InlineTip.
+     */
+    children: ReactNode;
+}
 /**
  * This is a standard Carbon button, styled specifically for use inside InlineTip.
  */
-export let InlineTipButton: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let InlineTipButton: React.ForwardRefExoticComponent<InlineTipButtonProps & {
+    children?: React.ReactNode;
+} & React.RefAttributes<HTMLButtonElement>>;
+export {};