@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.js

@@ -15,7 +15,6 @@ import { NotificationsIllustration } from "../assets/NotificationsIllustration.j
 import React from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
-
 //#region src/components/EmptyStates/NotificationsEmptyState/NotificationsEmptyState.tsx
 /**
 * Copyright IBM Corp. 2020, 2024
@@ -50,7 +49,11 @@ const NotificationsEmptyState = React.forwardRef(({ action, className, illustrat
 });
 NotificationsEmptyState.displayName = componentName;
 NotificationsEmptyState.propTypes = {
+	/**
+	* Empty state action button
+	*/
 	action: PropTypes.shape({
+		/**@ts-ignore*/
 		...Button.propTypes,
 		kind: PropTypes.oneOf([
 			"primary",
@@ -58,24 +61,55 @@ NotificationsEmptyState.propTypes = {
 			"tertiary"
 		]),
 		renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+		/**@ts-ignore*/
 		onClick: Button.propTypes.onClick,
 		text: PropTypes.string
 	}),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Empty state headingAs allows you to customize the type of heading element
+	*/
 	headingAs: PropTypes.elementType,
+	/**
+	* The alt text for empty state svg images. If not provided , title will be used.
+	*/
 	illustrationDescription: PropTypes.string,
+	/**
+	* Designates the position of the illustration relative to the content
+	*/
 	illustrationPosition: PropTypes.oneOf([
 		"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: PropTypes.oneOf(["light", "dark"]),
+	/**
+	* Empty state link object
+	*/
+	/**@ts-ignore*/
 	link: PropTypes.any,
+	/**
+	* Empty state size
+	*/
 	size: PropTypes.oneOf(["lg", "sm"]),
+	/**
+	* Empty state subtitle
+	*/
 	subtitle: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
+	/**
+	* Empty state title
+	*/
 	title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]).isRequired
 };
-
 //#endregion
-export { NotificationsEmptyState };
+export { NotificationsEmptyState };

package/es/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.js

@@ -15,7 +15,6 @@ import { UnauthorizedIllustration } from "../assets/UnauthorizedIllustration.js"
 import React from "react";
 import PropTypes from "prop-types";
 import { Button, Link } from "@carbon/react";
