@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/DecoratorBase/DecoratorBase.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_utils = require('./utils.js');
-const require_DecoratorIcon = require('./DecoratorIcon.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_utils = require("./utils.js");
+const require_DecoratorIcon = require("./DecoratorIcon.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/DecoratorBase/DecoratorBase.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -176,6 +175,9 @@ DecoratorBase.propTypes = {
 	disabled: prop_types.default.bool,
 	hideIcon: prop_types.default.bool,
 	href: prop_types.default.string,
+	/**
+	* `kind` differentiates between each type of Decorator, and is for internal use only.
+	*/
 	kind: prop_types.default.oneOf([
 		"default",
 		"link",
@@ -202,6 +204,5 @@ DecoratorBase.propTypes = {
 	value: prop_types.default.string.isRequired,
 	valueTitle: prop_types.default.string
 };
-
 //#endregion
-exports.DecoratorBase = DecoratorBase;
+exports.DecoratorBase = DecoratorBase;

package/lib/components/DecoratorBase/DecoratorIcon.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/DecoratorBase/DecoratorIcon.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -67,7 +66,13 @@ let DecoratorIcon = react.default.forwardRef(({ className, magnitude = defaults.
 DecoratorIcon = require_settings.pkg.checkComponentEnabled(DecoratorIcon, componentName);
 DecoratorIcon.displayName = componentName;
 DecoratorIcon.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Determines the shape and color of the icon.
+	*/
 	magnitude: prop_types.default.oneOf([
 		"unknown",
 		"benign",
@@ -76,13 +81,15 @@ DecoratorIcon.propTypes = {
 		"high",
 		"critical"
 	]),
+	/**
+	* Reduce the size of the icon in proportion to a smaller Decorator.
+	*/
 	small: prop_types.default.bool
 };
-
 //#endregion
-Object.defineProperty(exports, 'DecoratorIcon', {
-  enumerable: true,
-  get: function () {
-    return DecoratorIcon;
-  }
-});
+Object.defineProperty(exports, "DecoratorIcon", {
+	enumerable: true,
+	get: function() {
+		return DecoratorIcon;
+	}
+});

package/lib/components/DecoratorBase/utils.js

@@ -5,7 +5,6 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-
 //#region src/components/DecoratorBase/utils.js
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -27,7 +26,6 @@ const truncate = (inputText, truncateValue) => {
 	if (maxLength && inputText.length > maxLength) return `${inputText.substring(0, front)}…${inputText.substr(inputText.length - back)}`;
 	return inputText;
 };
-
 //#endregion
 exports.getMagnitude = getMagnitude;
-exports.truncate = truncate;
+exports.truncate = truncate;

package/lib/components/DecoratorDualButton/DecoratorDualButton.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_DecoratorBase = require('../DecoratorBase/DecoratorBase.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_DecoratorBase = require("../DecoratorBase/DecoratorBase.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/DecoratorDualButton/DecoratorDualButton.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -48,32 +47,104 @@ DecoratorDualButton.deprecated = {
 DecoratorDualButton = require_settings.pkg.checkComponentEnabled(DecoratorDualButton, componentName);
 DecoratorDualButton.displayName = componentName;
 DecoratorDualButton.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* `disabled` only applies if `kind` is "single-button" or "dual-button".
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Do not show the icon, regardless of score.
+	*/
 	hideIcon: prop_types.default.bool,
+	/**
+	* The label for the data.
+	*/
 	label: prop_types.default.string,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onClickLabel: prop_types.default.func,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onClickValue: prop_types.default.func,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onContextMenuLabel: prop_types.default.func,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onContextMenuValue: prop_types.default.func,
+	/**
+	* Used in conjunction with `scoreThresholds`, determines the color, shape, and type of magnitude of the icon.
+	*
+	* If you don't want to show the icon at all, set `hideIcon={true}`.
+	*/
 	score: prop_types.default.number,
+	/**
+	* Used in conjunction with `score`, determines the color, shape, and type of magnitude of the icon.
+	*
+	* An array of 4 numbers determines the range of thresholds.
+	*
+	* Example using `[0, 4, 7, 10]`:
+	* <br/>- `<= 0` "Benign"
+	* <br/>- `1-3` "Low"
+	* <br/>- `4-6` "Medium"
+	* <br/>- `7-9` "High"
+	* <br/>- `>= 10` "Critical"
+	* <br/>- `NaN` "Unknown"
+	*/
 	scoreThresholds: prop_types.default.arrayOf(prop_types.default.number),
+	/**
+	* Optional callback function for building a more detailed descriptive text.
+	* Returns `score`, `scoreThresholds`, `magnitude`.
+	*
+	* Typical description is in the form of
+	* '"(magnitude)" magnitude: score (score) out of (last element of scoreThresholds array)'.
+	*
+	* E.g. `"Medium" magnitude: score 5 out of 10`.
+	*
+	* If not defined, the title will default to the `label` prop.
+	*/
 	setLabelTitle: prop_types.default.func,
+	/**
+	* Styled smaller to better fit inline with text.
+	*/
 	small: prop_types.default.bool,
+	/**
+	* Override the default theme of the component.
+	* Useful if you want "invert" the component's theme.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* If not defined, it will behave as `display:inline-block`.
+	*/
 	truncateValue: prop_types.default.oneOfType([prop_types.default.oneOf(["end", "start"]), prop_types.default.shape({
 		maxLength: prop_types.default.number,
 		front: prop_types.default.number,
 		back: prop_types.default.number
 	})]),
+	/**
+	* The value of the data.
+	*/
 	value: prop_types.default.string.isRequired,
+	/**
+	* Overrides the default title for the Decorator's value.
+	*/
 	valueTitle: prop_types.default.string
 };
-
 //#endregion
-Object.defineProperty(exports, 'DecoratorDualButton', {
-  enumerable: true,
-  get: function () {
-    return DecoratorDualButton;
-  }
-});
+Object.defineProperty(exports, "DecoratorDualButton", {
+	enumerable: true,
+	get: function() {
+		return DecoratorDualButton;
+	}
+});

package/lib/components/DecoratorLink/DecoratorLink.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_DecoratorBase = require('../DecoratorBase/DecoratorBase.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_DecoratorBase = require("../DecoratorBase/DecoratorBase.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/DecoratorLink/DecoratorLink.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -50,30 +49,94 @@ DecoratorLink.deprecated = {
 DecoratorLink = require_settings.pkg.checkComponentEnabled(DecoratorLink, componentName);
 DecoratorLink.displayName = componentName;
 DecoratorLink.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Do not show the icon, regardless of score.
+	*/
 	hideIcon: prop_types.default.bool,
+	/**
+	* The component's URL.
+	*/
 	href: prop_types.default.string.isRequired,
+	/**
+	* The label for the data.
+	*/
 	label: prop_types.default.string,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onContextMenu: prop_types.default.func,
+	/**
+	* Used in conjunction with `scoreThresholds`, determines the color, shape, and type of magnitude of the icon.
+	*
+	* If you don't want to show the icon at all, set `hideIcon={true}`.
+	*/
 	score: prop_types.default.number,
+	/**
+	* Used in conjunction with `score`, determines the color, shape, and type of magnitude of the icon.
+	*
+	* An array of 4 numbers determines the range of thresholds.
+	*
+	* Example using `[0, 4, 7, 10]`:
+	* <br/>- `<= 0` "Benign"
+	* <br/>- `1-3` "Low"
+	* <br/>- `4-6` "Medium"
+	* <br/>- `7-9` "High"
+	* <br/>- `>= 10` "Critical"
+	* <br/>- `NaN` "Unknown"
+	*/
 	scoreThresholds: prop_types.default.arrayOf(prop_types.default.number),
+	/**
+	* Optional callback function for building a more detailed descriptive text.
+	* Returns `score`, `scoreThresholds`, `magnitude`.
+	*
+	* Typical description is in the form of
+	* '"(magnitude)" magnitude: score (score) out of (last element of scoreThresholds array)'.
+	*
+	* E.g. `"Medium" magnitude: score 5 out of 10`.
+	*
+	* If not defined, the title will default to the `label` prop.
+	*/
 	setLabelTitle: prop_types.default.func,
+	/**
+	* Styled smaller to better fit inline with text.
+	*/
 	small: prop_types.default.bool,
+	/**
+	* Override the default theme of the component.
+	* Useful if you want "invert" the component's theme.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* If not defined, it will behave as `display:inline-block`.
+	*/
 	truncateValue: prop_types.default.oneOfType([prop_types.default.oneOf(["end", "start"]), prop_types.default.shape({
 		maxLength: prop_types.default.number,
 		front: prop_types.default.number,
 		back: prop_types.default.number
 	})]),
+	/**
+	* The value of the data.
+	*/
 	value: prop_types.default.string.isRequired,
+	/**
+	* Overrides the default title for the Decorator's value.
+	*/
 	valueTitle: prop_types.default.string
 };
-
 //#endregion
-Object.defineProperty(exports, 'DecoratorLink', {
-  enumerable: true,
-  get: function () {
-    return DecoratorLink;
-  }
-});
+Object.defineProperty(exports, "DecoratorLink", {
+	enumerable: true,
+	get: function() {
+		return DecoratorLink;
+	}
+});

package/lib/components/DecoratorSingleButton/DecoratorSingleButton.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_DecoratorBase = require('../DecoratorBase/DecoratorBase.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_DecoratorBase = require("../DecoratorBase/DecoratorBase.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/DecoratorSingleButton/DecoratorSingleButton.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -50,30 +49,94 @@ DecoratorSingleButton.deprecated = {
 DecoratorSingleButton = require_settings.pkg.checkComponentEnabled(DecoratorSingleButton, componentName);
 DecoratorSingleButton.displayName = componentName;
 DecoratorSingleButton.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* `disabled` only applies if `kind` is "single-button" or "dual-button".
+	*/
 	disabled: prop_types.default.bool,
+	/**
+	* Do not show the icon, regardless of score.
+	*/
 	hideIcon: prop_types.default.bool,
+	/**
+	* The label for the data.
+	*/
 	label: prop_types.default.string,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Optional callback function.
+	* Returns two objects: `event` and `{ score, label, value, magnitude }`
+	*/
 	onContextMenu: prop_types.default.func,
+	/**
+	* Used in conjunction with `scoreThresholds`, determines the color, shape, and type of magnitude of the icon.
+	*
+	* If you don't want to show the icon at all, set `hideIcon={true}`.
+	*/
 	score: prop_types.default.number,
+	/**
+	* Used in conjunction with `score`, determines the color, shape, and type of magnitude of the icon.
+	*
+	* An array of 4 numbers determines the range of thresholds.
+	*
+	* Example using `[0, 4, 7, 10]`:
+	* <br/>- `<= 0` "Benign"
+	* <br/>- `1-3` "Low"
+	* <br/>- `4-6` "Medium"
+	* <br/>- `7-9` "High"
+	* <br/>- `>= 10` "Critical"
+	* <br/>- `NaN` "Unknown"
+	*/
 	scoreThresholds: prop_types.default.arrayOf(prop_types.default.number),
+	/**
+	* Optional callback function for building a more detailed descriptive text.
+	* Returns `score`, `scoreThresholds`, `magnitude`.
+	*
+	* Typical description is in the form of
+	* '"(magnitude)" magnitude: score (score) out of (last element of scoreThresholds array)'.
+	*
+	* E.g. `"Medium" magnitude: score 5 out of 10`.
+	*
+	* If not defined, the title will default to the `label` prop.
+	*/
 	setLabelTitle: prop_types.default.func,
+	/**
+	* Styled smaller to better fit inline with text.
+	*/
 	small: prop_types.default.bool,
+	/**
+	* Override the default theme of the component.
+	* Useful if you want "invert" the component's theme.
+	*/
 	theme: prop_types.default.oneOf(["light", "dark"]),
+	/**
+	* If not defined, it will behave as `display:inline-block`.
+	*/
 	truncateValue: prop_types.default.oneOfType([prop_types.default.oneOf(["end", "start"]), prop_types.default.shape({
 		maxLength: prop_types.default.number,
 		front: prop_types.default.number,
 		back: prop_types.default.number
 	})]),
+	/**
+	* The value of the data.
+	*/
 	value: prop_types.default.string.isRequired,
+	/**
+	* Overrides the default title for the Decorator's value.
+	*/
 	valueTitle: prop_types.default.string
 };
-
 //#endregion
-Object.defineProperty(exports, 'DecoratorSingleButton', {
-  enumerable: true,
-  get: function () {
-    return DecoratorSingleButton;
-  }
-});
+Object.defineProperty(exports, "DecoratorSingleButton", {
+	enumerable: true,
+	get: function() {
+		return DecoratorSingleButton;
+	}
+});

package/lib/components/DelimitedList/DelimitedList.js

@@ -5,15 +5,14 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
-
 //#region src/components/DelimitedList/DelimitedList.tsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -49,11 +48,22 @@ DelimitedList.deprecated = {
 };
 DelimitedList.displayName = componentName;
 DelimitedList.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The character(s) used to separate the items.
+	*/
 	delimiter: prop_types.default.string,
+	/**
+	* Array of items to be listed.
+	*/
 	items: prop_types.default.arrayOf(prop_types.default.any),
+	/**
+	* Toggle the component's ability to truncate or not.
+	*/
 	truncate: prop_types.default.bool
 };
-
 //#endregion
-exports.DelimitedList = DelimitedList;
+exports.DelimitedList = DelimitedList;

package/lib/components/DescriptionList/DescriptionList.js

@@ -5,17 +5,16 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_constants = require('./constants.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_constants = require("./constants.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/DescriptionList/DescriptionList.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -55,16 +54,19 @@ DescriptionList.deprecated = {
 DescriptionList = require_settings.pkg.checkComponentEnabled(DescriptionList, componentName);
 DescriptionList.displayName = componentName;
 DescriptionList.propTypes = {
+	/** Specify if the type layout has a border */
 	border: prop_types.default.bool,
+	/** Provide the contents of the node */
 	children: prop_types.default.node,
+	/** Provide an optional class to be applied to the containing node */
 	className: prop_types.default.string,
+	/** Specify the size of the type layout, from a list of available sizes */
 	size: prop_types.default.oneOf(Object.values(require_constants.DescriptionListSize))
 };
-
 //#endregion
-Object.defineProperty(exports, 'DescriptionList', {
-  enumerable: true,
-  get: function () {
-    return DescriptionList;
-  }
-});
+Object.defineProperty(exports, "DescriptionList", {
+	enumerable: true,
+	get: function() {
+		return DescriptionList;
+	}
+});

package/lib/components/DescriptionList/DescriptionListBody.js

@@ -5,16 +5,15 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const require_runtime = require('../../_virtual/_rolldown/runtime.js');
-const require_index = require('../../node_modules/classnames/index.js');
-const require_settings = require('../../settings.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 prop_types = require_runtime.__toESM(prop_types);
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/DescriptionList/DescriptionListBody.jsx
 /**
 * Copyright IBM Corp. 2024, 2024
@@ -34,16 +33,17 @@ let DescriptionListBody = react.default.forwardRef(({ children, className, ...re
 	}, children);
 });
 DescriptionListBody.propTypes = {
+	/** Provide the contents of the node */
 	children: prop_types.default.node,
+	/** Provide an optional class to be applied to the containing node */
 	className: prop_types.default.string
 };
 DescriptionListBody = require_settings.pkg.checkComponentEnabled(DescriptionListBody, componentName);
 DescriptionListBody.displayName = componentName;
-
 //#endregion
-Object.defineProperty(exports, 'DescriptionListBody', {
-  enumerable: true,
-  get: function () {
-    return DescriptionListBody;
-  }
-});
+Object.defineProperty(exports, "DescriptionListBody", {
+	enumerable: true,
+	get: function() {
+		return DescriptionListBody;
+	}
+});