@carbon/ibm-products 2.89.0 → 2.90.0

package/es/components/AddSelect/AddSelectBody.js

@@ -24,7 +24,6 @@ import usePath from "./hooks/usePath.js";
 import React, { forwardRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Tag } from "@carbon/react";
-
 //#region src/components/AddSelect/AddSelectBody.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--add-select`;
@@ -221,6 +220,7 @@ AddSelectBody.propTypes = {
 	globalSortBy: PropTypes.array,
 	illustrationTheme: PropTypes.oneOf(["light", "dark"]),
 	influencerTitle: PropTypes.string,
+	/**@ts-ignore */
 	items: PropTypes.shape({
 		modifiers: PropTypes.shape({
 			id: PropTypes.string,
@@ -265,6 +265,7 @@ AddSelectBody.propTypes = {
 	onSubmit: PropTypes.func,
 	onSubmitButtonText: PropTypes.string,
 	open: PropTypes.bool,
+	/**@ts-ignore */
 	portalTarget: PropTypes.node,
 	searchResultsTitle: PropTypes.string,
 	sortByLabel: PropTypes.string,
@@ -272,6 +273,5 @@ AddSelectBody.propTypes = {
 	useNormalizedItems: PropTypes.bool
 };
 AddSelectBody.displayName = componentName;
-
 //#endregion
-export { AddSelectBody };
+export { AddSelectBody };

package/es/components/AddSelect/AddSelectBreadcrumbs.js

@@ -11,7 +11,6 @@ import { pkg } from "../../settings.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Breadcrumb, BreadcrumbItem } from "@carbon/react";
-
 //#region src/components/AddSelect/AddSelectBreadcrumbs.jsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--add-select__breadcrumbs`;
@@ -41,6 +40,5 @@ AddSelectBreadcrumbs.propTypes = {
 	path: PropTypes.array
 };
 AddSelectBreadcrumbs.displayName = componentName;
-
 //#endregion
-export { AddSelectBreadcrumbs };
+export { AddSelectBreadcrumbs };

package/es/components/AddSelect/AddSelectColumn.js

@@ -14,9 +14,8 @@ import { useItemSort } from "./hooks/useItemSort.js";
 import useParentSelect from "./hooks/useParentSelect.js";
 import React, { useState } from "react";
 import PropTypes from "prop-types";
-import { Checkbox, IconButton, Popover, PopoverContent, Search, Tag, unstable_FeatureFlags, usePrefix } from "@carbon/react";
+import { Checkbox, IconButton, Popover, PopoverContent, Search, Tag, unstable_FeatureFlags } from "@carbon/react";
 import { Filter } from "@carbon/react/icons";
-
 //#region src/components/AddSelect/AddSelectColumn.jsx
 const blockClass = `${pkg.prefix}--add-select`;
 const colClass = `${blockClass}__column`;
@@ -163,6 +162,5 @@ AddSelectColumn.propTypes = {
 	sortByLabel: PropTypes.string
 };
 AddSelectColumn.displayName = componentName;
-
 //#endregion
-export { AddSelectColumn };
+export { AddSelectColumn };

package/es/components/AddSelect/AddSelectFilter.js

@@ -12,7 +12,6 @@ import React, { useState } from "react";
 import PropTypes from "prop-types";
 import { Button, ButtonSet, DismissibleTag, Dropdown, Layer, Search } from "@carbon/react";
 import { Filter } from "@carbon/react/icons";
-
 //#region src/components/AddSelect/AddSelectFilter.jsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--add-select__global-filter`;
@@ -128,6 +127,5 @@ AddSelectFilter.propTypes = {
 	secondaryButtonText: PropTypes.string
 };
 AddSelectFilter.displayName = componentName;
-
 //#endregion
-export { AddSelectFilter };
+export { AddSelectFilter };

package/es/components/AddSelect/AddSelectFormControl.js

@@ -10,7 +10,6 @@ import { UserProfileImage } from "../UserProfileImage/UserProfileImage.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Checkbox, CheckboxCheckedFilled, RadioButton, RadioButtonChecked } from "@carbon/react/icons";
-
 //#region src/components/AddSelect/AddSelectFormControl.jsx
 /**
 * Copyright IBM Corp. 2024
@@ -62,6 +61,5 @@ AddSelectFormControl.propTypes = {
 	type: PropTypes.oneOf(["checkbox", "radio"])
 };
 AddSelectFormControl.displayName = componentName;
-
 //#endregion
-export { AddSelectFormControl };
+export { AddSelectFormControl };

package/es/components/AddSelect/AddSelectList.js

@@ -12,7 +12,6 @@ import { AddSelectRow } from "./AddSelectRow.js";
 import useFocus from "./hooks/useFocus.js";
 import React from "react";
 import PropTypes from "prop-types";
-
 //#region src/components/AddSelect/AddSelectList.jsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--add-select__selections`;
@@ -43,6 +42,5 @@ AddSelectList.propTypes = {
 	multi: PropTypes.bool
 };
 AddSelectList.displayName = componentName;
-
 //#endregion
-export { AddSelectList };
+export { AddSelectList };

package/es/components/AddSelect/AddSelectMetaPanel.js

@@ -10,7 +10,6 @@ import React, { isValidElement } from "react";
 import PropTypes from "prop-types";
 import { Button } from "@carbon/react";
 import { Close } from "@carbon/react/icons";
-
 //#region src/components/AddSelect/AddSelectMetaPanel.jsx
 const blockClass = `${pkg.prefix}--add-select__meta-panel`;
 const componentName = "AddSelectMetaPanel";
@@ -47,6 +46,5 @@ AddSelectMetaPanel.propTypes = {
 	title: PropTypes.string.isRequired
 };
 AddSelectMetaPanel.displayName = componentName;
-
 //#endregion
-export { AddSelectMetaPanel };
+export { AddSelectMetaPanel };

package/es/components/AddSelect/AddSelectRow.js

@@ -13,7 +13,6 @@ import React, { useCallback, useEffect, useRef } from "react";
 import PropTypes from "prop-types";
 import { Button, Dropdown, Layer, MultiSelect } from "@carbon/react";
 import { ChevronRight, View } from "@carbon/react/icons";
-
 //#region src/components/AddSelect/AddSelectRow.jsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--add-select__selections`;
@@ -167,6 +166,5 @@ AddSelectRow.propTypes = {
 	singleSelection: PropTypes.string
 };
 AddSelectRow.displayName = componentName;
-
 //#endregion
-export { AddSelectRow };
+export { AddSelectRow };

package/es/components/AddSelect/AddSelectSidebar.js

@@ -11,7 +11,6 @@ import { AddSelectMetaPanel } from "./AddSelectMetaPanel.js";
 import React from "react";
 import PropTypes from "prop-types";
 import { Accordion, AccordionItem, Tag } from "@carbon/react";
-
 //#region src/components/AddSelect/AddSelectSidebar.jsx
 const blockClass = `${pkg.prefix}--add-select__sidebar`;
 const componentName = "AddSelectSidebar";
@@ -72,6 +71,5 @@ AddSelectSidebar.propTypes = {
 	setDisplayMetaPanel: PropTypes.func
 };
 AddSelectSidebar.displayName = componentName;
-
 //#endregion
-export { AddSelectSidebar };
+export { AddSelectSidebar };

package/es/components/AddSelect/AddSelectSort.js

@@ -10,7 +10,6 @@ import React from "react";
 import PropTypes from "prop-types";
 import { MenuItem, OverflowMenu, unstable_FeatureFlags } from "@carbon/react";
 import { ArrowsVertical } from "@carbon/react/icons";
-
 //#region src/components/AddSelect/AddSelectSort.tsx
 const blockClass = `${pkg.prefix}--add-select-sort`;
 const componentName = "AddSelectSort";
@@ -58,6 +57,5 @@ AddSelectSort.propTypes = {
 	sortByLabel: PropTypes.string
 };
 AddSelectSort.displayName = componentName;
-
 //#endregion
-export { AddSelectSort };
+export { AddSelectSort };

package/es/components/AddSelect/add-select-utils.js

@@ -93,6 +93,5 @@ const getFilteredItems = (useNormalizedItems, normalizedItems, searchTerm, globa
 		return items.entries;
 	}
 };
-
 //#endregion
-export { getFilteredItems, getGlobalFilterValues, normalize, sortItems };
+export { getFilteredItems, getGlobalFilterValues, normalize, sortItems };

package/es/components/AddSelect/hooks/useFocus.js

@@ -6,7 +6,6 @@
  */
 
 import { useCallback, useEffect, useState } from "react";
-
 //#region src/components/AddSelect/hooks/useFocus.js
 /**
 * Copyright IBM Corp. 2024
@@ -39,6 +38,5 @@ const useFocus = (size) => {
 	}, [handleKeyDown]);
 	return [currentFocus, setCurrentFocus];
 };
-
 //#endregion
-export { useFocus as default };
+export { useFocus as default };

package/es/components/AddSelect/hooks/useItemSort.js

@@ -6,7 +6,6 @@
  */
 
 import { useState } from "react";
-
 //#region src/components/AddSelect/hooks/useItemSort.js
 const useItemSort = () => {
 	const [sortDirection, setSortDirection] = useState("");
@@ -18,6 +17,5 @@ const useItemSort = () => {
 		setSortAttribute
 	};
 };
-
 //#endregion
-export { useItemSort };
+export { useItemSort };

package/es/components/AddSelect/hooks/useParentSelect.js

@@ -6,7 +6,6 @@
  */
 
 import { useState } from "react";
-
 //#region src/components/AddSelect/hooks/useParentSelect.js
 const useParentSelect = () => {
 	const [parentSelected, setParentSelected] = useState(null);
@@ -15,6 +14,5 @@ const useParentSelect = () => {
 		setParentSelected
 	};
 };
-
 //#endregion
-export { useParentSelect as default };
+export { useParentSelect as default };

package/es/components/AddSelect/hooks/usePath.js

@@ -6,7 +6,6 @@
  */
 
 import { useEffect, useState } from "react";
-
 //#region src/components/AddSelect/hooks/usePath.js
 const usePath = (itemsLabel = "") => {
 	const [path, setPath] = useState([{
@@ -51,6 +50,5 @@ const usePath = (itemsLabel = "") => {
 		resetPath
 	};
 };
-
 //#endregion
-export { usePath as default };
+export { usePath as default };

package/es/components/BigNumber/BigNumber.js

@@ -11,13 +11,12 @@ import { pkg } from "../../settings.js";
 import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
 import { TooltipTrigger } from "../TooltipTrigger/TooltipTrigger.js";
 import { getSupportedLocale } from "../../global/js/utils/getSupportedLocale.js";
-import { Characters, DefaultLocale, formatValue, getIconSize } from "./constants.js";
+import { DefaultLocale, formatValue, getIconSize } from "./constants.js";
 import { BigNumberSkeleton } from "./BigNumberSkeleton.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { Tooltip } from "@carbon/react";
 import { ArrowUp, Information } from "@carbon/react/icons";
-
 //#region src/components/BigNumber/BigNumber.tsx
 /**
 * Copyright IBM Corp. 2024, 2025
@@ -43,7 +42,7 @@ const BigNumber = forwardRef(({ className, forceShowTotal = false, fractionDigit
 		[`${blockClass}--xl`]: size === "xl"
 	});
 	const supportedLocale = getSupportedLocale(locale, DefaultLocale);
-	const truncatedValue = formatValue(supportedLocale, value, fractionDigits, truncate) ?? Characters.Dash;
+	const truncatedValue = formatValue(supportedLocale, value, fractionDigits, truncate) ?? "–";
 	const truncatedTotal = formatValue(supportedLocale, total, fractionDigits, truncate) ?? "Unknown";
 	const shouldDisplayDenominator = forceShowTotal || !percentage && total && value && total > value && truncatedValue !== truncatedTotal;
 	if (loading) return /* @__PURE__ */ React.createElement(BigNumberSkeleton, {
@@ -68,29 +67,76 @@ const BigNumber = forwardRef(({ className, forceShowTotal = false, fractionDigit
 	}, trending && /* @__PURE__ */ React.createElement(ArrowUp, {
 		className: `${blockClass}__trend`,
 		size: getIconSize(size)
-	}), /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__value` }, percentage ? /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__percentage` }, truncatedValue, /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__percentage-mark` }, "%")) : truncatedValue), shouldDisplayDenominator && /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__total` }, /* @__PURE__ */ React.createElement("span", null, `${Characters.Slash}${truncatedTotal}`)), /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__icon-button` }, iconButton)));
+	}), /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__value` }, percentage ? /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__percentage` }, truncatedValue, /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__percentage-mark` }, "%")) : truncatedValue), shouldDisplayDenominator && /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__total` }, /* @__PURE__ */ React.createElement("span", null, `/${truncatedTotal}`)), /* @__PURE__ */ React.createElement("span", { className: `${blockClass}__icon-button` }, iconButton)));
 });
 BigNumber.displayName = componentName;
 BigNumber.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	* The default behavior will hide `total` if `undefined` or is the same as `value`.
+	*
+	* Set to `true` to ignore the default behavior and show the `total`.
+	*/
 	forceShowTotal: PropTypes.bool,
+	/**
+	* Specifies the number of fraction digits when truncating `value` and `total`.
+	*/
 	fractionDigits: PropTypes.number,
+	/**
+	* Displays an icon button next to `value`.
+	*/
 	iconButton: PropTypes.node,
+	/**
+	* Text label above the `value`.
+	*/
 	label: PropTypes.string.isRequired,
+	/**
+	* When `true`, will show the loading state.
+	*/
 	loading: PropTypes.bool,
+	/**
+	* Determines how `value` and `total` will be formatted.
+	*/
 	locale: PropTypes.string,
+	/**
+	* Appends a percent sign (_%_) after `value` and hides `total`.
+	*/
 	percentage: PropTypes.bool,
+	/**
+	*
+	*/
 	size: PropTypes.oneOf([
 		"default",
 		"lg",
 		"xl"
 	]),
+	/**
+	* When applied, an information icon will be rendered next to the
+	* `label` and the description will be applied to its tooltip.
+	*/
 	tooltipDescription: PropTypes.string,
+	/**
+	* The number that will appear after the slash (i.e. the "denominator" of a fraction).
+	*
+	* This number will not be rendered if it's the same as `value` or
+	* `percentage` is true. See also the **forceShowTotal** prop.
+	*/
 	total: PropTypes.number,
+	/**
+	* When `true`, will render a "trending up" icon.
+	*/
 	trending: PropTypes.bool,
+	/**
+	* Abbreviates the number when `true`. E.g. from _1,000_ to _1K_.
+	*/
 	truncate: PropTypes.bool,
+	/**
+	* The primary value to display (or the "numerator" of a fraction).
+	*/
 	value: PropTypes.number
 };
-
 //#endregion
-export { BigNumber };
+export { BigNumber };

package/es/components/BigNumber/BigNumberSkeleton.js

@@ -9,11 +9,9 @@ import { __toESM } from "../../_virtual/_rolldown/runtime.js";
 import { require_classnames } from "../../node_modules/classnames/index.js";
 import { pkg } from "../../settings.js";
 import { getDevtoolsProps } from "../../global/js/utils/devtools.js";
-import { BigNumberSize } from "./constants.js";
 import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { SkeletonText } from "@carbon/react";
-
 //#region src/components/BigNumber/BigNumberSkeleton.tsx
 /**
 * Copyright IBM Corp. 2025
@@ -26,8 +24,8 @@ const blockClass = `${pkg.prefix}--big-number-skeleton`;
 const componentName = "BigNumberSkeleton";
 const BigNumberSkeleton = forwardRef(({ className, size, ...rest }, ref) => {
 	const bigNumberSkeletonClasses = (0, import_classnames.default)(className, blockClass, {
-		[`${blockClass}--lg`]: size === BigNumberSize.Large,
-		[`${blockClass}--xl`]: size === BigNumberSize.XLarge
+		[`${blockClass}--lg`]: size === "lg",
+		[`${blockClass}--xl`]: size === "xl"
 	});
 	return /* @__PURE__ */ React.createElement("div", {
 		...rest,
@@ -42,13 +40,18 @@ const BigNumberSkeleton = forwardRef(({ className, size, ...rest }, ref) => {
 });
 BigNumberSkeleton.displayName = componentName;
 BigNumberSkeleton.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: PropTypes.string,
+	/**
+	*
+	*/
 	size: PropTypes.oneOf([
-		BigNumberSize.Default,
-		BigNumberSize.Large,
-		BigNumberSize.XLarge
+		"default",
+		"lg",
+		"xl"
 	])
 };
-
 //#endregion
-export { BigNumberSkeleton };
+export { BigNumberSkeleton };

package/es/components/BigNumber/constants.js

@@ -6,23 +6,6 @@
  */
 
 //#region src/components/BigNumber/constants.ts
-/**
-* Copyright IBM Corp. 2025
-*
-* This source code is licensed under the Apache-2.0 license found in the
-* LICENSE file in the root directory of this source tree.
-*/
-let BigNumberSize = /* @__PURE__ */ function(BigNumberSize) {
-	BigNumberSize["Default"] = "default";
-	BigNumberSize["Large"] = "lg";
-	BigNumberSize["XLarge"] = "xl";
-	return BigNumberSize;
-}({});
-let Characters = /* @__PURE__ */ function(Characters) {
-	Characters["Dash"] = "–";
-	Characters["Slash"] = "/";
-	return Characters;
-}({});
 const DefaultLocale = "en-US";
 const formatValue = (locale, value, fractionDigits, truncate) => {
 	if (value === null || value === void 0 || typeof value !== "number") return null;
@@ -39,6 +22,5 @@ const getIconSize = (size) => {
 		default: return 16;
 	}
 };
-
 //#endregion
-export { BigNumberSize, Characters, DefaultLocale, formatValue, getIconSize };
+export { DefaultLocale, formatValue, getIconSize };

package/es/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.js

@@ -16,7 +16,6 @@ import React, { useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Breadcrumb, BreadcrumbItem, Link, MenuItem, OverflowMenu, Tooltip, unstable_FeatureFlags, usePrefix } from "@carbon/react";
 import { ArrowLeft, OverflowMenuHorizontal } from "@carbon/react/icons";
-
 //#region src/components/BreadcrumbWithOverflow/BreadcrumbWithOverflow.jsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--breadcrumb-with-overflow`;
@@ -166,21 +165,56 @@ let BreadcrumbWithOverflow = ({ breadcrumbs, className, label, maxVisible, noTra
 BreadcrumbWithOverflow = pkg.checkComponentEnabled(BreadcrumbWithOverflow, componentName);
 BreadcrumbWithOverflow.propTypes = {
 	breadcrumbs: PropTypes.arrayOf(PropTypes.shape({
+		/**
+		* Optional string representing the link location for the BreadcrumbItem
+		*/
 		href: PropTypes.string,
+		/**
+		* Provide if this breadcrumb item represents the current page
+		*/
 		isCurrentPage: PropTypes.bool,
+		/**
+		* Key required to render array efficiently
+		*/
 		key: PropTypes.string.isRequired,
+		/**
+		* Pass in content that will be inside of the BreadcrumbItem
+		*/
 		label: PropTypes.node,
+		/**
+		* An optional title label for extra long breadcrumb
+		*/
 		shortTitle: PropTypes.string,
+		/**
+		* A string based alternative to the children, required only if children is not of type string
+		*/
 		title: PropTypes.string
 	})),
+	/**
+	* className
+	*/
 	className: PropTypes.string,
+	/**
+	* Label for the Breadcrumb component
+	*/
 	label: PropTypes.string,
+	/**
+	* maxVisible: maximum visible breadcrumb-items before overflow is used (values less than 1 are treated as 1)
+	*/
 	maxVisible: PropTypes.number,
+	/**
+	* noTrailing slash - same as for Carbon
+	*/
 	noTrailingSlash: PropTypes.bool,
+	/**
+	* overflowAriaLabel label for open close button overflow used for breadcrumb items that do not fit.
+	*/
 	overflowAriaLabel: PropTypes.string,
+	/**
+	* overflowTooltipAlign: align tooltip position
+	*/
 	overflowTooltipAlign: Tooltip.propTypes.align
 };
 BreadcrumbWithOverflow.displayName = componentName;
-
 //#endregion
-export { BreadcrumbWithOverflow };
+export { BreadcrumbWithOverflow };

package/es/components/ButtonSetWithOverflow/ButtonSetWithOverflow.js

@@ -13,7 +13,6 @@ import { useResizeObserver } from "../../global/js/hooks/useResizeObserver.js";
 import React, { useEffect, useRef, useState } from "react";
 import PropTypes from "prop-types";
 import { Button, ButtonSet, MenuButton, MenuItem, usePrefix } from "@carbon/react";
-
 //#region src/components/ButtonSetWithOverflow/ButtonSetWithOverflow.jsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const blockClass = `${pkg.prefix}--button-set-with-overflow`;
@@ -68,7 +67,12 @@ const ButtonSetWithOverflow = ({ buttons, className, onWidthChange, buttonSetOve
 			}, label);
 		}));
 	});
-	AButtonSet.propTypes = { isHidden: PropTypes.bool };
+	AButtonSet.propTypes = { 
+	/**
+	*  isHidden - Used to conditionally change id if one is passed to the `AButtonSet` component
+	*  in order to avoid duplicate ids between the visible and hidden button set buttons
+	*/
+isHidden: PropTypes.bool };
 	const AButtonMenu = React.forwardRef(({ buttons, ...rest }, ref) => {
 		return /* @__PURE__ */ React.createElement(MenuButton, {
 			...rest,
@@ -118,14 +122,34 @@ const ButtonSetWithOverflow = ({ buttons, className, onWidthChange, buttonSetOve
 	})));
 };
 ButtonSetWithOverflow.propTypes = {
+	/**
+	*  buttonSetOverflowLabel - used when button set is shown as combo button
+	*/
 	buttonSetOverflowLabel: PropTypes.node.isRequired,
+	/**
+	* Specifies the buttons for the ButtonSetWithOverflow. Each item is specified as an object
+	* with the properties of a Carbon Button plus a label.
+	*
+	* Carbon Button API https://react.carbondesignsystem.com/?path=/docs/components-button--default#component-api
+	*/
 	buttons: PropTypes.array.isRequired,
+	/**
+	* className
+	*/
 	className: PropTypes.string,
+	/**
+	* class name applied to the overflow options
+	*/
 	menuOptionsClass: PropTypes.string,
+	/**
+	* onResize reports maxSize on resize
+	*/
 	onWidthChange: PropTypes.func,
+	/**
+	* align buttons to right of available space
+	*/
 	rightAlign: PropTypes.bool
 };
 ButtonSetWithOverflow.displayName = componentName;
-
 //#endregion
-export { ButtonSetWithOverflow };
+export { ButtonSetWithOverflow };

package/es/components/Card/Card.js

@@ -14,7 +14,6 @@ import React, { forwardRef } from "react";
 import PropTypes from "prop-types";
 import { Button, IconButton, Layer, MenuItem, OverflowMenu, Section, unstable_FeatureFlags } from "@carbon/react";
 import { CheckmarkOutline, Incomplete } from "@carbon/react/icons";
-
 //#region src/components/Card/Card.tsx
 var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
 const componentName = "Card";
@@ -171,12 +170,16 @@ const Card = forwardRef(({ actionIcons = Object.freeze([]), actionsPlacement = "
 	}, !getStarted && media && /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__media` }, media), Pictogram && /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__pictogram` }, /* @__PURE__ */ React.createElement(Pictogram, null)), getStarted && sequence && /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__sequence` }, sequence), getStarted && status && /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__status` }, status === "incomplete" && /* @__PURE__ */ React.createElement(Incomplete, null), status === "complete" && /* @__PURE__ */ React.createElement(CheckmarkOutline, null)), /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__content-container` }, /* @__PURE__ */ React.createElement("div", getHeaderBodyProps(), /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__header-wrapper` }, /* @__PURE__ */ React.createElement(CardHeader, getHeaderProps()), /* @__PURE__ */ React.createElement("div", getBodyProps(), children)), getStarted && media && /* @__PURE__ */ React.createElement("div", { className: `${blockClass}__media` }, media)), hasBottomBar && /* @__PURE__ */ React.createElement(CardFooter, getFooterProps())));
 });
 Card.propTypes = {
+	/**@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 })
 	})),
@@ -188,14 +191,20 @@ Card.propTypes = {
 		"two",
 		"three"
 	]),
+	/**
+	* Optional prop that allows you to pass any component.
+	*/
 	decorator: PropTypes.oneOfType([PropTypes.node, PropTypes.bool]),
+	/**@ts-ignore */
 	description: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
 	disabled: PropTypes.bool,
+	/**@ts-ignore */
 	footerActionIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
 	getStarted: PropTypes.bool,
 	label: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
 	media: PropTypes.node,
 	mediaPosition: PropTypes.oneOf(["top", "left"]),
+	/**@ts-ignore */
 	metadata: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.string,
 		icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
@@ -205,6 +214,7 @@ Card.propTypes = {
 	onKeyDown: PropTypes.func,
 	onPrimaryButtonClick: PropTypes.func,
 	onSecondaryButtonClick: PropTypes.func,
+	/**@ts-ignore */
 	overflowActions: PropTypes.arrayOf(PropTypes.shape({
 		id: PropTypes.string,
 		itemText: PropTypes.string,
@@ -212,9 +222,11 @@ Card.propTypes = {
 		onKeyDown: PropTypes.func
 	})),
 	overflowAriaLabel: PropTypes.string,
+	/**@ts-ignore */
 	pictogram: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
 	primaryButtonDisabled: PropTypes.bool,
 	primaryButtonHref: PropTypes.string,
+	/**@ts-ignore */
 	primaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
 	primaryButtonKind: PropTypes.oneOf(["primary", "ghost"]),
 	primaryButtonPlacement: PropTypes.oneOf(["top", "bottom"]),
@@ -222,17 +234,22 @@ Card.propTypes = {
 	productive: PropTypes.bool,
 	secondaryButtonDisabled: PropTypes.bool,
 	secondaryButtonHref: PropTypes.string,
+	/**@ts-ignore */
 	secondaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
 	secondaryButtonKind: PropTypes.oneOf(["secondary", "ghost"]),
 	secondaryButtonPlacement: PropTypes.oneOf(["top", "bottom"]),
 	secondaryButtonText: PropTypes.string,
 	sequence: PropTypes.number,
+	/**
+	* **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]),
 	status: PropTypes.oneOf(["complete", "incomplete"]),
 	title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
 	titleSize: PropTypes.oneOf(["default", "large"])
 };
 Card.displayName = componentName;
-
 //#endregion
-export { Card };
+export { Card };