@carbon/ibm-products 2.89.0 → 2.90.0

package/lib/components/CreateFullPage/CreateFullPageStep.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_pconsole = require('../../global/js/utils/pconsole.js');
-const require_settings = require('../../settings.js');
-const require_usePreviousValue = require('../../global/js/hooks/usePreviousValue.js');
-const require_useRetrieveStepData = require('../../global/js/hooks/useRetrieveStepData.js');
-const require_CreateFullPage = require('./CreateFullPage.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_pconsole = require("../../global/js/utils/pconsole.js");
+const require_settings = require("../../settings.js");
+const require_usePreviousValue = require("../../global/js/hooks/usePreviousValue.js");
+const require_useRetrieveStepData = require("../../global/js/hooks/useRetrieveStepData.js");
+const require_CreateFullPage = require("./CreateFullPage.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/CreateFullPage/CreateFullPageStep.tsx
 /**
 * Copyright IBM Corp. 2021, 2025
@@ -111,22 +110,71 @@ const CreateFullPageStep = (0, react.forwardRef)(({ children, className, subtitl
 	}, children) : children) : require_pconsole.default.warn(`You have tried using a ${componentName} component outside of a CreateFullPage. This is not allowed. ${componentName}s should always be children of the CreateFullPage`);
 });
 CreateFullPageStep.propTypes = {
+	/**
+	* Content that shows in the CreateFullPage step
+	*/
 	children: prop_types.default.node,
+	/**
+	* Sets an optional className to be added to the CreateFullPage step
+	*/
 	className: prop_types.default.string,
+	/**
+	* Sets an optional description on the progress step component
+	*/
 	description: prop_types.default.node,
+	/**
+	* This will conditionally disable the submit button in the multi step CreateFullPage
+	*/
 	disableSubmit: prop_types.default.bool,
+	/**
+	* This is the legend text that appears above a fieldset html element for accessibility purposes. It is required when the optional `hasFieldset` prop is provided to a FullPageStep.
+	*/
+	/**@ts-ignore */
 	fieldsetLegendText: prop_types.default.string,
+	/**
+	* This optional prop will render your form content inside of a fieldset html element
+	*/
 	hasFieldset: prop_types.default.bool,
+	/**
+	* This prop is used to help track dynamic steps. If this value is `false` then the step is not included in the visible steps or the ProgressIndicator
+	* steps. If this value is `true` then the step will be included in the list of visible steps, as well as being included in the ProgressIndicator step list
+	*/
 	includeStep: prop_types.default.bool,
+	/**
+	* This prop can be used on the first step to mark it as an intro step, which will not render the progress indicator steps
+	*/
 	introStep: prop_types.default.bool,
+	/**
+	* This optional prop will indicate an error icon on the progress indicator step item
+	*/
 	invalid: prop_types.default.bool,
+	/**
+	* Optional function to be called on initial mount of a step.
+	* For example, this can be used to fetch data that is required on a particular step.
+	*/
 	onMount: prop_types.default.func,
+	/**
+	* Optional function to be called on a step change.
+	* For example, this can be used to validate input fields before proceeding to the next step.
+	* This function can _optionally_ return a promise that is either resolved or rejected and the CreateFullPage will handle the submitting state of the next button.
+	*/
 	onNext: prop_types.default.func,
+	/**
+	* Optional function to be called when you move to the previous step.
+	*/
 	onPrevious: prop_types.default.func,
+	/**
+	* Sets the optional secondary label on the progress step component
+	*/
 	secondaryLabel: prop_types.default.string,
+	/**
+	* Sets an optional subtitle on the progress step component
+	*/
 	subtitle: prop_types.default.string,
+	/**
+	* Sets the title text for a create full page step
+	*/
 	title: prop_types.default.node.isRequired
 };
-
 //#endregion
-exports.CreateFullPageStep = CreateFullPageStep;
+exports.CreateFullPageStep = CreateFullPageStep;

package/lib/components/CreateInfluencer/CreateInfluencer.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');
-require('../../global/js/utils/props-helper.js');
+const require_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.js");
+require("../../global/js/utils/props-helper.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/CreateInfluencer/CreateInfluencer.tsx
 /**
 * Copyright IBM Corp. 2021, 2022
@@ -55,17 +54,31 @@ const CreateInfluencer = ({ className, currentStep, onClickStep, stepData, title
 };
 CreateInfluencer.displayName = componentName;
 CreateInfluencer.propTypes = {
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* Used to mark the current step on the ProgressIndicator component
+	*/
 	currentStep: prop_types.default.number.isRequired,
+	/**
+	* onChange event for Progress Indicator
+	*/
 	onClickStep: prop_types.default.func,
+	/**
+	* The step data that renders the progress items
+	*/
 	stepData: prop_types.default.arrayOf(prop_types.default.shape({
 		introStep: prop_types.default.bool,
 		secondaryLabel: prop_types.default.string,
 		shouldIncludeStep: prop_types.default.bool,
 		title: prop_types.default.node
 	})),
+	/**
+	* The main title of the full page, displayed in the influencer area.
+	*/
 	title: prop_types.default.string
 };
-
 //#endregion
-exports.CreateInfluencer = CreateInfluencer;
+exports.CreateInfluencer = CreateInfluencer;

package/lib/components/CreateModal/CreateModal.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_usePortalTarget = require('../../global/js/hooks/usePortalTarget.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");
 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/CreateModal/CreateModal.tsx
 /**
 * Copyright IBM Corp. 2021, 2025
@@ -67,21 +66,62 @@ const CreateModal = react.default.forwardRef((props, ref) => {
 	}, primaryButtonText))));
 });
 CreateModal.propTypes = {
+	/**
+	* Children refers to all form items within a form inside of the modal's body.
+	*/
 	children: prop_types.default.node,
+	/**
+	* Specify an optional className to be applied to the modal root node
+	*/
 	className: prop_types.default.string,
+	/**
+	* The description of the CreateModal serves to provide more information about the modal.
+	*/
 	description: prop_types.default.node.isRequired,
+	/**
+	* Specifies a boolean for disabling or enabling the primary button. This is important for form validation
+	* Returning `true` prevents the primary button from being clicked until required fields are completed.
+	*/
 	disableSubmit: prop_types.default.bool,
+	/**
+	* Specifies an optional handler which is called when the CreateModal
+	* is closed.
+	*/
 	onRequestClose: prop_types.default.func,
+	/**
+	* Specifies an optional handler which is called when the CreateModal
+	* primary button is pressed.
+	*/
 	onRequestSubmit: prop_types.default.func,
+	/**
+	* Specifies whether the CreateModal is open or not.
+	*/
 	open: prop_types.default.bool,
+	/**
+	* The DOM node the tearsheet should be rendered within. Defaults to document.body.
+	*/
 	portalTarget: prop_types.default.node,
+	/**
+	* Specifies the primary button's text in the modal.
+	*/
 	primaryButtonText: prop_types.default.string.isRequired,
+	/**
+	* Specifies the secondary button's text in the modal.
+	*/
 	secondaryButtonText: prop_types.default.string.isRequired,
+	/**
+	* Specifies which DOM element in the form should be focused.
+	*/
 	selectorPrimaryFocus: prop_types.default.string.isRequired,
+	/**
+	* The subtitle of the CreateModal is optional and serves to provide more information about the modal.
+	*/
 	subtitle: prop_types.default.node,
+	/**
+	* The title of the CreateModal is usually the product or service name.
+	*/
 	title: prop_types.default.node.isRequired
 };
 CreateModal.displayName = componentName;
-
 //#endregion
-exports.CreateModal = CreateModal;
+exports.CreateModal = CreateModal;

package/lib/components/CreateSidePanel/CreateSidePanel.js

@@ -5,18 +5,17 @@
  * 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_SidePanel = require('../SidePanel/SidePanel.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_SidePanel = require("../SidePanel/SidePanel.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/CreateSidePanel/CreateSidePanel.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -74,24 +73,81 @@ const CreateSidePanel = react.default.forwardRef(({ className, children, disable
 });
 CreateSidePanel.displayName = componentName;
 CreateSidePanel.propTypes = {
+	/**
+	* Sets the body content of the create side panel
+	*/
+	/**@ts-ignore*/
 	children: prop_types.default.oneOfType([prop_types.default.arrayOf(prop_types.default.node), prop_types.default.node]).isRequired,
+	/**
+	* Provide an optional class to be applied to the containing node.
+	*/
 	className: prop_types.default.string,
+	/**
+	* The description of the CreateSidePanel serves to provide more information about the form within the panel.
+	*/
 	description: prop_types.default.node,
+	/**
+	* Specifies a boolean for disabling or enabling the primary button. This is important for form validation
+	* Returning `true` prevents the primary button from being clicked until required fields are completed.
+	*/
 	disableSubmit: prop_types.default.bool,
+	/**
+	* Specifies an optional field that provides a additional context for a form
+	*/
 	formDescription: prop_types.default.node,
+	/**
+	* Specifies a required field that provides a title for a form
+	*/
 	formTitle: prop_types.default.node.isRequired,
+	/**
+	* Unique identifier
+	*/
 	id: prop_types.default.string,
+	/**
+	* Specifies an optional handler which is called when the CreateSidePanel
+	* is closed.
+	*/
 	onRequestClose: prop_types.default.func,
+	/**
+	* Specifies an optional handler which is called when the CreateSidePanel
+	* primary button is pressed.
+	*/
 	onRequestSubmit: prop_types.default.func,
+	/**
+	* Specifies whether the CreateSidePanel is open or not.
+	*/
+	/**@ts-ignore*/
 	open: prop_types.default.bool,
+	/**
+	* Specifies the primary button's text in the modal.
+	*/
 	primaryButtonText: prop_types.default.string.isRequired,
+	/**
+	* Specifies the secondary button's text in the modal.
+	*/
 	secondaryButtonText: prop_types.default.string.isRequired,
+	/**
+	* This is the selector to the element that contains all of the page content that will shrink if the panel is a slide in.
+	* This prop is required when using the `slideIn` variant of the side panel.
+	*/
 	selectorPageContent: prop_types.default.string.isRequired,
+	/**
+	* Specifies which DOM element in the form should be focused.
+	*/
+	/**@ts-ignore*/
 	selectorPrimaryFocus: prop_types.default.node.isRequired,
+	/**
+	*  **Experimental:** Provide a `Slug` component to be rendered inside the `SidePanel` component
+	*/
 	slug: prop_types.default.node,
+	/**
+	* The subtitle of the CreateSidePanel is optional and serves to provide more information about the modal.
+	*/
 	subtitle: prop_types.default.node,
+	/**
+	* The title of the CreateSidePanel is usually the product or service name.
+	*/
 	title: prop_types.default.string.isRequired
 };
