@carbon/ibm-products
Version:
Carbon for IBM Products
206 lines (194 loc) • 7.96 kB
JavaScript
/**
* Copyright IBM Corp. 2020, 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.
*/
'use strict';
var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
var React = require('react');
var index = require('../../_virtual/index.js');
var cx = require('classnames');
var settings = require('../../settings.js');
var react = require('@carbon/react');
var CreateFullPage = require('./CreateFullPage.js');
var pconsole = require('../../global/js/utils/pconsole.js');
var usePreviousValue = require('../../global/js/hooks/usePreviousValue.js');
var useRetrieveStepData = require('../../global/js/hooks/useRetrieveStepData.js');
const componentName = 'CreateFullPageStep';
const blockClass = `${settings.pkg.prefix}--create-full-page__step`;
// Default values for props
const defaults = {
includeStep: true
};
// Try to specify the hasFieldset and fieldsetLegendText Typescript requirements.
// Basically, fieldsetLegendText should only be specified when hasFieldset is true.
// And usually, hasFieldset won't be specified at all unless it's being set to true.
exports.CreateFullPageStep = /*#__PURE__*/React.forwardRef((_ref, ref) => {
let {
// The component props, in alphabetical order (for consistency).
children,
className,
subtitle,
description,
disableSubmit,
includeStep = defaults.includeStep,
introStep,
invalid,
title,
hasFieldset,
fieldsetLegendText,
onNext,
onPrevious,
onMount,
secondaryLabel,
// Collect any other property values passed in.
...rest
} = _ref;
const stepsContext = React.useContext(CreateFullPage.StepsContext);
const stepNumber = React.useContext(CreateFullPage.StepNumberContext);
const [shouldIncludeStep, setShouldIncludeStep] = React.useState();
const previousState = usePreviousValue.usePreviousValue({
currentStep: stepsContext?.currentStep
});
useRetrieveStepData.useRetrieveStepData({
invalid,
stepsContext,
stepNumber,
introStep,
shouldIncludeStep,
secondaryLabel,
title
});
// This useEffect reports back the onMount value so that they can be used
// in the appropriate custom hooks.
React.useEffect(() => {
if (stepNumber === stepsContext?.currentStep && previousState?.currentStep !== stepsContext?.currentStep) {
stepsContext?.setOnMount(onMount);
}
}, [onMount, stepsContext, stepNumber, previousState?.currentStep]);
React.useEffect(() => {
setShouldIncludeStep(includeStep);
}, [includeStep, stepsContext, title]);
// Whenever we are the current step, supply our disableSubmit and onNext values to the
// steps container context so that it can manage the 'Next' button appropriately.
React.useEffect(() => {
if (stepNumber === stepsContext?.currentStep) {
stepsContext.setIsDisabled(disableSubmit);
stepsContext?.setOnNext(onNext); // needs to be updated here otherwise there could be stale state values from only initially setting onNext
stepsContext?.setOnPrevious(onPrevious);
}
}, [stepsContext, stepNumber, disableSubmit, onNext, onPrevious]);
const span = {
span: 50
}; // Half.
const renderDescription = () => {
if (description) {
const common = {
children: description,
className: `${blockClass}-description`,
...span
};
if (typeof description === 'string') {
return /*#__PURE__*/React.createElement(react.Column, _rollupPluginBabelHelpers.extends({}, common, {
as: "p"
}));
} else if (/*#__PURE__*/React.isValidElement(description)) {
return /*#__PURE__*/React.createElement(react.Column, _rollupPluginBabelHelpers.extends({}, common, {
as: "div"
}));
}
}
return null;
};
return stepsContext ? /*#__PURE__*/React.createElement(react.Section, _rollupPluginBabelHelpers.extends({}, rest, {
className: cx(blockClass, className, {
[`${blockClass}__step--hidden-step`]: stepNumber !== stepsContext?.currentStep,
[`${blockClass}__step--visible-step`]: stepNumber === stepsContext?.currentStep
}),
ref: ref
}), /*#__PURE__*/React.createElement(react.Grid, null, /*#__PURE__*/React.createElement(react.Column, span, /*#__PURE__*/React.createElement(react.Grid, null, /*#__PURE__*/React.createElement(react.Column, _rollupPluginBabelHelpers.extends({
className: `${blockClass}-title`,
as: react.Heading
}, span), title), subtitle && /*#__PURE__*/React.createElement(react.Column, _rollupPluginBabelHelpers.extends({
className: `${blockClass}-subtitle`,
as: "p"
}, span), subtitle), renderDescription()))), hasFieldset ? /*#__PURE__*/React.createElement(react.FormGroup, {
legendText: fieldsetLegendText,
className: `${blockClass}-fieldset`
}, children) : children) : 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`);
});
// Return a placeholder if not released and not enabled by feature flag
exports.CreateFullPageStep = settings.pkg.checkComponentEnabled(exports.CreateFullPageStep, componentName);
exports.CreateFullPageStep.propTypes = {
/**
* Content that shows in the CreateFullPage step
*/
children: index.default.node,
/**
* Sets an optional className to be added to the CreateFullPage step
*/
className: index.default.string,
/**
* Sets an optional description on the progress step component
*/
description: index.default.node,
/**
* This will conditionally disable the submit button in the multi step CreateFullPage
*/
disableSubmit: index.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: index.default.string.isRequired.if(_ref2 => {
let {
hasFieldset
} = _ref2;
return hasFieldset === true;
}),
/**
* This optional prop will render your form content inside of a fieldset html element
*/
hasFieldset: index.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: index.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: index.default.bool,
/**
* This optional prop will indicate an error icon on the progress indicator step item
*/
invalid: index.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: index.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: index.default.func,
/**
* Optional function to be called when you move to the previous step.
*/
onPrevious: index.default.func,
/**
* Sets the optional secondary label on the progress step component
*/
secondaryLabel: index.default.string,
/**
* Sets an optional subtitle on the progress step component
*/
subtitle: index.default.string,
/**
* Sets the title text for a create full page step
*/
title: index.default.node.isRequired
};