carbon-react 106.7.0 → 107.1.1

package/esm/components/multi-step-wizard/__spec__.js

@@ -1,191 +0,0 @@
-import React from "react";
-import TestUtils from "react-dom/test-utils";
-import { shallow } from "enzyme";
-import MultiStepWizard from "./multi-step-wizard";
-import MultiActionButton from "./../multi-action-button";
-import Button from "./../button";
-import { elementsTagTest, rootTagTest } from "../../__internal__/utils/helpers/tags/tags-specs";
-describe("MultiStepWizard", () => {
-  let instance,
-      spySubmitHandler = jasmine.createSpy("submitHandler");
-  beforeEach(() => {
-    instance = TestUtils.renderIntoDocument( /*#__PURE__*/React.createElement(MultiStepWizard, {
-      steps: [/*#__PURE__*/React.createElement("div", null, "Step 1"), /*#__PURE__*/React.createElement("div", null, "Step 2")],
-      onSubmit: spySubmitHandler
-    }));
-  });
-  describe("lifecycle", () => {
-    describe("componentWillMount", () => {
-      it("sets the states", () => {
-        spyOn(instance, "validateStepProps").and.returnValue({
-          currentStep: 1,
-          completed: false
-        });
-        expect(instance.state.currentStep).toEqual(1);
-        expect(instance.state.completed).toEqual(false);
-      });
-    });
-    describe("componentWillReceiveProps", () => {
-      it("sets the states", () => {
-        spyOn(instance, "validateStepProps").and.returnValue({
-          currentStep: 3,
-          completed: true
-        });
-        instance.UNSAFE_componentWillReceiveProps({});
-        expect(instance.state.currentStep).toEqual(3);
-        expect(instance.state.completed).toEqual(true);
-      });
-    });
-  });
-  describe("initialize", () => {
-    it("sets current step", () => {
-      expect(instance.state.currentStep).toBeTruthy();
-    });
-    it("sets completed to false", () => {
-      expect(instance.state.completed).toBeFalsy();
-    });
-  });
-  describe("totalSteps", () => {
-    it("returns the total number of steps", () => {
-      expect(instance.totalSteps).toEqual(2);
-    });
-  });
-  describe("validateStepProps", () => {
-    describe("when the completed prop equals to true", () => {
-      it("returns the valid props", () => {
-        let props = instance.validateStepProps({
-          completed: true,
-          steps: [1, 2, 3]
-        });
-        expect(props.currentStep).toEqual(3);
-        expect(props.completed).toEqual(true);
-      });
-    });
-    describe("when the currentStep prop is not number", () => {
-      it("returns the valid props", () => {
-        let props = instance.validateStepProps({
-          currentStep: "test",
-          steps: [1, 2, 3]
-        });
-        expect(props.currentStep).toEqual(1);
-        expect(props.completed).toEqual(false);
-      });
-    });
-    describe("when the currentStep prop is less than 1", () => {
-      it("returns the valid props", () => {
-        let props = instance.validateStepProps({
-          currentStep: 0,
-          steps: [1, 2, 3]
-        });
-        expect(props.currentStep).toEqual(1);
-        expect(props.completed).toEqual(false);
-      });
-    });
-    describe("when the currentStep prop is larger than the total of steps", () => {
-      it("returns the valid props", () => {
-        let props = instance.validateStepProps({
-          currentStep: 4,
-          steps: [1, 2, 3]
-        });
-        expect(props.currentStep).toEqual(1);
-        expect(props.completed).toEqual(false);
-      });
-    });
-    describe("when the currentStep prop is valid", () => {
-      it("returns the valid props", () => {
-        let props = instance.validateStepProps({
-          currentStep: 2,
-          steps: [1, 2, 3]
-        });
-        expect(props.currentStep).toEqual(2);
-        expect(props.completed).toEqual(false);
-      });
-    });
-  });
-  describe("next", () => {
-    beforeEach(() => {
-      spyOn(instance, "setState").and.callThrough();
-    });
-    describe("when current step is less than the total of steps", () => {
-      it("moves the step forward", () => {
-        instance.next();
-        expect(instance.state.currentStep).toEqual(2);
-      });
-    });
-    describe("when current step is not less than the total of steps", () => {
-      it("does nothing", () => {
-        instance.state.currentStep = 3;
-        instance.next();
-        expect(instance.setState).not.toHaveBeenCalled();
-        expect(instance.state.currentStep).toEqual(3);
-      });
-    });
-  });
-  describe("back", () => {
-    beforeEach(() => {
-      spyOn(instance, "setState").and.callThrough();
-    });
-    describe("when current step is larger than 1", () => {
-      it("moves the step backward", () => {
-        instance.state.currentStep = 2;
-        instance.back();
-        expect(instance.state.completed).toEqual(false);
-        expect(instance.state.currentStep).toEqual(1);
-      });
-    });
-    describe("when current step is not larger than 1", () => {
-      it("does nothing", () => {
-        instance.back();
-        expect(instance.setState).not.toHaveBeenCalled();
-        expect(instance.state.currentStep).toEqual(1);
-      });
-    });
-  });
-  describe("complete", () => {
-    beforeEach(() => {
-      spyOn(instance, "setState").and.callThrough();
-    });
-    describe("when current step is the last step", () => {
-      it("completes the wizard", () => {
-        instance.state.currentStep = 2;
-        instance.complete();
-        expect(instance.setState).toHaveBeenCalledWith({
-          completed: true
-        });
-        expect(instance.state.completed).toBeTruthy();
-      });
-    });
-    describe("when current step is not the last step", () => {
-      it("does nothing", () => {
-        instance.complete();
-        expect(instance.setState).not.toHaveBeenCalled();
-        expect(instance.state.completed).toBeFalsy();
-      });
-    });
-  });
-  describe("wizardStepsHTML", () => {
-    describe("when passing the steps prop", () => {
-      it("returns step components", () => {
-        let steps = instance.wizardStepsHTML,
-            step1 = steps[0],
-            step2 = steps[1];
-        expect(steps.length).toEqual(2);
-        expect(step1.props.children.props.children).toEqual("Step 1");
-        expect(step1.props.stepNumber).toEqual(1);
-        expect(step1.props.defaultButton).toEqual(true);
-        expect(step2.props.children.props.children).toEqual("Step 2");
-        expect(step2.props.stepNumber).toEqual(2);
-        expect(step2.props.defaultButton).toEqual(true);
-      });
-    });
-    describe("when not passing the steps prop", () => {
-      it("does not returns step components", () => {
-        instance = TestUtils.renderIntoDocument( /*#__PURE__*/React.createElement(MultiStepWizard, {
-          steps: [],
-          onSubmit: spySubmitHandler
-        }));
-        expect(instance.wizardStepsHTML).toEqual([]);
-      });
-    });
-  });
-});

