@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/HTTPErrors/HTTPErrorContent.js

@@ -9,7 +9,6 @@ import { pkg } from "../../settings.js";
 import React from "react";
 import { arrayOf, shape, string } from "prop-types";
 import { Link } from "@carbon/react";
-
 //#region src/components/HTTPErrors/HTTPErrorContent.jsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -30,15 +29,32 @@ let HTTPErrorContent = ({ description, errorCodeLabel, title, links }) => {
 };
 HTTPErrorContent.displayName = componentName;
 HTTPErrorContent.propTypes = {
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
 	links: arrayOf(shape({
 		...Link.propTypes,
+		/**
+		* The text to display for the link
+		*/
 		text: string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: string.isRequired
 };
-
 //#endregion
-export { HTTPErrorContent };
+export { HTTPErrorContent };

package/es/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.js

@@ -13,7 +13,6 @@ import { HTTPErrorContent } from "../HTTPErrorContent.js";
 import { HTTPErrorSvgOther } from "../assets/HTTPErrorSvgOther.js";
 import React from "react";
 import { arrayOf, shape, string } from "prop-types";
-
 //#region src/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.tsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -52,15 +51,36 @@ HTTPErrorOther.deprecated = {
 };
 HTTPErrorOther.displayName = componentName;
 HTTPErrorOther.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: string,
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
+	/**@ts-ignore */
 	links: arrayOf(shape({
+		/**
+		* The text to display for the link
+		*/
 		text: string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: string.isRequired
 };
-
 //#endregion
-export { HTTPErrorOther };
+export { HTTPErrorOther };

package/es/components/HTTPErrors/assets/HTTPErrorSvg403.js

@@ -8,7 +8,6 @@
 import { pkg } from "../../../settings.js";
 import React from "react";
 import { string } from "prop-types";
-
 //#region src/components/HTTPErrors/assets/HTTPErrorSvg403.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -994,6 +993,5 @@ HTTPErrorSvg403.propTypes = {
 	className: string,
 	title: string
 };
-
 //#endregion
-export { HTTPErrorSvg403 };
+export { HTTPErrorSvg403 };

package/es/components/HTTPErrors/assets/HTTPErrorSvg404.js

@@ -8,7 +8,6 @@
 import { pkg } from "../../../settings.js";
 import React from "react";
 import { string } from "prop-types";
-
 //#region src/components/HTTPErrors/assets/HTTPErrorSvg404.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -793,6 +792,5 @@ HTTPErrorSvg404.propTypes = {
 	className: string,
 	title: string
 };
-
 //#endregion
-export { HTTPErrorSvg404 };
+export { HTTPErrorSvg404 };

package/es/components/HTTPErrors/assets/HTTPErrorSvgOther.js

@@ -8,7 +8,6 @@
 import { pkg } from "../../../settings.js";
 import React from "react";
 import { string } from "prop-types";
-
 //#region src/components/HTTPErrors/assets/HTTPErrorSvgOther.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -844,6 +843,5 @@ HTTPErrorSvgOther.propTypes = {
 	className: string,
 	title: string
 };
-
 //#endregion
-export { HTTPErrorSvgOther };
+export { HTTPErrorSvgOther };

package/es/components/ImportModal/ImportModal.js

@@ -15,7 +15,6 @@ import React, { forwardRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, ComposedModal, FileUploaderDropContainer, FileUploaderItem, ModalBody, ModalFooter, ModalHeader, TextInput, usePrefix } from "@carbon/react";
 import { Add } from "@carbon/react/icons";
-
 //#region src/components/ImportModal/ImportModal.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -176,37 +175,123 @@ const ImportModal = forwardRef(({ accept = [], className, defaultErrorBody, defa
 	}, primaryButtonText))));
 });
 ImportModal.propTypes = {
+	/**
+	* Specifies the file types that are valid for importing
+	*/
 	accept: PropTypes.array,
+	/**
+	* Optional class name
+	*/
 	className: PropTypes.string,
+	/**
+	* The default message shown for an import error
+	*/
 	defaultErrorBody: PropTypes.string.isRequired,
+	/**
+	* The default header that is displayed to show an error message
+	*/
 	defaultErrorHeader: PropTypes.string.isRequired,
+	/**
+	* Content that is displayed inside the modal
+	*/
 	description: PropTypes.string,
+	/**
+	* Optional error body to display specifically for a fetch error
+	*/
 	fetchErrorBody: PropTypes.string,
+	/**
+	* Optional error header to display specifically for a fetch error
+	*/
 	fetchErrorHeader: PropTypes.string,
+	/**
+	* Header for the drag and drop box
+	*/
 	fileDropHeader: PropTypes.string,
+	/**
+	* Label for the drag and drop box
+	*/
 	fileDropLabel: PropTypes.string,
+	/**
+	* Label that appears when a file is uploaded to show number of files (1 / 1)
+	*/
 	fileUploadLabel: PropTypes.string,
+	/**
+	* Hide input label
+	*/
 	hideInputLabel: PropTypes.bool,
+	/**
+	* Button icon for import by url button
+	*/
 	inputButtonIcon: PropTypes.bool,
+	/**
+	* Button text for import by url button
+	*/
 	inputButtonText: PropTypes.string.isRequired,
+	/**
+	* ID for text input
+	*/
 	inputId: PropTypes.string,
+	/**
+	* Header to display above import by url
+	*/
 	inputLabel: PropTypes.string.isRequired,
+	/**
+	* Placeholder for text input
+	*/
 	inputPlaceholder: PropTypes.string,
+	/**
+	* Optional error message to display specifically for a invalid file type error
+	*/
 	invalidFileTypeErrorBody: PropTypes.string,
+	/**
+	* Optional error header to display specifically for a invalid file type error
+	*/
 	invalidFileTypeErrorHeader: PropTypes.string,
+	/**
+	* Description for delete file icon
+	*/
 	invalidIconDescription: PropTypes.string,
+	/**
+	* File size limit in bytes
+	*/
 	maxFileSize: PropTypes.number,
+	/**
+	* Optional error message to display specifically for a max file size error
+	*/
 	maxFileSizeErrorBody: PropTypes.string,
+	/**
+	* Optional error header to display specifically for a max file size error
+	*/
 	maxFileSizeErrorHeader: PropTypes.string,
+	/**
+	* Specify a handler for closing modal
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Specify a handler for "submitting" modal. Access the imported file via `file => {}`
+	*/
 	onRequestSubmit: PropTypes.func.isRequired,
+	/**
+	* Specify whether the Modal is currently open
+	*/
 	open: PropTypes.bool.isRequired,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: PropTypes.node,
+	/**
+	* Specify the text for the primary button
+	*/
 	primaryButtonText: PropTypes.string.isRequired,
+	/**
+	* Specify the text for the secondary button
+	*/
 	secondaryButtonText: PropTypes.string.isRequired,
+	/**
+	* The text displayed at the top of the modal
+	*/
 	title: PropTypes.string.isRequired
 };
 ImportModal.displayName = componentName;
