@carbon/ibm-products
Version:
Carbon for IBM Products
212 lines (210 loc) • 8.51 kB
JavaScript
/**
* Copyright IBM Corp. 2020, 2026
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import { __toESM } from "../../_virtual/_rolldown/runtime.js";
import { require_classnames } from "../../node_modules/classnames/index.js";
import pconsole_default from "../../global/js/utils/pconsole.js";
import { pkg } from "../../settings.js";
import { usePreviousValue } from "../../global/js/hooks/usePreviousValue.js";
import { useRetrieveStepData } from "../../global/js/hooks/useRetrieveStepData.js";
import { StepNumberContext, StepsContext } from "./CreateTearsheet.js";
import React, { forwardRef, isValidElement, useContext, useEffect, useRef, useState } from "react";
import PropTypes from "prop-types";
import { Column, FormGroup, Grid } from "@carbon/react";
//#region src/components/CreateTearsheet/CreateTearsheetStep.tsx
/**
* Copyright IBM Corp. 2021, 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.
*/
var import_classnames = /* @__PURE__ */ __toESM(require_classnames());
const componentName = "CreateTearsheetStep";
const blockClass = `${pkg.prefix}--tearsheet-create__step`;
const defaults = {
hasFieldset: true,
includeStep: true
};
const CreateTearsheetStep = forwardRef(({ children, className, description, disableSubmit, experimentalSecondarySubmit, fieldsetLegendText, fieldsetLegendId, hasFieldset = defaults.hasFieldset, includeStep = defaults.includeStep, introStep, invalid, onMount, onNext, onPrevious, secondaryButtonDisabled, secondaryLabel, subtitle, title, ...rest }, ref) => {
const localRef = useRef(null);
const stepRef = ref || localRef;
const stepRefValue = stepRef.current;
const stepsContext = useContext(StepsContext);
const stepNumber = useContext(StepNumberContext);
const [shouldIncludeStep, setShouldIncludeStep] = useState(includeStep);
const previousState = usePreviousValue({ currentStep: stepsContext?.currentStep });
useRetrieveStepData({
stepsContext,
stepNumber,
introStep: !!introStep,
shouldIncludeStep,
secondaryLabel: secondaryLabel || "",
title,
invalid: !!invalid
});
useEffect(() => {
if (stepNumber === stepsContext?.currentStep && previousState?.currentStep !== stepsContext?.currentStep) {
stepsContext?.setOnMount(onMount);
stepsContext?.setExperimentalSecondarySubmit(experimentalSecondarySubmit);
}
}, [
onMount,
experimentalSecondarySubmit,
stepsContext,
stepNumber,
previousState?.currentStep
]);
useEffect(() => {
setShouldIncludeStep(includeStep);
}, [
includeStep,
stepsContext,
title
]);
useEffect(() => {
if (stepNumber === stepsContext?.currentStep) {
stepsContext.setIsDisabled(!!disableSubmit);
stepsContext?.setOnNext(onNext);
stepsContext?.setOnPrevious(onPrevious);
stepsContext?.setSecondaryButtonDisabled?.(!!secondaryButtonDisabled);
stepsContext?.setExperimentalSecondarySubmit(experimentalSecondarySubmit);
}
}, [
stepsContext,
stepNumber,
disableSubmit,
onNext,
onPrevious,
secondaryButtonDisabled,
stepRef,
stepRefValue,
experimentalSecondarySubmit
]);
const renderDescription = () => {
if (description) {
if (typeof description === "string") return /* @__PURE__ */ React.createElement("p", { className: `${blockClass}--description` }, description);
if (isValidElement(description)) return /* @__PURE__ */ React.createElement("div", { className: `${blockClass}--description` }, description);
}
return null;
};
return stepsContext ? /* @__PURE__ */ React.createElement("div", {
ref: stepRef,
inert: stepNumber !== stepsContext?.currentStep
}, /* @__PURE__ */ React.createElement(Grid, {
...rest,
className: (0, import_classnames.default)(blockClass, className, {
[`${blockClass}__step--hidden-step`]: stepNumber !== stepsContext?.currentStep,
[`${blockClass}__step--visible-step`]: stepNumber === stepsContext?.currentStep
})
}, /* @__PURE__ */ React.createElement(Column, {
xlg: 12,
lg: 12,
md: 8,
sm: 4
}, /* @__PURE__ */ React.createElement("h4", { className: `${blockClass}--title` }, title), subtitle && /* @__PURE__ */ React.createElement("h5", { className: `${blockClass}--subtitle` }, subtitle), renderDescription()), /* @__PURE__ */ React.createElement(Column, { span: 100 }, hasFieldset ? /* @__PURE__ */ React.createElement(FormGroup, {
legendText: fieldsetLegendText,
className: `${blockClass}--fieldset`,
legendId: fieldsetLegendId
}, children) : children))) : pconsole_default.warn(`You have tried using a ${componentName} component outside of a CreateTearsheet. This is not allowed. ${componentName}s should always be children of the CreateTearsheet`);
});
CreateTearsheetStep.propTypes = {
/**
* Content that shows in the tearsheet step
*/
children: PropTypes.node,
/**
* Sets an optional className to be added to the tearsheet step
*/
className: PropTypes.string,
/**
* Sets an optional description on the step component
*/
description: PropTypes.node,
/**
* This will conditionally disable the submit button in the multi step Tearsheet
*/
disableSubmit: PropTypes.bool,
/**
* Configuration options for customizing the behavior of the experimentalSecondary submit button.
*
* @property {string} [labelText] - Optional text to replace the default button text.
* @property {boolean} [disabled] - If true, the button will be disabled and not clickable.
* @property {boolean} [hideSecondarySubmit] - If true, the button will be hidden from view.
* @property {() => void} [onClick] - Optional click handler function to be executed when the button is clicked.
*/
/**@ts-ignore*/
experimentalSecondarySubmit: PropTypes.shape({
labelText: PropTypes.string,
disabled: PropTypes.bool,
hideSecondarySubmit: PropTypes.bool,
onClick: PropTypes.func
}),
/**
* This is the required legend id that appears as the aria-labelledby of fieldset for accessibility purposes.
*/
/**@ts-ignore*/
fieldsetLegendId: PropTypes.node,
/**
* This is the required legend text that appears above a fieldset html element for accessibility purposes.
* You can set the `hasFieldset` prop to false if you have multiple fieldset elements or want to control the children of your Full Page's step content.
* Otherwise, use CSS to hide/remove this label text.
*/
/**@ts-ignore*/
fieldsetLegendText: PropTypes.string,
/**
* This optional prop will render your form content inside of a fieldset html element
* and is defaulted to true.
* You can set this prop to `false` if you have multiple fieldset elements or want to control the children of your Full Page's step content.
*/
/**@ts-ignore*/
hasFieldset: PropTypes.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: PropTypes.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: PropTypes.bool,
/**
* This optional prop will indicate an error icon on the progress indicator step item
*/
invalid: PropTypes.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: PropTypes.func,
/**
* Optional function to be called when you move to the next step.
* 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 CreateTearsheet will handle the submitting state of the next button.
*/
onNext: PropTypes.func,
/**
* Optional function to be called when you move to the previous step.
*/
onPrevious: PropTypes.func,
/**
* This will conditionally disable the secondary (Back) button in the multi step Tearsheet
*/
secondaryButtonDisabled: PropTypes.bool,
/**
* Sets the optional secondary label on the progress step component
*/
secondaryLabel: PropTypes.string,
/**
* Sets an optional subtitle on the step component
*/
subtitle: PropTypes.string,
/**
* Sets the title text for a tearsheet step
*/
title: PropTypes.node.isRequired
};
//#endregion
export { CreateTearsheetStep };