-
 //#region src/components/EmptyStates/UnauthorizedEmptyState/UnauthorizedEmptyState.tsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -50,7 +49,11 @@ const UnauthorizedEmptyState = React.forwardRef(({ action, className, illustrati
 });
 UnauthorizedEmptyState.displayName = componentName;
 UnauthorizedEmptyState.propTypes = {
+	/**
+	* Empty state action button
+	*/
 	action: PropTypes.shape({
+		/**@ts-ignore*/
 		...Button.propTypes,
 		kind: PropTypes.oneOf([
 			"primary",
@@ -58,28 +61,59 @@ UnauthorizedEmptyState.propTypes = {
 			"tertiary"
 		]),
 		renderIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+		/**@ts-ignore*/
 		onClick: Button.propTypes.onClick,
 		text: PropTypes.string
 	}),
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Empty state headingAs allows you to customize the type of heading element
+	*/
 	headingAs: PropTypes.elementType,
+	/**
+	* The alt text for empty state svg images. If not provided , title will be used.
+	*/
 	illustrationDescription: PropTypes.string,
+	/**
+	* Designates the position of the illustration relative to the content
+	*/
 	illustrationPosition: PropTypes.oneOf([
 		"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: PropTypes.oneOf(["light", "dark"]),
+	/**
+	* Empty state link object
+	*/
+	/**@ts-ignore*/
 	link: PropTypes.shape({
 		...Link.propTypes,
 		text: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
 		href: PropTypes.string
 	}),
+	/**
+	* Empty state size
+	*/
 	size: PropTypes.oneOf(["lg", "sm"]),
+	/**
+	* Empty state subtitle
+	*/
 	subtitle: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
+	/**
+	* Empty state title
+	*/
 	title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]).isRequired
 };
-
 //#endregion
-export { UnauthorizedEmptyState };
+export { UnauthorizedEmptyState };

package/es/components/EmptyStates/assets/ErrorIllustration.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { useId } from "../../../global/js/utils/useId.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/EmptyStates/assets/ErrorIllustration.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -217,6 +216,5 @@ ErrorIllustration.propTypes = {
 	size: PropTypes.oneOf(["lg", "sm"]),
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { ErrorIllustration, ErrorIllustration as default };
+export { ErrorIllustration, ErrorIllustration as default };

package/es/components/EmptyStates/assets/NoDataIllustration.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { useId } from "../../../global/js/utils/useId.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/EmptyStates/assets/NoDataIllustration.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -180,6 +179,5 @@ NoDataIllustration.propTypes = {
 	size: PropTypes.oneOf(["lg", "sm"]),
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { NoDataIllustration, NoDataIllustration as default };
+export { NoDataIllustration, NoDataIllustration as default };

package/es/components/EmptyStates/assets/NoTagsIllustration.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { useId } from "../../../global/js/utils/useId.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/EmptyStates/assets/NoTagsIllustration.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -487,6 +486,5 @@ NoTagsIllustration.propTypes = {
 	size: PropTypes.oneOf(["lg", "sm"]),
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { NoTagsIllustration, NoTagsIllustration as default };
+export { NoTagsIllustration, NoTagsIllustration as default };

package/es/components/EmptyStates/assets/NotFoundIllustration.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { useId } from "../../../global/js/utils/useId.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/EmptyStates/assets/NotFoundIllustration.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -364,6 +363,5 @@ NotFoundIllustration.propTypes = {
 	size: PropTypes.oneOf(["lg", "sm"]),
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { NotFoundIllustration, NotFoundIllustration as default };
+export { NotFoundIllustration, NotFoundIllustration as default };

package/es/components/EmptyStates/assets/NotificationsIllustration.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { useId } from "../../../global/js/utils/useId.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/EmptyStates/assets/NotificationsIllustration.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -334,6 +333,5 @@ NotificationsIllustration.propTypes = {
 	size: PropTypes.oneOf(["lg", "sm"]),
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { NotificationsIllustration, NotificationsIllustration as default };
+export { NotificationsIllustration, NotificationsIllustration as default };

package/es/components/EmptyStates/assets/UnauthorizedIllustration.js

@@ -11,7 +11,6 @@ import { pkg } from "../../../settings.js";
 import { useId } from "../../../global/js/utils/useId.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/EmptyStates/assets/UnauthorizedIllustration.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -308,6 +307,5 @@ UnauthorizedIllustration.propTypes = {
 	size: PropTypes.oneOf(["lg", "sm"]),
 	theme: PropTypes.oneOf(["light", "dark"])
 };
-
 //#endregion
-export { UnauthorizedIllustration, UnauthorizedIllustration as default };
+export { UnauthorizedIllustration, UnauthorizedIllustration as default };

package/es/components/ExportModal/ExportModal.js

@@ -15,7 +15,6 @@ import React, { forwardRef, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, ComposedModal, FormGroup, Loading, ModalBody, ModalFooter, ModalHeader, PasswordInput, RadioButton, RadioButtonGroup, TextInput, unstable_FeatureFlags, usePrefix } from "@carbon/react";
 import { CheckmarkFilled, ErrorFilled } from "@carbon/react/icons";
-
 //#region src/components/ExportModal/ExportModal.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const componentName = "ExportModal";
