@carbon/ibm-products 2.0.0-rc.33 → 2.0.0-rc.38

package/es/components/CreateTearsheet/CreateTearsheet.js

@@ -0,0 +1,308 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["backButtonText", "cancelButtonText", "children", "className", "description", "influencerWidth", "initialStep", "label", "nextButtonText", "onClose", "onRequestSubmit", "open", "firstFocusElement", "submitButtonText", "title", "verticalPosition"];
+/**
+ * Copyright IBM Corp. 2021, 2022
+ *
+ * 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 React, { forwardRef, useState, useRef, createContext, useEffect } from 'react';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Form } from '@carbon/react';
+import wrapFocus from '../../global/js/utils/wrapFocus';
+import { TearsheetShell } from '../Tearsheet/TearsheetShell';
+import { CreateInfluencer } from '../CreateInfluencer';
+import { pkg } from '../../settings';
+import { usePreviousValue, useValidCreateStepCount, useResetCreateComponent, useCreateComponentFocus, useCreateComponentStepChange } from '../../global/js/hooks';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { lastIndexInArray } from '../../global/js/utils/lastIndexInArray';
+import { getNumberOfHiddenSteps } from '../../global/js/utils/getNumberOfHiddenSteps';
+var componentName = 'CreateTearsheet';
+var blockClass = "".concat(pkg.prefix, "--tearsheet-create");
+
+// This is a general context for the steps container
+// containing information about the state of the container
+// and providing some callback methods for steps to use
+export var StepsContext = /*#__PURE__*/createContext(null);
+
+// This is a context supplied separately to each step in the container
+// to let it know what number it is in the sequence of steps
+export var StepNumberContext = /*#__PURE__*/createContext(-1);
+
+// Default values for props
+var defaults = {
+  verticalPosition: 'normal',
+  influencerWidth: 'narrow'
+};
+export var CreateTearsheet = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var backButtonText = _ref.backButtonText,
+    cancelButtonText = _ref.cancelButtonText,
+    children = _ref.children,
+    className = _ref.className,
+    description = _ref.description,
+    _ref$influencerWidth = _ref.influencerWidth,
+    influencerWidth = _ref$influencerWidth === void 0 ? defaults.influencerWidth : _ref$influencerWidth,
+    initialStep = _ref.initialStep,
+    label = _ref.label,
+    nextButtonText = _ref.nextButtonText,
+    onClose = _ref.onClose,
+    onRequestSubmit = _ref.onRequestSubmit,
+    open = _ref.open,
+    firstFocusElement = _ref.firstFocusElement,
+    submitButtonText = _ref.submitButtonText,
+    title = _ref.title,
+    _ref$verticalPosition = _ref.verticalPosition,
+    verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var _useState = useState([]),
+    _useState2 = _slicedToArray(_useState, 2),
+    createTearsheetActions = _useState2[0],
+    setCreateTearsheetActions = _useState2[1];
+  var _useState3 = useState(false),
+    _useState4 = _slicedToArray(_useState3, 2),
+    shouldViewAll = _useState4[0],
+    setShouldViewAll = _useState4[1];
+  var _useState5 = useState(0),
+    _useState6 = _slicedToArray(_useState5, 2),
+    currentStep = _useState6[0],
+    setCurrentStep = _useState6[1];
+  var _useState7 = useState(false),
+    _useState8 = _slicedToArray(_useState7, 2),
+    isSubmitting = _useState8[0],
+    setIsSubmitting = _useState8[1];
+  var _useState9 = useState(false),
+    _useState10 = _slicedToArray(_useState9, 2),
+    isDisabled = _useState10[0],
+    setIsDisabled = _useState10[1];
+  var _useState11 = useState(),
+    _useState12 = _slicedToArray(_useState11, 2),
+    onNext = _useState12[0],
+    _setOnNext = _useState12[1];
+  var _useState13 = useState(),
+    _useState14 = _slicedToArray(_useState13, 2),
+    onMount = _useState14[0],
+    _setOnMount = _useState14[1];
+  var _useState15 = useState([]),
+    _useState16 = _slicedToArray(_useState15, 2),
+    stepData = _useState16[0],
+    setStepData = _useState16[1];
+  var _useState17 = useState(1),
+    _useState18 = _slicedToArray(_useState17, 2),
+    firstIncludedStep = _useState18[0],
+    setFirstIncludedStep = _useState18[1];
+  var _useState19 = useState(null),
+    _useState20 = _slicedToArray(_useState19, 2),
+    lastIncludedStep = _useState20[0],
+    setLastIncludedStep = _useState20[1];
+  var previousState = usePreviousValue({
+    currentStep: currentStep,
+    open: open
+  });
+  var contentRef = useRef();
+  useEffect(function () {
+    var firstItem = stepData.findIndex(function (item) {
+      return item === null || item === void 0 ? void 0 : item.shouldIncludeStep;
+    }) + 1;
+    var lastItem = lastIndexInArray(stepData, 'shouldIncludeStep', true);
+    if (firstItem !== firstIncludedStep) {
+      setFirstIncludedStep(firstItem);
+    }
+    if (lastItem !== lastIncludedStep) {
+      setLastIncludedStep(lastItem);
+    }
+    if (open && initialStep) {
+      var numberOfHiddenSteps = getNumberOfHiddenSteps(stepData, initialStep);
+      setCurrentStep(Number(initialStep + numberOfHiddenSteps));
+    }
+  }, [stepData, firstIncludedStep, lastIncludedStep, initialStep, open]);
+  useCreateComponentFocus({
+    previousState: previousState,
+    currentStep: currentStep,
+    blockClass: blockClass,
+    onMount: onMount,
+    firstFocusElement: firstFocusElement
+  });
+  useValidCreateStepCount(stepData.length, componentName);
+  useResetCreateComponent({
+    firstIncludedStep: firstIncludedStep,
+    previousState: previousState,
+    open: open,
+    setCurrentStep: setCurrentStep,
+    stepData: stepData,
+    initialStep: initialStep,
+    totalSteps: stepData === null || stepData === void 0 ? void 0 : stepData.length,
+    componentName: componentName
+  });
+  useCreateComponentStepChange({
+    firstIncludedStep: firstIncludedStep,
+    lastIncludedStep: lastIncludedStep,
+    stepData: stepData,
+    onNext: onNext,
+    isSubmitDisabled: isDisabled,
+    setCurrentStep: setCurrentStep,
+    setIsSubmitting: setIsSubmitting,
+    setShouldViewAll: setShouldViewAll,
+    onClose: onClose,
+    onRequestSubmit: onRequestSubmit,
+    componentName: componentName,
+    currentStep: currentStep,
+    shouldViewAll: shouldViewAll,
+    backButtonText: backButtonText,
+    cancelButtonText: cancelButtonText,
+    submitButtonText: submitButtonText,
+    nextButtonText: nextButtonText,
+    isSubmitting: isSubmitting,
+    componentBlockClass: blockClass,
+    setCreateComponentActions: setCreateTearsheetActions
+  });
+
+  // adds focus trap functionality
+  /* istanbul ignore next */
+  var handleBlur = function handleBlur(_ref2) {
+    var oldActiveNode = _ref2.target,
+      currentActiveNode = _ref2.relatedTarget;
+    var visibleStepInnerContent = document.querySelector(".".concat(pkg.prefix, "--tearsheet__body"));
+    if (open && visibleStepInnerContent) {
+      wrapFocus({
+        bodyNode: visibleStepInnerContent,
+        currentActiveNode: currentActiveNode,
+        oldActiveNode: oldActiveNode
+      });
+    }
+  };
+  return /*#__PURE__*/React.createElement(TearsheetShell, _extends({}, rest, getDevtoolsProps(componentName), {
+    actions: createTearsheetActions,
+    className: cx(blockClass, className),
+    description: description,
+    hasCloseIcon: false,
+    influencer: /*#__PURE__*/React.createElement(CreateInfluencer, {
+      currentStep: currentStep,
+      stepData: stepData
+    }),
+    influencerPosition: "left",
+    influencerWidth: influencerWidth,
+    label: label,
+    onClose: onClose,
+    open: open,
+    size: "wide",
+    title: title,
+    verticalPosition: verticalPosition,
+    ref: ref
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__content"),
+    onBlur: handleBlur,
+    ref: contentRef
+  }, /*#__PURE__*/React.createElement(Form, null, /*#__PURE__*/React.createElement(StepsContext.Provider, {
+    value: {
+      currentStep: currentStep,
+      setIsDisabled: setIsDisabled,
+      setOnNext: function setOnNext(fn) {
+        return _setOnNext(function () {
+          return fn;
+        });
+      },
+      setOnMount: function setOnMount(fn) {
+        return _setOnMount(function () {
+          return fn;
+        });
+      },
+      setStepData: setStepData,
+      stepData: stepData
+    }
+  }, React.Children.map(children, function (child, index) {
+    return /*#__PURE__*/React.createElement(StepNumberContext.Provider, {
+      value: index + 1
+    }, child);
+  })))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CreateTearsheet = pkg.checkComponentEnabled(CreateTearsheet, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+CreateTearsheet.displayName = componentName;
+
+// Note that the descriptions here should be kept in sync with those for the
+// corresponding props for TearsheetNarrow and TearsheetShell components.
+CreateTearsheet.propTypes = {
+  /**
+   * The back button text
+   */
+  backButtonText: PropTypes.string.isRequired,
+  /**
+   * The cancel button text
+   */
+  cancelButtonText: PropTypes.string.isRequired,
+  /**
+   * The main content of the tearsheet
+   */
+  children: PropTypes.node,
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: PropTypes.string,
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: PropTypes.node,
+  /**
+   * Specifies elements to focus on first on render.
+   */
+  firstFocusElement: PropTypes.string,
+  /**
+   * Used to set the size of the influencer
+   */
+  influencerWidth: PropTypes.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: PropTypes.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: PropTypes.node,
+  /**
+   * The next button text
+   */
+  nextButtonText: PropTypes.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: PropTypes.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: PropTypes.func.isRequired,
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: PropTypes.bool,
+  /**
+   * The submit button text
+   */
+  submitButtonText: PropTypes.string.isRequired,
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: PropTypes.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: PropTypes.oneOf(['normal', 'lower'])
+};

package/es/components/CreateTearsheet/CreateTearsheetDivider.js

@@ -0,0 +1,33 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className"];
+/**
+ * Copyright IBM Corp. 2021, 2021
+ *
+ * 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 React, { forwardRef } from 'react';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { pkg } from '../../settings';
+var componentName = 'CreateTearsheetDivider';
+var blockClass = "".concat(pkg.prefix, "--tearsheet-create__section--divider");
+export var CreateTearsheetDivider = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/React.createElement("span", _extends({}, rest, {
+    ref: ref,
+    className: cx(blockClass, className)
+  }));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CreateTearsheetDivider = pkg.checkComponentEnabled(CreateTearsheetDivider, componentName);
+CreateTearsheetDivider.propTypes = {
+  /**
+   * Sets an optional className to be added to the tearsheet step
+   */
+  className: PropTypes.string
+};

package/es/components/CreateTearsheet/CreateTearsheetStep.js

@@ -0,0 +1,174 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["children", "className", "description", "disableSubmit", "fieldsetLegendText", "hasFieldset", "includeStep", "introStep", "onNext", "onMount", "secondaryLabel", "subtitle", "title"];
+/**
+ * Copyright IBM Corp. 2021, 2023
+ *
+ * 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 React, { forwardRef, useContext, useEffect, useState } from 'react';
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { Column, FormGroup, Grid } from '@carbon/react';
+import { StepsContext, StepNumberContext } from './CreateTearsheet';
+import { pkg } from '../../settings';
+import pconsole from '../../global/js/utils/pconsole';
+import { usePreviousValue, useRetrieveStepData } from '../../global/js/hooks';
+var componentName = 'CreateTearsheetStep';
+var blockClass = "".concat(pkg.prefix, "--tearsheet-create__step");
+
+// Default values for props
+var defaults = {
+  hasFieldset: true,
+  includeStep: true
+};
+export var CreateTearsheetStep = /*#__PURE__*/forwardRef(function (_ref, ref) {
+  var _cx;
+  var children = _ref.children,
+    className = _ref.className,
+    description = _ref.description,
+    disableSubmit = _ref.disableSubmit,
+    fieldsetLegendText = _ref.fieldsetLegendText,
+    _ref$hasFieldset = _ref.hasFieldset,
+    hasFieldset = _ref$hasFieldset === void 0 ? defaults.hasFieldset : _ref$hasFieldset,
+    _ref$includeStep = _ref.includeStep,
+    includeStep = _ref$includeStep === void 0 ? defaults.includeStep : _ref$includeStep,
+    introStep = _ref.introStep,
+    onNext = _ref.onNext,
+    onMount = _ref.onMount,
+    secondaryLabel = _ref.secondaryLabel,
+    subtitle = _ref.subtitle,
+    title = _ref.title,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var stepsContext = useContext(StepsContext);
+  var stepNumber = useContext(StepNumberContext);
+  var _useState = useState(),
+    _useState2 = _slicedToArray(_useState, 2),
+    shouldIncludeStep = _useState2[0],
+    setShouldIncludeStep = _useState2[1];
+  var previousState = usePreviousValue({
+    currentStep: stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.currentStep
+  });
+  useRetrieveStepData({
+    stepsContext: stepsContext,
+    stepNumber: stepNumber,
+    introStep: introStep,
+    shouldIncludeStep: shouldIncludeStep,
+    secondaryLabel: secondaryLabel,
+    title: title
+  });
+
+  // This useEffect reports back the onMount value so that they can be used
+  // in the appropriate custom hooks.
+  useEffect(function () {
+    if (stepNumber === (stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.currentStep) && (previousState === null || previousState === void 0 ? void 0 : previousState.currentStep) !== (stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.currentStep)) {
+      stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.setOnMount(onMount);
+    }
+  }, [onMount, stepsContext, stepNumber, previousState === null || previousState === void 0 ? void 0 : previousState.currentStep]);
+
+  // Used to take the `includeStep` prop and use it as a local state value
+  useEffect(function () {
+    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.
+  useEffect(function () {
+    if (stepNumber === (stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.currentStep)) {
+      stepsContext.setIsDisabled(disableSubmit);
+      stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.setOnNext(onNext); // needs to be updated here otherwise there could be stale state values from only initially setting onNext
+    }
+  }, [stepsContext, stepNumber, disableSubmit, onNext]);
+  return stepsContext ? /*#__PURE__*/React.createElement(Grid, _extends({}, rest, {
+    className: cx(blockClass, className, (_cx = {}, _defineProperty(_cx, "".concat(blockClass, "__step--hidden-step"), stepNumber !== (stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.currentStep)), _defineProperty(_cx, "".concat(blockClass, "__step--visible-step"), stepNumber === (stepsContext === null || stepsContext === void 0 ? void 0 : stepsContext.currentStep)), _cx)),
+    ref: ref
+  }), /*#__PURE__*/React.createElement(Column, {
+    xlg: 12,
+    lg: 12,
+    md: 8,
+    sm: 4
+  }, /*#__PURE__*/React.createElement("h4", {
+    className: "".concat(blockClass, "--title")
+  }, title), subtitle && /*#__PURE__*/React.createElement("h6", {
+    className: "".concat(blockClass, "--subtitle")
+  }, subtitle), description && /*#__PURE__*/React.createElement("p", {
+    className: "".concat(blockClass, "--description")
+  }, description)), /*#__PURE__*/React.createElement(Column, {
+    span: 100
+  }, hasFieldset ? /*#__PURE__*/React.createElement(FormGroup, {
+    legendText: fieldsetLegendText,
+    className: "".concat(blockClass, "--fieldset")
+  }, children) : children)) : pconsole.warn("You have tried using a ".concat(componentName, " component outside of a CreateTearsheet. This is not allowed. ").concat(componentName, "s should always be children of the CreateTearsheet"));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+CreateTearsheetStep = pkg.checkComponentEnabled(CreateTearsheetStep, componentName);
+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.string,
+  /**
+   * This will conditionally disable the submit button in the multi step Tearsheet
+   */
+  disableSubmit: PropTypes.bool,
+  /**
+   * 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.
+   */
+  fieldsetLegendText: PropTypes.string.isRequired.if(function (_ref2) {
+    var hasFieldset = _ref2.hasFieldset;
+    return !!hasFieldset;
+  }),
+  /**
+   * 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.
+   */
+  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,
+  /**
+   * 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 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 CreateTearsheet will handle the submitting state of the next button.
+   */
+  onNext: PropTypes.func,
+  /**
+   * 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
+};

package/es/components/CreateTearsheet/index.js

@@ -0,0 +1,10 @@
+/**
+ * Copyright IBM Corp. 2021, 2021
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+export { CreateTearsheet } from './CreateTearsheet';
+export { CreateTearsheetStep } from './CreateTearsheetStep';
+export { CreateTearsheetDivider } from './CreateTearsheetDivider';