-
 //#endregion
-exports.CreateSidePanel = CreateSidePanel;
+exports.CreateSidePanel = CreateSidePanel;

package/lib/components/CreateTearsheet/CreateTearsheet.js

@@ -5,26 +5,25 @@
  * 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_useCreateComponentFocus = require('../../global/js/hooks/useCreateComponentFocus.js');
-const require_useCreateComponentStepChange = require('../../global/js/hooks/useCreateComponentStepChange.js');
-const require_usePreviousValue = require('../../global/js/hooks/usePreviousValue.js');
-const require_getNumberOfHiddenSteps = require('../../global/js/utils/getNumberOfHiddenSteps.js');
-const require_useResetCreateComponent = require('../../global/js/hooks/useResetCreateComponent.js');
-const require_useValidCreateStepCount = require('../../global/js/hooks/useValidCreateStepCount.js');
-const require_devtools = require('../../global/js/utils/devtools.js');
-const require_props_helper = require('../../global/js/utils/props-helper.js');
-const require_CreateInfluencer = require('../CreateInfluencer/CreateInfluencer.js');
-const require_lastIndexInArray = require('../../global/js/utils/lastIndexInArray.js');
-const require_TearsheetShell = require('../Tearsheet/TearsheetShell.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_useCreateComponentFocus = require("../../global/js/hooks/useCreateComponentFocus.js");
+const require_useCreateComponentStepChange = require("../../global/js/hooks/useCreateComponentStepChange.js");
+const require_usePreviousValue = require("../../global/js/hooks/usePreviousValue.js");
+const require_getNumberOfHiddenSteps = require("../../global/js/utils/getNumberOfHiddenSteps.js");
+const require_useResetCreateComponent = require("../../global/js/hooks/useResetCreateComponent.js");
+const require_useValidCreateStepCount = require("../../global/js/hooks/useValidCreateStepCount.js");
+const require_devtools = require("../../global/js/utils/devtools.js");
+const require_props_helper = require("../../global/js/utils/props-helper.js");
+const require_CreateInfluencer = require("../CreateInfluencer/CreateInfluencer.js");
+const require_lastIndexInArray = require("../../global/js/utils/lastIndexInArray.js");
+const require_TearsheetShell = require("../Tearsheet/TearsheetShell.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/CreateTearsheet/CreateTearsheet.tsx
 /**
 * Copyright IBM Corp. 2021, 2025
@@ -87,9 +86,11 @@ const CreateTearsheet = (0, react.forwardRef)(({ backButtonText, cancelButtonTex
 	require_useResetCreateComponent.useResetCreateComponent({
 		firstIncludedStep,
 		previousState,
+		/**@ts-ignore */
 		open,
 		setCurrentStep,
 		stepData,
+		/**@ts-ignore */
 		initialStep,
 		totalSteps: stepData?.length,
 		componentName
@@ -104,6 +105,7 @@ const CreateTearsheet = (0, react.forwardRef)(({ backButtonText, cancelButtonTex
 		setCurrentStep,
 		setIsSubmitting,
 		setShouldViewAll,
+		/**@ts-ignore */
 		setLoadingPrevious,
 		loadingPrevious,
 		onClose,
@@ -167,32 +169,108 @@ const CreateTearsheet = (0, react.forwardRef)(({ backButtonText, cancelButtonTex
 	}, child))))));
 });
 CreateTearsheet.displayName = componentName;