package/esm/components/multi-step-wizard/multi-step-wizard.d.ts

@@ -1,109 +0,0 @@
-export default MultiStepWizard;
-declare class MultiStepWizard extends React.Component<any, any, any> {
-    constructor(props: any);
-    /**
-     * Returns wizard object to child components.
-     *
-     * @method getChildContext
-     * @return {void}
-     */
-    getChildContext(): void;
-    /**
-     * A lifecycle method that is called before initial render.
-     * Can set up state of component without causing a re-render.
-     *
-     * @method componentWillMount
-     */
-    UNSAFE_componentWillMount(): void;
-    /**
-     * A lifecycle method to update the currentStep state when a new valid value has been specified.
-     *
-     * @method componentWillReceiveProps
-     * @param {Object} props The new props passed down to the component
-     * @return {void}
-     */
-    UNSAFE_componentWillReceiveProps(nextProps: any): void;
-    /**
-     * Validate step props
-     *
-     * @method validateStepProps
-     * @return {Object}
-     */
-    validateStepProps: (stepProps: any) => Object;
-    /**
-     * Get total number of steps
-     *
-     * @method totalSteps
-     * @return {Number}
-     */
-    get totalSteps(): number;
-    /**
-     * Moves to the next step.
-     *
-     * @method next
-     * @return {void}
-     */
-    next: () => void;
-    /**
-     * Back to the previous step.
-     *
-     * @method back
-     * @return {void}
-     */
-    back: () => void;
-    /**
-     * Completes the wizard.
-     *
-     * @method complete
-     * @return {void}
-     */
-    complete: () => void;
-    /**
-     * Returns the computed HTML for the wizard's steps.
-     *
-     * @method wizardStepsHTML
-     * @return {Object} JSX
-     */
-    get wizardStepsHTML(): Object;
-    /**
-     * Renders the component.
-     *
-     * @method render
-     * @return {Object} JSX
-     */
-    render(): Object;
-}
-declare namespace MultiStepWizard {
-    namespace propTypes {
-        const steps: any[];
-        const beforeSubmitValidation: Function;
-        const className: string;
-        const onSubmit: Function;
-        const currentStep: number;
-        const enableInactiveSteps: boolean;
-        const onNext: PropTypes.Requireable<(...args: any[]) => any>;
-        const onBack: PropTypes.Requireable<(...args: any[]) => any>;
-        const completed: boolean;
-    }
-    namespace defaultProps {
-        const beforeSubmitValidation_1: null;
-        export { beforeSubmitValidation_1 as beforeSubmitValidation };
-        const className_1: string;
-        export { className_1 as className };
-        const completed_1: boolean;
-        export { completed_1 as completed };
-        const currentStep_1: number;
-        export { currentStep_1 as currentStep };
-        const enableInactiveSteps_1: boolean;
-        export { enableInactiveSteps_1 as enableInactiveSteps };
-        const onNext_1: null;
-        export { onNext_1 as onNext };
-        const onBack_1: null;
-        export { onBack_1 as onBack };
-    }
-    namespace childContextTypes {
-        const wizard: Object;
-    }
-}
-import React from "react";
-import PropTypes from "prop-types";