-
 //#endregion
-export { ImportModal };
+export { ImportModal };

package/es/components/InlineTip/InlineTip.js

@@ -15,7 +15,6 @@ import React, { useEffect, useMemo, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, Heading, IconButton, Section } from "@carbon/react";
 import { Close, Crossroads, Idea } from "@carbon/react/icons";
-
 //#region src/components/InlineTip/InlineTip.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -87,21 +86,75 @@ const InlineTip = React.forwardRef(({ action, children, className, closeIconDesc
 });
 InlineTip.displayName = componentName;
 InlineTip.propTypes = {
+	/**
+	* Optional "call to action" ghost button or link that can appear
+	* directly below the content. This component comes with pre-styled
+	* elements available to use: `InlineTipLink` and `InlineTipButton`.
+	*/
 	action: PropTypes.node,
+	/**
+	* Provide the contents of the InlineTip.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* The label for the collapse button.
+	* This button is not visible if `media` is specified.
+	*/
 	collapseButtonLabel: PropTypes.string,
+	/**
+	* If set to `true`, it will truncate the body text to
+	* one line and expose an expand/collapse button toggle.
+	*
+	* This feature is disabled if `media` is specified.
+	*/
 	collapsible: PropTypes.bool,
+	/**
+	* The label for the expand button.
+	* This button is not visible if `media` is specified.
+	*/
 	expandButtonLabel: PropTypes.string,
+	/**
+	* Set to `true` to arrange the information in a format
+	* that is easier to read in a limited space.
+	*/
 	narrow: PropTypes.bool,
+	/**
+	* Function to call when the tertiary button is clicked.
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Function to call when the InlineTip is closed via the "X" button.
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Optional prop to render any media like images or animated media.
+	*/
 	renderMedia: PropTypes.func,
+	/**
+	* Defining the label will show a the tertiary button with the crossroads icon.
+	* You will still need to define the `onClose` method to trigger a callback.
+	*/
 	tertiaryButtonLabel: PropTypes.string,
+	/**
+	* The title of the InlineTip.
+	*/
 	title: PropTypes.string.isRequired,
+	/**
+	* If true, insert 1 rem of "space" on the left of the component.
+	* This will allow the component's content to line up with other
+	* content on the page under special circumstances.
+	*
+	* This will only be applied when `narrow` is false.
+	*/
 	withLeftGutter: PropTypes.bool
 };