@@ -140,36 +139,114 @@ const ExportModal = forwardRef(({ body, className, error, errorMessage, filename
 	}, primaryButtonText)))));
 });
 ExportModal.propTypes = {
+	/**
+	* Body content for the modal
+	*/
+	/**@ts-ignore*/
 	body: PropTypes.string,
+	/**
+	* Optional class name
+	*/
 	className: PropTypes.string,
+	/**
+	* specify if an error occurred
+	*/
 	error: PropTypes.bool,
+	/**
+	* messaging to display in the event of an error
+	*/
 	errorMessage: PropTypes.string,
+	/**
+	* name of the file being exported
+	*/
 	filename: PropTypes.string.isRequired,
+	/**
+	* label text that's displayed when hovering over visibility toggler to hide key
+	*/
 	hidePasswordLabel: PropTypes.string,
+	/**
+	* label for the text input
+	*/
 	inputLabel: PropTypes.string,
+	/**
+	* specify the type of text input
+	*/
+	/**@ts-ignore */
 	inputType: PropTypes.oneOf(["text", "password"]),
+	/**
+	* text for an invalid input
+	*/
 	invalidInputText: PropTypes.string,
+	/**
+	* specify if the modal is in a loading state
+	*/
 	loading: PropTypes.bool,
+	/**
+	* message to display during the loading state
+	*/
 	loadingMessage: PropTypes.string,
+	/**
+	* Specify a handler for closing modal
+	*/
 	onClose: PropTypes.func,
+	/**
+	* Specify a handler for "submitting" modal. Returns the file name
+	*/
 	onRequestSubmit: PropTypes.func,
+	/**
+	* Specify whether the Modal is currently open
+	*/
 	open: PropTypes.bool,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: PropTypes.node,
+	/**
+	* Array of extensions to display as radio buttons
+	*/
+	/**@ts-ignore */
 	preformattedExtensions: PropTypes.arrayOf(PropTypes.shape({
 		extension: PropTypes.string,
 		description: PropTypes.string
 	})),
+	/**
+	* Label for the preformatted label form group
+	*/
 	preformattedExtensionsLabel: PropTypes.string,
+	/**
+	* Specify the text for the primary button
+	*/
 	primaryButtonText: PropTypes.string.isRequired,
+	/**
+	* Specify the text for the secondary button
+	*/
 	secondaryButtonText: PropTypes.string.isRequired,
+	/**
+	* label text that's displayed when hovering over visibility toggler to show key
+	*/
 	showPasswordLabel: PropTypes.string,
+	/**
+	* messaging to display if the export was successful
+	*/
 	successMessage: PropTypes.string,
+	/**
+	* specify if the export was successful
+	*/
 	successful: PropTypes.bool,
+	/**
+	* The text displayed at the top of the modal
+	*/
 	title: PropTypes.string.isRequired,
+	/**
+	* Sets the trigger button ref
+	*/
 	triggerButtonRef: PropTypes.any,
+	/**
+	* array of valid extensions the file can have
+	*/
+	/**@ts-ignore */
 	validExtensions: PropTypes.array
 };
 ExportModal.displayName = componentName;
-
 //#endregion
-export { ExportModal };
+export { ExportModal };

package/es/components/ExpressiveCard/ExpressiveCard.js

@@ -10,7 +10,6 @@ import { prepareProps } from "../../global/js/utils/props-helper.js";
 import { Card } from "../Card/Card.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/ExpressiveCard/ExpressiveCard.tsx
 const componentName = "ExpressiveCard";
 const ExpressiveCard = forwardRef((props, ref) => {
@@ -27,43 +26,118 @@ const ExpressiveCard = forwardRef((props, ref) => {
 	});
 });
 ExpressiveCard.propTypes = {
+	/**
+	* Icons that are displayed on the card. Refer to design documentation for implementation guidelines. Note: href is deprecated. Set link.href for href functionality. If you are setting link object, href is a required property. link object supports all anchor element properties. Precedence: link.href > href. If link.href or href is set => anchor element, else button.
+	*/
+	/**@ts-ignore */
 	actionIcons: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.string,
 		icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
 		onKeyDown: PropTypes.func,
 		onClick: PropTypes.func,
 		iconDescription: PropTypes.string,
+		/**
+		* @deprecated please use the `link.href` instead
+		*/
 		href: PropTypes.string,
 		link: PropTypes.shape({ href: PropTypes.string.isRequired })
 	})),