package/esm/components/multi-step-wizard/multi-step-wizard.js

@@ -1,383 +0,0 @@
-function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
-
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
-
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }
-
-function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }
-
-function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
-
-function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
-
-function _possibleConstructorReturn(self, call) { if (call && (typeof call === "object" || typeof call === "function")) { return call; } return _assertThisInitialized(self); }
-
-function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
-
-function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
-
-function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-import React from "react";
-import PropTypes from "prop-types";
-import Step from "./step";
-import { StyledMultiStepWizard, StyledMultiStepWizardContent } from "./multi-step-wizard.style";
-import Logger from "../../__internal__/utils/logger";
-/**
- * A MultiStepWizard widget.
- *
- * == How to use a MultiStepWizard in a component:
- *
- * In your file:
- *
- *   import MultiStepWizard from 'carbon-react/lib/components/multi-step-wizard';
- *
- * To render the Wizard:
- *
- *  <MultiStepWizard steps={ [<Step1 />, <Step2 />, ...] } />
- *
- * The component rendering the wizard must pass down a prop of 'steps' where you need to provide an array of custom
- * step components. Note that Step components must be objects and you can pass props to Step components, e.g.
- * <MultiStepWizard steps={ [<Textbox onChange={ this.updateTextboxValue } />, <div className='some-style' />] } />
- *
- * You also need to provide a 'onSubmit' handler to handle a submit event.
- *
- * The wizard also takes a 'currentStep' prop with an integer to specify a step you want to start with.
- * e.g. currentStep={ 2 }. The wizard starts with the first step by default.
- *
- * The wizard disables inactive steps by default. If you wish to enable inactive steps, pass a 'enableInactiveSteps'
- * prop and set it to true.
- *
- * The wizard generates Next and Back buttons by default. If you wish to use custom buttons to replace the default ones
- * in a step component, you can pass a 'defaultButton' prop in the corresponding step component and set it to false.
- * Also, if you want to add additional buttons beside the default Next and Back buttons, you can pass a 'extraButtons'
- * prop in the corresponding step component with your extra buttons.
- * Individual Steps can be optionally disabled by a passing a prop of `enabled={ false }`.
- * e.g. <MultiStepWizard steps={ [<Step1 defaultButton={ false } />, <Step2 />] } />
- *      <MultiStepWizard steps={ [<Step1 />, <Step2 extraButtons={ [<Button>Cancel</Button>] }) />] } />
- *      <MultiStepWizard steps={ [<Step1 />, <Step2 enabled={ false } />] } />
- *
- * The wizard provides the ability to hook into the handle next/back/submit methods.
- * (1) By passing a 'beforeSubmitValidation' prop in the wizard, you can add custom logic before a submit event, and
- *     the submit event can be completed only when the 'beforeSubmitValidation' prop returns 'true'.
- * (2) By passing 'onNext' prop in the corresponding step component,
- *     you can add custom logic when moving a step forward, and
- *     the 'onNext' prop overrides the step's default behaviour of moving next.
- * (3) By passing 'onBack' prop in the corresponding step component,
- *     you can add custom logic when moving a step backward, and
- *     the 'onBack' prop overrides the step's default behaviour of moving back.
- * e.g. <MultiStepWizard steps={ [
- *        <Step1 onNext={ this.customMethodOnNext }/>,
- *        <Step2 onBack={ this.customMethodOnBack }) />
- *      ] } />
- *      <MultiStepWizard beforeSubmitValidation={ this.customValidation } onSubmit={ this.customMethodOnSubmit } />
- *
- * If you want to complete the wizard without going through steps, you can pass a 'completed' prop and set it to true.
- *
- * @class MultiStepWizard
- * @constructor
- */
-
-let deprecatedWarnTriggered = false;
-
-let MultiStepWizard = /*#__PURE__*/function (_React$Component) {
-  _inherits(MultiStepWizard, _React$Component);
-
-  var _super = _createSuper(MultiStepWizard);
-
-  function MultiStepWizard(props) {
-    var _this;
-
-    _classCallCheck(this, MultiStepWizard);
-
-    _this = _super.call(this, props);
-
-    _defineProperty(_assertThisInitialized(_this), "validateStepProps", stepProps => {
-      const step = stepProps.currentStep;
-      const {
-        completed
-      } = stepProps;
-      const totalSteps = stepProps.steps.length;
-
-      if (completed === true) {
-        return {
-          currentStep: totalSteps,
-          completed: true
-        };
-      }
-
-      if (parseInt(step, 10) !== step || step < 1 || step > totalSteps) {
-        return {
-          currentStep: 1,
-          completed: false
-        };
-      }
-
-      return {
-        currentStep: step,
-        completed: false
-      };
-    });
-
-    _defineProperty(_assertThisInitialized(_this), "next", () => {
-      if (_this.state.currentStep < _this.totalSteps) {
-        _this.setState(prevState => ({
-          currentStep: prevState.currentStep + 1
-        }));
-      }
-    });
-
-    _defineProperty(_assertThisInitialized(_this), "back", () => {
-      if (_this.state.currentStep > 1) {
-        _this.setState(prevState => ({
-          completed: false,
-          currentStep: prevState.currentStep - 1
-        }));
-      }
-    });
-
-    _defineProperty(_assertThisInitialized(_this), "complete", () => {
-      if (_this.state.currentStep === _this.totalSteps) {
-        _this.setState({
-          completed: true
-        });
-      }
-    });
-
-    if (!deprecatedWarnTriggered) {
-      deprecatedWarnTriggered = true; // eslint-disable-next-line max-len
-
-      Logger.deprecate("`Multi Step Wizard` component is deprecated and will soon be removed. Please use Step Sequence instead.");
-    }
-
-    return _this;
-  }
-  /**
-   * Returns wizard object to child components.
-   *
-   * @method getChildContext
-   * @return {void}
-   */
-
-
-  _createClass(MultiStepWizard, [{
-    key: "getChildContext",
-    value: function getChildContext() {
-      return {
-        wizard: {
-          nextHandler: this.props.onNext,
-          backHandler: this.props.onBack,
-          beforeSubmitValidation: this.props.beforeSubmitValidation,
-          submitHandler: this.props.onSubmit,
-          enableInactiveSteps: this.props.enableInactiveSteps,
-          currentStep: this.state.currentStep,
-          completed: this.state.completed,
-          next: this.next,
-          back: this.back,
-          complete: this.complete,
-          totalSteps: this.totalSteps
-        }
-      };
-    }
-    /**
-     * A lifecycle method that is called before initial render.
-     * Can set up state of component without causing a re-render.
-     *
-     * @method componentWillMount
-     */
-
-  }, {
-    key: "UNSAFE_componentWillMount",
-    value: function UNSAFE_componentWillMount() {
-      const validProps = this.validateStepProps(this.props);
-      this.setState({
-        currentStep: validProps.currentStep,
-        completed: validProps.completed
-      });
-    }
-    /**
-     * A lifecycle method to update the currentStep state when a new valid value has been specified.
-     *
-     * @method componentWillReceiveProps
-     * @param {Object} props The new props passed down to the component
-     * @return {void}
-     */
-
-  }, {
-    key: "UNSAFE_componentWillReceiveProps",
-    value: function UNSAFE_componentWillReceiveProps(nextProps) {
-      const validProps = this.validateStepProps(nextProps);
-      this.setState({
-        currentStep: validProps.currentStep,
-        completed: validProps.completed
-      });
-    }
-    /**
-     * Validate step props
-     *
-     * @method validateStepProps
-     * @return {Object}
-     */
-
-  }, {
-    key: "totalSteps",
-    get:
-    /**
-     * Get total number of steps
-     *
-     * @method totalSteps
-     * @return {Number}
-     */
-    function () {
-      return this.props.steps.length;
-    }
-    /**
-     * Moves to the next step.
-     *
-     * @method next
-     * @return {void}
-     */
-
-  }, {
-    key: "wizardStepsHTML",
-    get:
-    /**
-     * Returns the computed HTML for the wizard's steps.
-     *
-     * @method wizardStepsHTML
-     * @return {Object} JSX
-     */
-    function () {
-      return this.props.steps.map((step, index) => {
-        return (
-          /*#__PURE__*/
-          // Step is never going to be re-ordered or changed so index is safe to use
-
-          /* eslint-disable react/no-array-index-key */
-          React.createElement(Step, _extends({
-            stepNumber: index + 1,
-            key: `multi-step-wizard-step-${index}`
-          }, step.props), step)
-          /* eslint-enable react/no-array-index-key */
-
-        );
-      });
-    }
-    /**
-     * Renders the component.
-     *
-     * @method render
-     * @return {Object} JSX
-     */
-
-  }, {
-    key: "render",
-    value: function render() {
-      return /*#__PURE__*/React.createElement(StyledMultiStepWizard, {
-        className: this.props.className
-      }, /*#__PURE__*/React.createElement(StyledMultiStepWizardContent, null, this.wizardStepsHTML));
-    }
-  }]);
-
-  return MultiStepWizard;
-}(React.Component);
-
-MultiStepWizard.propTypes = {
-  /**
-   * Individual steps
-   *
-   * @property steps
-   * @type {Array}
-   */
-  steps: PropTypes.arrayOf(PropTypes.object).isRequired,
-
-  /**
-   * Custom function that is called immediately before a submit event
-   *
-   * @property beforeSubmitValidation
-   * @type {Function}
-   */
-  beforeSubmitValidation: PropTypes.func,
-
-  /**
-   * Custom className
-   *
-   * @property className
-   * @type {String}
-   */
-  className: PropTypes.string,
-
-  /**
-   * A custom submit event handler
-   *
-   * @property onSubmit
-   * @type {Function}
-   */
-  onSubmit: PropTypes.func.isRequired,
-
-  /**
-   * Current step
-   *
-   * @property currentStep
-   * @type {Number}
-   * @default 1
-   */
-  currentStep: PropTypes.number,
-  // eslint-disable-line react/no-unused-prop-types
-
-  /**
-   * Determines if the wizard disables inactive steps
-   *
-   * @property enableInactiveSteps
-   * @type {Boolean}
-   * @default false
-   */
-  enableInactiveSteps: PropTypes.bool,
-
-  /**
-   * Add custom logic to next button
-   *
-   * @property onNext
-   */
-  onNext: PropTypes.func,
-
-  /**
-   * Add custom logic to previous button
-   *
-   * @property onPrevious
-   */
-  onBack: PropTypes.func,
-
-  /**
-   * The completion state of the wizard
-   *
-   * @property enableInactiveSteps
-   * @type {Boolean}
-   * @default false
-   */
-  completed: PropTypes.bool // eslint-disable-line react/no-unused-prop-types
-
-};
-MultiStepWizard.defaultProps = {
-  beforeSubmitValidation: null,
-  className: "",
-  completed: false,
-  currentStep: 1,
-  enableInactiveSteps: false,
-  onNext: null,
-  onBack: null
-};
-MultiStepWizard.childContextTypes = {
-  /**
-   * Defines a context object for child components of this wizard.
-   *
-   * @property wizard
-   * @type {Object}
-   */
-  wizard: PropTypes.object
-};
-export default MultiStepWizard;

package/esm/components/multi-step-wizard/multi-step-wizard.style.d.ts

@@ -1,2 +0,0 @@
-export const StyledMultiStepWizard: import("styled-components").StyledComponent<"div", any, {}, never>;
-export const StyledMultiStepWizardContent: import("styled-components").StyledComponent<"div", any, {}, never>;

package/esm/components/multi-step-wizard/multi-step-wizard.style.js

@@ -1,10 +0,0 @@
-import styled from "styled-components";
-const StyledMultiStepWizard = styled.div`
-  width: 100%;
-`;
-const StyledMultiStepWizardContent = styled.div`
-  width: 90%;
-  padding-left: 5%;
-  padding-top: 10px;
-`;
-export { StyledMultiStepWizard, StyledMultiStepWizardContent };

package/esm/components/multi-step-wizard/package.json

@@ -1,4 +0,0 @@
-{
-  "name": "multi-step-wizard",
-  "main": "./multi-step-wizard.js"
-}