-
 //#endregion
-export { InlineTip };
+export { InlineTip };

package/es/components/InlineTip/InlineTipButton.js

@@ -12,7 +12,6 @@ import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
-
 //#region src/components/InlineTip/InlineTipButton.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -38,9 +37,14 @@ const InlineTipButton = React.forwardRef(({ children, className, ...rest }, ref)
 });
 InlineTipButton.displayName = componentName;
 InlineTipButton.propTypes = {
+	/**
+	* Provide the contents of the InlineTipButton.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string
 };
-
 //#endregion
-export { InlineTipButton };
+export { InlineTipButton };

package/es/components/InlineTip/InlineTipLink.js

@@ -13,7 +13,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { Link } from "@carbon/react";
 import { Launch } from "@carbon/react/icons";
-
 //#region src/components/InlineTip/InlineTipLink.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -38,9 +37,14 @@ const InlineTipLink = React.forwardRef(({ children, className, ...rest }, ref) =
 });
 InlineTipLink.displayName = componentName;
 InlineTipLink.propTypes = {
+	/**
+	* Provide the contents of the InlineTipLink.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string
 };
-
 //#endregion
-export { InlineTipLink };
+export { InlineTipLink };

package/es/components/InlineTip/utils.js

@@ -27,6 +27,5 @@ const getComponentText = (reactNode) => {
 	if (typeof tmpChildren === "object") return getComponentText(reactNode.props.children);
 	if (typeof tmpChildren === "string") return reactNode.props.children;
 };
-
 //#endregion
-export { getComponentText };
+export { getComponentText };

package/es/components/InterstitialScreen/InterstitialScreen.js

@@ -15,7 +15,6 @@ import InterstitialScreenFooter from "./InterstitialScreenFooter.js";
 import React, { useCallback, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { ComposedModal, unstable_FeatureFlags } from "@carbon/react";
-
 //#region src/components/InterstitialScreen/InterstitialScreen.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -137,15 +136,36 @@ InterstitialScreen.Body = InterstitialScreenBody;
 InterstitialScreen.Footer = InterstitialScreenFooter;
 InterstitialScreen.displayName = componentName;
 InterstitialScreen.propTypes = {
+	/**
+	* The aria label applied to the Interstitial Screen component
+	*/
 	ariaLabel: PropTypes.string,
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Specifies whether the component is shown as a full-screen
+	* experience, else it is shown as a modal by default.
+	*/
 	isFullScreen: PropTypes.bool,
+	/**
+	* Provide a ref to return focus to once the interstitial is closed.
+	*/
 	launcherButtonRef: PropTypes.any,
+	/**
+	* Function to call when the close button is clicked.
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Specifies whether the component is currently open.
+	*/
 	open: PropTypes.bool
 };
-
 //#endregion
-export { InterstitialScreen };
+export { InterstitialScreen };

package/es/components/InterstitialScreen/InterstitialScreenBody.js

@@ -11,7 +11,6 @@ import { Carousel } from "../Carousel/Carousel.js";
 import React, { isValidElement, useContext, useEffect, useState } from "react";
 import PropTypes from "prop-types";
 import { ModalBody } from "@carbon/react";
-
 //#region src/components/InterstitialScreen/InterstitialScreenBody.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -78,10 +77,21 @@ const InterstitialScreenBody = React.forwardRef((props, ref) => {
 	}, renderBody());
 });
 InterstitialScreenBody.propTypes = {
+	/**
+	* Optional static content for body
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	*You can provide content either through a callback (contentRenderer) or as static children—but not both.
+	* If both are provided, contentRenderer always takes precedence. This optional callback should return the content
+	* to be rendered in the body section, which can be either a single element or an array of elements based on your needs.
+	* If internal state access isn’t required, you can simply use static children instead
+	*/
 	contentRenderer: PropTypes.func
 };