+	/**
+	* Content that shows in the body of the card
+	*/
 	children: PropTypes.node,
+	/**
+	* Optional user provided class
+	*/
 	className: PropTypes.string,
+	/**
+	* Optional prop that allows you to pass any component.
+	*/
 	decorator: PropTypes.oneOfType([PropTypes.node, PropTypes.bool]),
+	/**
+	* Optional header description
+	*/
 	description: PropTypes.oneOfType([
 		PropTypes.string,
 		PropTypes.object,
 		PropTypes.node
 	]),
+	/**
+	* Optional label for the top of the card
+	*/
 	label: PropTypes.oneOfType([
 		PropTypes.string,
 		PropTypes.object,
 		PropTypes.node
 	]),
+	/**
+	* Optional media content like an image to be placed in the card
+	*/
 	media: PropTypes.node,
+	/**
+	* Establishes the position of the media in the card
+	*/
 	mediaPosition: PropTypes.oneOf(["top", "left"]),
+	/**
+	* Provides the callback for a clickable card
+	*/
 	onClick: PropTypes.func,
+	/**
+	* Function that's called from the primary button or action icon
+	*/
 	onPrimaryButtonClick: PropTypes.func,
+	/**
+	* Function that's called from the secondary button
+	*/
 	onSecondaryButtonClick: PropTypes.func,
+	/**
+	* Provides the icon that's displayed at the top of the card
+	*/
+	/**@ts-ignore */
 	pictogram: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Optionally specify an href for your Button to become an <a> element
+	*/
 	primaryButtonHref: PropTypes.string,
+	/**
+	* Optional prop to allow overriding the icon rendering. Can be a React component class
+	*/
+	/**@ts-ignore */
 	primaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Establishes the kind of button displayed for the primary button
+	*/
 	primaryButtonKind: PropTypes.oneOf(["primary", "ghost"]),
+	/**
+	* The text that's displayed in the primary button
+	*/
 	primaryButtonText: PropTypes.string,
+	/**
+	* Optionally specify an href for your Button to become an <a> element
+	*/
 	secondaryButtonHref: PropTypes.string,
+	/**
+	* Optional prop to allow overriding the icon rendering. Can be a React component class
+	*/
+	/**@ts-ignore */
 	secondaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
+	/**
+	* Establishes the kind of button displayed for the secondary button
+	*/
 	secondaryButtonKind: PropTypes.oneOf(["secondary", "ghost"]),
+	/**
+	* The text that's displayed in the secondary button
+	*/
 	secondaryButtonText: PropTypes.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.
+	* @deprecated please use the `decorator` prop
+	*/
 	slug: PropTypes.oneOfType([PropTypes.node, PropTypes.bool]),
+	/**
+	* Title that's displayed at the top of the card
+	*/
 	title: PropTypes.oneOfType([
 		PropTypes.string,
 		PropTypes.object,
@@ -71,6 +145,5 @@ ExpressiveCard.propTypes = {
 	])
 };
 ExpressiveCard.displayName = componentName;
-
 //#endregion
-export { ExpressiveCard };
+export { ExpressiveCard };

package/es/components/FeatureFlags/index.js

