@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/Guidebanner/GuidebannerElementLink.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/Guidebanner/GuidebannerElementLink.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -41,9 +40,14 @@ const GuidebannerElementLink = react.default.forwardRef(({ children, className,
 });
 GuidebannerElementLink.displayName = componentName;
 GuidebannerElementLink.propTypes = {
+	/**
+	* Provide the contents of the GuidebannerElementLink.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string
 };
-
 //#endregion
-exports.GuidebannerElementLink = GuidebannerElementLink;
+exports.GuidebannerElementLink = GuidebannerElementLink;

package/lib/components/HTTPErrors/HTTPError403/HTTPError403.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_HTTPErrorSvg403 = require('../assets/HTTPErrorSvg403.js');
-const require_HTTPErrorContent = require('../HTTPErrorContent.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_HTTPErrorSvg403 = require("../assets/HTTPErrorSvg403.js");
+const require_HTTPErrorContent = require("../HTTPErrorContent.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/HTTPErrors/HTTPError403/HTTPError403.tsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -53,15 +52,36 @@ HTTPError403.deprecated = {
 };
 HTTPError403.displayName = componentName;
 HTTPError403.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.string,
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: prop_types.string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: prop_types.string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
+	/**@ts-ignore*/
 	links: (0, prop_types.arrayOf)((0, prop_types.shape)({
+		/**
+		* The text to display for the link
+		*/
 		text: prop_types.string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: prop_types.string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: prop_types.string.isRequired
 };
-
 //#endregion
-exports.HTTPError403 = HTTPError403;
+exports.HTTPError403 = HTTPError403;

package/lib/components/HTTPErrors/HTTPError404/HTTPError404.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_HTTPErrorContent = require('../HTTPErrorContent.js');
-const require_HTTPErrorSvg404 = require('../assets/HTTPErrorSvg404.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_HTTPErrorContent = require("../HTTPErrorContent.js");
+const require_HTTPErrorSvg404 = require("../assets/HTTPErrorSvg404.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/HTTPErrors/HTTPError404/HTTPError404.tsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -53,15 +52,36 @@ HTTPError404.deprecated = {
 };
 HTTPError404.displayName = componentName;
 HTTPError404.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.string,
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: prop_types.string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: prop_types.string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
+	/**@ts-ignore */
 	links: (0, prop_types.arrayOf)((0, prop_types.shape)({
+		/**
+		* The text to display for the link
+		*/
 		text: prop_types.string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: prop_types.string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: prop_types.string.isRequired
 };
-
 //#endregion
-exports.HTTPError404 = HTTPError404;
+exports.HTTPError404 = HTTPError404;

package/lib/components/HTTPErrors/HTTPErrorContent.js

@@ -5,13 +5,12 @@
  * 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_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
 let _carbon_react = require("@carbon/react");
-
 //#region src/components/HTTPErrors/HTTPErrorContent.jsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -32,15 +31,32 @@ let HTTPErrorContent = ({ description, errorCodeLabel, title, links }) => {
 };
 HTTPErrorContent.displayName = componentName;
 HTTPErrorContent.propTypes = {
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: prop_types.string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: prop_types.string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
 	links: (0, prop_types.arrayOf)((0, prop_types.shape)({
 		..._carbon_react.Link.propTypes,
+		/**
+		* The text to display for the link
+		*/
 		text: prop_types.string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: prop_types.string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: prop_types.string.isRequired
 };
-
 //#endregion
-exports.HTTPErrorContent = HTTPErrorContent;
+exports.HTTPErrorContent = HTTPErrorContent;

package/lib/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.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_HTTPErrorContent = require('../HTTPErrorContent.js');
-const require_HTTPErrorSvgOther = require('../assets/HTTPErrorSvgOther.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_HTTPErrorContent = require("../HTTPErrorContent.js");
+const require_HTTPErrorSvgOther = require("../assets/HTTPErrorSvgOther.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/HTTPErrors/HTTPErrorOther/HTTPErrorOther.tsx
 /**
 * Copyright IBM Corp. 2021, 2021
@@ -53,15 +52,36 @@ HTTPErrorOther.deprecated = {
 };
 HTTPErrorOther.displayName = componentName;
 HTTPErrorOther.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node
+	*/
 	className: prop_types.string,
+	/**
+	* String that will provide the description for the HTTP error code
+	*/
 	description: prop_types.string.isRequired,
+	/**
+	* String that will describe the error that occurred
+	*/
 	errorCodeLabel: prop_types.string.isRequired,
+	/**
+	* Links that will display for extra context when receiving particular errors
+	*/
+	/**@ts-ignore */
 	links: (0, prop_types.arrayOf)((0, prop_types.shape)({
+		/**
+		* The text to display for the link
+		*/
 		text: prop_types.string.isRequired,
+		/**
+		* The link's destination
+		*/
 		href: prop_types.string.isRequired
 	})),
+	/**
+	* This will be for the main title of the HTTP error component
+	*/
 	title: prop_types.string.isRequired
 };
-
 //#endregion
-exports.HTTPErrorOther = HTTPErrorOther;
+exports.HTTPErrorOther = HTTPErrorOther;

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

@@ -5,12 +5,11 @@
  * 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_runtime = require("../../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/HTTPErrors/assets/HTTPErrorSvg403.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -996,6 +995,5 @@ HTTPErrorSvg403.propTypes = {
 	className: prop_types.string,
 	title: prop_types.string
 };
-
 //#endregion
-exports.HTTPErrorSvg403 = HTTPErrorSvg403;
+exports.HTTPErrorSvg403 = HTTPErrorSvg403;

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

@@ -5,12 +5,11 @@
  * 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_runtime = require("../../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/HTTPErrors/assets/HTTPErrorSvg404.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -795,6 +794,5 @@ HTTPErrorSvg404.propTypes = {
 	className: prop_types.string,
 	title: prop_types.string
 };
-
 //#endregion
-exports.HTTPErrorSvg404 = HTTPErrorSvg404;
+exports.HTTPErrorSvg404 = HTTPErrorSvg404;

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

@@ -5,12 +5,11 @@
  * 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_runtime = require("../../../_virtual/_rolldown/runtime.js");
+const require_settings = require("../../../settings.js");
 let react = require("react");
 react = require_runtime.__toESM(react);
 let prop_types = require("prop-types");
-
 //#region src/components/HTTPErrors/assets/HTTPErrorSvgOther.jsx
 /**
 * Copyright IBM Corp. 2020, 2021
@@ -846,6 +845,5 @@ HTTPErrorSvgOther.propTypes = {
 	className: prop_types.string,
 	title: prop_types.string
 };
-
 //#endregion
-exports.HTTPErrorSvgOther = HTTPErrorSvgOther;
+exports.HTTPErrorSvgOther = HTTPErrorSvgOther;

package/lib/components/ImportModal/ImportModal.js

@@ -5,19 +5,18 @@
  * 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_usePortalTarget = require('../../global/js/hooks/usePortalTarget.js');
-const require_uuidv4 = require('../../global/js/utils/uuidv4.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_usePortalTarget = require("../../global/js/hooks/usePortalTarget.js");
+const require_uuidv4 = require("../../global/js/utils/uuidv4.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");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/ImportModal/ImportModal.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -178,37 +177,123 @@ const ImportModal = (0, react.forwardRef)(({ accept = [], className, defaultErro
 	}, primaryButtonText))));
 });
 ImportModal.propTypes = {
+	/**
+	* Specifies the file types that are valid for importing
+	*/
 	accept: prop_types.default.array,
+	/**
+	* Optional class name
+	*/
 	className: prop_types.default.string,
+	/**
+	* The default message shown for an import error
+	*/
 	defaultErrorBody: prop_types.default.string.isRequired,
+	/**
+	* The default header that is displayed to show an error message
+	*/
 	defaultErrorHeader: prop_types.default.string.isRequired,
+	/**
+	* Content that is displayed inside the modal
+	*/
 	description: prop_types.default.string,
+	/**
+	* Optional error body to display specifically for a fetch error
+	*/
 	fetchErrorBody: prop_types.default.string,
+	/**
+	* Optional error header to display specifically for a fetch error
+	*/
 	fetchErrorHeader: prop_types.default.string,
+	/**
+	* Header for the drag and drop box
+	*/
 	fileDropHeader: prop_types.default.string,
+	/**
+	* Label for the drag and drop box
+	*/
 	fileDropLabel: prop_types.default.string,
+	/**
+	* Label that appears when a file is uploaded to show number of files (1 / 1)
+	*/
 	fileUploadLabel: prop_types.default.string,
+	/**
+	* Hide input label
+	*/
 	hideInputLabel: prop_types.default.bool,
+	/**
+	* Button icon for import by url button
+	*/
 	inputButtonIcon: prop_types.default.bool,
+	/**
+	* Button text for import by url button
+	*/
 	inputButtonText: prop_types.default.string.isRequired,
+	/**
+	* ID for text input
+	*/
 	inputId: prop_types.default.string,
+	/**
+	* Header to display above import by url
+	*/
 	inputLabel: prop_types.default.string.isRequired,
+	/**
+	* Placeholder for text input
+	*/
 	inputPlaceholder: prop_types.default.string,
+	/**
+	* Optional error message to display specifically for a invalid file type error
+	*/
 	invalidFileTypeErrorBody: prop_types.default.string,
+	/**
+	* Optional error header to display specifically for a invalid file type error
+	*/
 	invalidFileTypeErrorHeader: prop_types.default.string,
+	/**
+	* Description for delete file icon
+	*/
 	invalidIconDescription: prop_types.default.string,
+	/**
+	* File size limit in bytes
+	*/
 	maxFileSize: prop_types.default.number,
+	/**
+	* Optional error message to display specifically for a max file size error
+	*/
 	maxFileSizeErrorBody: prop_types.default.string,
+	/**
+	* Optional error header to display specifically for a max file size error
+	*/
 	maxFileSizeErrorHeader: prop_types.default.string,
+	/**
+	* Specify a handler for closing modal
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Specify a handler for "submitting" modal. Access the imported file via `file => {}`
+	*/
 	onRequestSubmit: prop_types.default.func.isRequired,
+	/**
+	* Specify whether the Modal is currently open
+	*/
 	open: prop_types.default.bool.isRequired,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: prop_types.default.node,
+	/**
+	* Specify the text for the primary button
+	*/
 	primaryButtonText: prop_types.default.string.isRequired,
+	/**
+	* Specify the text for the secondary button
+	*/
 	secondaryButtonText: prop_types.default.string.isRequired,
+	/**
+	* The text displayed at the top of the modal
+	*/
 	title: prop_types.default.string.isRequired
 };
 ImportModal.displayName = componentName;
-
 //#endregion
-exports.ImportModal = ImportModal;
+exports.ImportModal = ImportModal;

package/lib/components/InlineTip/InlineTip.js

@@ -5,19 +5,18 @@
  * 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_uuidv4 = require('../../global/js/utils/uuidv4.js');
-const require_utils = require('./utils.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_uuidv4 = require("../../global/js/utils/uuidv4.js");
+const require_utils = require("./utils.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");
 let _carbon_react_icons = require("@carbon/react/icons");
-
 //#region src/components/InlineTip/InlineTip.tsx
 /**
 * Copyright IBM Corp. 2023, 2023
@@ -89,21 +88,75 @@ const InlineTip = react.default.forwardRef(({ action, children, className, close
 });
 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: prop_types.default.node,
+	/**
+	* Provide the contents of the InlineTip.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Tooltip text and aria label for the Close button icon.
+	*/
 	closeIconDescription: prop_types.default.string,
+	/**
+	* The label for the collapse button.
+	* This button is not visible if `media` is specified.
+	*/
 	collapseButtonLabel: prop_types.default.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: prop_types.default.bool,
+	/**
+	* The label for the expand button.
+	* This button is not visible if `media` is specified.
+	*/
 	expandButtonLabel: prop_types.default.string,
+	/**
+	* Set to `true` to arrange the information in a format
+	* that is easier to read in a limited space.
+	*/
 	narrow: prop_types.default.bool,
+	/**
+	* Function to call when the tertiary button is clicked.
+	*/
 	onClick: prop_types.default.func,
+	/**
+	* Function to call when the InlineTip is closed via the "X" button.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Optional prop to render any media like images or animated media.
+	*/
 	renderMedia: prop_types.default.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: prop_types.default.string,
+	/**
+	* The title of the InlineTip.
+	*/
 	title: prop_types.default.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: prop_types.default.bool
 };
-
 //#endregion
-exports.InlineTip = InlineTip;
+exports.InlineTip = InlineTip;

package/lib/components/InlineTip/InlineTipButton.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/InlineTip/InlineTipButton.tsx
 /**
 * Copyright IBM Corp. 2023, 2024
@@ -40,9 +39,14 @@ const InlineTipButton = react.default.forwardRef(({ children, className, ...rest
 });
 InlineTipButton.displayName = componentName;
 InlineTipButton.propTypes = {
+	/**
+	* Provide the contents of the InlineTipButton.
+	*/
 	children: prop_types.default.node.isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string
 };
-
 //#endregion
-exports.InlineTipButton = InlineTipButton;
+exports.InlineTipButton = InlineTipButton;