-
 //#endregion
-export { InterstitialScreenBody as default };
+export { InterstitialScreenBody as default };

package/es/components/InterstitialScreen/InterstitialScreenFooter.js

@@ -12,7 +12,6 @@ import React, { useContext, useEffect, useMemo, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, ButtonSet, InlineLoading, ModalFooter, usePrefix } from "@carbon/react";
 import { ArrowRight } from "@carbon/react/icons";
-
 //#region src/components/InterstitialScreen/InterstitialScreenFooter.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -111,14 +110,36 @@ const InterstitialScreenFooter = React.forwardRef((props, ref) => {
 	}, footerContent);
 });
 InterstitialScreenFooter.propTypes = {
+	/**
+	* This is an optional callback prop that allows to render your custom footer action buttons.
+	*/
 	actionButtonRenderer: PropTypes.func,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* The label for the Next button.
+	*/
 	nextButtonLabel: PropTypes.string,
+	/**
+	* optional asynchronous callback on action button click (skip, previous, next and start)
+	* note: this is applicable when not using custom actionButtonRenderer
+	*/
 	onAction: PropTypes.func,
+	/**
+	* The label for the Previous button.
+	*
+	*/
 	previousButtonLabel: PropTypes.string,
+	/**
+	* The label for the skip button.
+	*/
 	skipButtonLabel: PropTypes.string,
+	/**
+	* The label for the start button.
+	*/
 	startButtonLabel: PropTypes.string
 };
-
 //#endregion
-export { InterstitialScreenFooter as default };
+export { InterstitialScreenFooter as default };

package/es/components/InterstitialScreen/InterstitialScreenHeader.js

@@ -12,7 +12,6 @@ import { InterstitialScreenContext, blockClass } from "./context.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { ModalHeader, ProgressIndicator, ProgressStep, usePrefix } from "@carbon/react";
-
 //#region src/components/InterstitialScreen/InterstitialScreenHeader.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -64,13 +63,31 @@ const InterstitialScreenHeader = React.forwardRef((props, ref) => {
 	}, headerContent());
 });
 InterstitialScreenHeader.propTypes = {
+	/**
+	* Provide the optional content for header section and will be render after header titles and before progress indicator.
+	* People can make use of this if they want to have custom header.
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: PropTypes.string,
+	/**
+	* Provide an optional sub title to be applied to the header >.
+	*/
 	headerSubTitle: PropTypes.string,
+	/**
+	* Provide an optional title to be applied to the header >.
+	*/
 	headerTitle: PropTypes.string,
+	/**
+	* Optional parameter to hide the progress indicator when multiple steps are used.
+	*/
 	hideProgressIndicator: PropTypes.bool
 };
-
 //#endregion
-export { InterstitialScreenHeader as default };
+export { InterstitialScreenHeader as default };

package/es/components/InterstitialScreen/InterstitialScreenView.js

@@ -8,7 +8,6 @@
 import { pkg } from "../../settings.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/InterstitialScreen/InterstitialScreenView.tsx
 /**
 * Copyright IBM Corp. 2023, 2025
@@ -30,11 +29,22 @@ const InterstitialScreenView = React.forwardRef(({ children, className, stepTitl
 });
 InterstitialScreenView.displayName = componentName;
 InterstitialScreenView.propTypes = {
+	/**
+	* Provide the contents of the InterstitialScreenView.
+	*/
 	children: PropTypes.node,
+	/**
+	* Optional class name for this component.
+	*/
 	className: PropTypes.string,
+	/**
+	* The label to pass to the ProgressStep component.
+	*/
 	stepTitle: PropTypes.string.isRequired,
+	/**
+	* Optional method that takes in a message id and returns an internationalized string.
+	*/
 	translateWithId: PropTypes.func
 };
-
 //#endregion
-export { InterstitialScreenView };
+export { InterstitialScreenView };

package/es/components/InterstitialScreen/context.js

@@ -7,7 +7,6 @@
 
 import { pkg } from "../../settings.js";
 import { createContext } from "react";
-
 //#region src/components/InterstitialScreen/context.ts
 /**
 * Copyright IBM Corp. 2025, 2025
@@ -20,6 +19,5 @@ const InterstitialScreenContext = createContext({
 	progStep: 0,
 	stepCount: 0
 });
-
 //#endregion
-export { InterstitialScreenContext, blockClass };
+export { InterstitialScreenContext, blockClass };