@@ -9,7 +9,6 @@ import { deprecateProp } from "../../global/js/utils/props-helper.js";
 import React, { createContext, useContext, useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { FeatureFlags, createScope } from "@carbon/feature-flags";
-
 //#region src/components/FeatureFlags/index.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -71,6 +70,9 @@ function FeatureFlags$1({ children, flags = {}, defaultPortalTargetBody = true,
 }
 FeatureFlags$1.propTypes = {
 	children: PropTypes.node,
+	/**
+	* Provide the feature flags to enabled or disabled in the current React tree
+	*/
 	defaultPortalTargetBody: PropTypes.bool,
 	enableDatagridUseCustomizeColumns: PropTypes.bool,
 	enableDatagridUseEditableCell: PropTypes.bool,
@@ -137,6 +139,5 @@ function isEqual(a, b) {
 	for (const key of Object.keys(b)) if (b[key] !== a[key]) return false;
 	return true;
 }
-
 //#endregion
-export { FeatureFlags$1 as FeatureFlags, useFeatureFlag, useFeatureFlags };
+export { FeatureFlags$1 as FeatureFlags, useFeatureFlag, useFeatureFlags };

package/es/components/FilterPanel/FilterPanel.js

@@ -11,7 +11,6 @@ import { pkg } from "../../settings.js";
 import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/FilterPanel/FilterPanel.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -41,10 +40,18 @@ FilterPanel.deprecated = {
 FilterPanel = pkg.checkComponentEnabled(FilterPanel, componentName);
 FilterPanel.displayName = componentName;
 FilterPanel.propTypes = {
+	/**
+	* Provide the contents of the FilterPanel.
+	*/
 	children: PropTypes.node,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Title text for the filter panel.
+	*/
 	title: PropTypes.node
 };
-
 //#endregion
-export { FilterPanel };
+export { FilterPanel };

package/es/components/FilterPanel/FilterPanelAccordion/FilterPanelAccordion.js

@@ -13,7 +13,6 @@ import { FilterPanelGroup } from "../FilterPanelGroup/FilterPanelGroup.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Accordion } from "@carbon/react";
-
 //#region src/components/FilterPanel/FilterPanelAccordion/FilterPanelAccordion.jsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -52,13 +51,30 @@ FilterPanelAccordion.deprecated = {
 FilterPanelAccordion = pkg.checkComponentEnabled(FilterPanelAccordion, componentName);
 FilterPanelAccordion.displayName = componentName;
 FilterPanelAccordion.propTypes = {
+	/**
+	* Props specific to the internal `Accordion` component.
+	*/
 	accordionProps: PropTypes.shape({}),
+	/**
+	* Provide the contents of the FilterPanelAccordion.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Number to be displayed with the label.
+	*/
 	count: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* The label for the component.
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Optional title attribute for the label.
+	*/
 	title: PropTypes.string
 };
-
 //#endregion
-export { FilterPanelAccordion };
+export { FilterPanelAccordion };

package/es/components/FilterPanel/FilterPanelAccordionItem/FilterPanelAccordionItem.js

@@ -14,7 +14,6 @@ import { FilterPanelLabel } from "../FilterPanelLabel/FilterPanelLabel.js";
 import React, { Children } from "react";
 import PropTypes from "prop-types";
 import { AccordionItem, ListItem } from "@carbon/react";
-
 //#region src/components/FilterPanel/FilterPanelAccordionItem/FilterPanelAccordionItem.jsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -60,14 +59,34 @@ FilterPanelAccordionItem.deprecated = {
 FilterPanelAccordionItem = pkg.checkComponentEnabled(FilterPanelAccordionItem, componentName);
 FilterPanelAccordionItem.displayName = componentName;
 FilterPanelAccordionItem.propTypes = {
+	/**
+	* Props specific to the internal `AccordionItem` component.
+	*/
 	accordionItemProps: PropTypes.shape({}),
+	/**
+	* Provide the contents of the FilterPanelAccordionItem.
+	*/
 	children: PropTypes.node.isRequired,
+	/**
+	* Optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* Number to be displayed with the label.
+	*/
 	count: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
+	/**
+	* The label for the component.
+	*/
 	labelText: PropTypes.node.isRequired,
+	/**
+	* Optional title attribute for the label.
+	*/
 	title: PropTypes.string,
+	/**
+	* Props specific to the internal `TruncatedList` component.
+	*/
 	truncatedListProps: PropTypes.shape({})
 };
-
 //#endregion
-export { FilterPanelAccordionItem };
+export { FilterPanelAccordionItem };