-const deprecatedProps = { slug: require_props_helper.deprecateProp(prop_types.default.node, "Property replaced by `decorator`") };
+const deprecatedProps = { 
+/**
+*  @deprecated Property replaced by `decorator`
+*/
+slug: require_props_helper.deprecateProp(prop_types.default.node, "Property replaced by `decorator`") };
 CreateTearsheet.propTypes = {
+	/**
+	* The back button text
+	*/
 	backButtonText: prop_types.default.string.isRequired,
+	/**
+	* The cancel button text
+	*/
 	cancelButtonText: prop_types.default.string.isRequired,
+	/**
+	* The main content of the tearsheet
+	*/
 	children: prop_types.default.node,
+	/**
+	* An optional class or classes to be added to the outermost element.
+	*/
 	className: prop_types.default.string,
+	/**
+	*  Optional prop that allows you to pass any component.
+	*/
 	decorator: prop_types.default.node,
+	/**
+	* A description of the flow, displayed in the header area of the tearsheet.
+	*/
 	description: prop_types.default.node,
+	/**
+	* The experimentalSecondary submit button text
+	*/
 	experimentalSecondarySubmitText: prop_types.default.string,
+	/**
+	* Specifies elements to focus on first on render.
+	*/
 	firstFocusElement: prop_types.default.string,
+	/**
+	* To indicate an error occurred in the Tearsheet step
+	* Used to pass this value to TearsheetShell
+	*/
 	hasError: prop_types.default.bool,
+	/**
+	* Used to set the size of the influencer
+	*/
 	influencerWidth: prop_types.default.oneOf(["narrow", "wide"]),
+	/**
+	* This can be used to open the component to a step other than the first step.
+	* For example, a create flow was previously in progress, data was saved, and
+	* is now being completed.
+	*/
 	initialStep: prop_types.default.number,
+	/**
+	* A label for the tearsheet, displayed in the header area of the tearsheet
+	* to maintain context for the tearsheet (e.g. as the title changes from page
+	* to page of a multi-page task).
+	*/
 	label: prop_types.default.node,
+	/**
+	* The next button text
+	*/
 	nextButtonText: prop_types.default.string.isRequired,
+	/**
+	* An optional handler that is called when the user closes the tearsheet (by
+	* clicking the close button, if enabled, or clicking outside, if enabled).
+	* Returning `false` here prevents the modal from closing.
+	*/
 	onClose: prop_types.default.func,
+	/**
+	* Specify a handler for submitting the multi step tearsheet (final step).
+	* This function can _optionally_ return a promise that is either resolved or rejected and the CreateTearsheet will handle the submitting state of the create button.
+	*/
 	onRequestSubmit: prop_types.default.func.isRequired,
+	/**
+	* Specifies whether the tearsheet is currently open.
+	*/
 	open: prop_types.default.bool,
+	/**
+	* Specify a CSS selector that matches the DOM element that should be
+	* focused when the Modal opens.
+	*/
 	selectorPrimaryFocus: prop_types.default.string,
+	/**
+	* The submit button text
+	*/
 	submitButtonText: prop_types.default.string.isRequired,
+	/**
+	* The main title of the tearsheet, displayed in the header area.
+	*/
 	title: prop_types.default.node,
+	/**
+	* The position of the top of tearsheet in the viewport. The 'normal'
+	* position (the default) is a short distance down from the top of the
+	* viewport, leaving room at the top for a global header bar to show through
+	* from below. The 'lower' position provides a little extra room at the top
+	* to allow an action bar navigation or breadcrumbs to also show through.
+	*/
 	verticalPosition: prop_types.default.oneOf(["normal", "lower"]),
 	...deprecatedProps
 };
-
 //#endregion
 exports.CreateTearsheet = CreateTearsheet;
 exports.StepNumberContext = StepNumberContext;
-exports.StepsContext = StepsContext;
+exports.StepsContext = StepsContext;

package/lib/components/CreateTearsheet/CreateTearsheetDivider.js

@@ -5,14 +5,13 @@
  * 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_runtime = require("../../_virtual/_rolldown/runtime.js");
+const require_index = require("../../node_modules/classnames/index.js");
+const require_settings = require("../../settings.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/CreateTearsheet/CreateTearsheetDivider.tsx
 /**
 * Copyright IBM Corp. 2021, 2024
@@ -29,7 +28,10 @@ const CreateTearsheetDivider = (0, react.forwardRef)(({ className, ...rest }, re
 		className: (0, import_classnames.default)(blockClass, className)
 	});
 });
-CreateTearsheetDivider.propTypes = { className: prop_types.default.string };
-
+CreateTearsheetDivider.propTypes = { 
+/**
+* Sets an optional className to be added to the tearsheet divider
+*/
+className: prop_types.default.string };
 //#endregion
-exports.CreateTearsheetDivider = CreateTearsheetDivider;
+exports.CreateTearsheetDivider = CreateTearsheetDivider;