@carbon/ibm-products 1.23.1 → 1.24.0

package/lib/components/EditFullPage/EditFullPage.js

@@ -0,0 +1,85 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EditFullPage = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireDefault(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _classnames = _interopRequireDefault(require("classnames"));
+
+var _devtools = require("../../global/js/utils/devtools");
+
+var _settings = require("../../settings");
+
+var _excluded = ["children", "className"];
+// Carbon and package components we use.
+
+/* TODO: @import(s) of carbon components and other package components. */
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--edit-full-page");
+var componentName = 'EditFullPage'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+// Default values can be included here and then assigned to the prop params,
+// e.g. prop = defaults.prop,
+// This gathers default values together neatly and ensures non-primitive
+// values are initialized early to avoid react making unnecessary re-renders.
+// Note that default values are not required for props that are 'required',
+// nor for props where the component can apply undefined values reasonably.
+// Default values should be provided when the component needs to make a choice
+// or assumption when a prop is not supplied.
+// Default values for props
+// const defaults = {
+//   /* TODO: add defaults for relevant props if needed */
+// };
+
+/**
+ * TODO: A description of the component.
+ */
+
+var EditFullPage = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+      className = _ref.className,
+      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, // Apply the block class to the main HTML element
+    className, // Apply any supplied class names to the main HTML element.
+    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
+    {// switched classes dependant on props or state
+      // example: [`${blockClass}__here-if-small`]: size === 'sm',
+    }),
+    ref: ref,
+    role: "main"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), children);
+}); // Return a placeholder if not released and not enabled by feature flag
+
+
+exports.EditFullPage = EditFullPage;
+exports.EditFullPage = EditFullPage = _settings.pkg.checkComponentEnabled(EditFullPage, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+EditFullPage.displayName = componentName; // The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+
+EditFullPage.propTypes = {
+  /**
+   * Provide the contents of the EditFullPage.
+   */
+  children: _propTypes.default.node.isRequired,
+
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string
+  /* TODO: add types and DocGen for all props. */
+
+};

package/lib/components/EditFullPage/index.js

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "EditFullPage", {
+  enumerable: true,
+  get: function get() {
+    return _EditFullPage.EditFullPage;
+  }
+});
+
+var _EditFullPage = require("./EditFullPage");

package/lib/components/EditTearsheet/EditTearsheet.js

@@ -0,0 +1,229 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FormNumberContext = exports.FormContext = exports.EditTearsheet = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _classnames = _interopRequireDefault(require("classnames"));
+
+var _carbonComponentsReact = require("carbon-components-react");
+
+var _settings = require("../../settings");
+
+var _devtools = require("../../global/js/utils/devtools");
+
+var _TearsheetShell = require("../Tearsheet/TearsheetShell");
+
+var _excluded = ["cancelButtonText", "children", "className", "description", "influencerWidth", "label", "onClose", "open", "submitButtonText", "title", "verticalPosition", "onHandleModalClick"];
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var componentName = 'EditTearsheet';
+var blockClass = "".concat(_settings.pkg.prefix, "--tearsheet-edit"); // This is a general context for the forms container
+// containing information about the state of the container
+// and providing some callback methods for forms to use
+
+var FormContext = /*#__PURE__*/(0, _react.createContext)(null); // This is a context supplied separately to each form in the container
+// to let it know what number it is in the sequence of forms
+
+exports.FormContext = FormContext;
+var FormNumberContext = /*#__PURE__*/(0, _react.createContext)(0); // Default values for props
+
+exports.FormNumberContext = FormNumberContext;
+var defaults = {
+  verticalPosition: 'normal',
+  influencerWidth: 'narrow'
+};
+var EditTearsheet = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
+  var 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,
+      label = _ref.label,
+      onClose = _ref.onClose,
+      open = _ref.open,
+      submitButtonText = _ref.submitButtonText,
+      title = _ref.title,
+      _ref$verticalPosition = _ref.verticalPosition,
+      verticalPosition = _ref$verticalPosition === void 0 ? defaults.verticalPosition : _ref$verticalPosition,
+      onHandleModalClick = _ref.onHandleModalClick,
+      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+
+  var _useState = (0, _react.useState)(0),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+      currentForm = _useState2[0],
+      setCurrentForm = _useState2[1];
+
+  var contentRef = (0, _react.useRef)();
+
+  var handleCurrentForm = function handleCurrentForm(form) {
+    setCurrentForm(form);
+  };
+
+  var sideNavItems = [{
+    label: 'Topic Name'
+  }, {
+    label: 'Location'
+  }, {
+    label: 'Partitions'
+  }, {
+    label: 'Message retention'
+  }];
+
+  var influencer = /*#__PURE__*/_react.default.createElement("div", {
+    className: "tearsheet-stories__dummy-influencer-block"
+  }, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.SideNav, {
+    "aria-label": "Side navigation",
+    className: "".concat(blockClass, "__side-nav"),
+    expanded: true,
+    isFixedNav: false
+  }, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.SideNavItems, null, sideNavItems.map(function (item, index) {
+    return /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.SideNavMenuItem, {
+      key: index,
+      onClick: function onClick() {
+        return handleCurrentForm(index);
+      },
+      isActive: currentForm === index
+    }, item.label);
+  }))));
+
+  return /*#__PURE__*/_react.default.createElement(_TearsheetShell.TearsheetShell, (0, _extends2.default)({}, rest, (0, _devtools.getDevtoolsProps)(componentName), {
+    actions: [{
+      label: submitButtonText,
+      onClick: onHandleModalClick,
+      kind: 'primary'
+    }, {
+      label: cancelButtonText,
+      onClick: onHandleModalClick,
+      kind: 'secondary'
+    }],
+    className: (0, _classnames.default)(blockClass, className),
+    description: description,
+    hasCloseIcon: false,
+    influencer: influencer,
+    influencerPosition: "left",
+    influencerWidth: influencerWidth,
+    label: label,
+    onClose: onClose,
+    open: open,
+    size: "wide",
+    title: title,
+    verticalPosition: verticalPosition,
+    ref: ref
+  }), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__content"),
+    ref: contentRef,
+    role: "main"
+  }, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Grid, null, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Form, null, /*#__PURE__*/_react.default.createElement(FormContext.Provider, {
+    value: {
+      currentForm: currentForm
+    }
+  }, _react.default.Children.map(children, function (child, index) {
+    return /*#__PURE__*/_react.default.createElement(FormNumberContext.Provider, {
+      value: index
+    }, child);
+  }))))));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+exports.EditTearsheet = EditTearsheet;
+exports.EditTearsheet = EditTearsheet = _settings.pkg.checkComponentEnabled(EditTearsheet, componentName); // The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+
+EditTearsheet.displayName = componentName; // Note that the descriptions here should be kept in sync with those for the
+// corresponding props for TearsheetNarrow and TearsheetShell components.
+
+EditTearsheet.propTypes = {
+  /**
+   * The cancel button text
+   */
+  cancelButtonText: _propTypes.default.string,
+
+  /**
+   * The main content of the tearsheet
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * An optional class or classes to be added to the outermost element.
+   */
+  className: _propTypes.default.string,
+
+  /**
+   * A description of the flow, displayed in the header area of the tearsheet.
+   */
+  description: _propTypes.default.node,
+
+  /**
+   * The content for the influencer section of the tearsheet, displayed
+   * alongside the main content. This is typically a menu, or filter, or
+   * progress indicator, or similar.
+   */
+  influencer: _propTypes.default.element,
+
+  /**
+   * Used to set the size of the influencer
+   */
+  influencerWidth: _propTypes.default.oneOf(['narrow', 'wide']),
+
+  /**
+   * 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.default.node,
+
+  /**
+   * 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.default.func,
+
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  onHandleModalClick: _propTypes.default.func,
+
+  /**
+   * Specifies whether the tearsheet is currently open.
+   */
+  open: _propTypes.default.bool,
+
+  /**
+   * The submit button text
+   */
+  submitButtonText: _propTypes.default.string,
+
+  /**
+   * The main title of the tearsheet, displayed in the header area.
+   */
+  title: _propTypes.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: _propTypes.default.oneOf(['normal', 'lower'])
+};

package/lib/components/EditTearsheet/EditTearsheetForm.js

@@ -0,0 +1,122 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EditTearsheetForm = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _classnames = _interopRequireDefault(require("classnames"));
+
+var _carbonComponentsReact = require("carbon-components-react");
+
+var _EditTearsheet = require("./EditTearsheet");
+
+var _settings = require("../../settings");
+
+var _pconsole = _interopRequireDefault(require("../../global/js/utils/pconsole"));
+
+var _excluded = ["children", "className", "description", "fieldsetLegendText", "hasFieldset", "subtitle", "title"];
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+var componentName = 'EditTearsheetForm';
+var blockClass = "".concat(_settings.pkg.prefix, "--tearsheet-edit__form"); // Default values for props
+
+var defaults = {
+  hasFieldset: true
+};
+var EditTearsheetForm = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
+  var _cx;
+
+  var children = _ref.children,
+      className = _ref.className,
+      description = _ref.description,
+      fieldsetLegendText = _ref.fieldsetLegendText,
+      _ref$hasFieldset = _ref.hasFieldset,
+      hasFieldset = _ref$hasFieldset === void 0 ? defaults.hasFieldset : _ref$hasFieldset,
+      subtitle = _ref.subtitle,
+      title = _ref.title,
+      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var formContext = (0, _react.useContext)(_EditTearsheet.FormContext);
+  var formNumber = (0, _react.useContext)(_EditTearsheet.FormNumberContext);
+  return formContext ? /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, className, (_cx = {}, (0, _defineProperty2.default)(_cx, "".concat(blockClass, "__form--hidden-form"), formNumber !== (formContext === null || formContext === void 0 ? void 0 : formContext.currentForm)), (0, _defineProperty2.default)(_cx, "".concat(blockClass, "__form--visible-form"), formNumber === (formContext === null || formContext === void 0 ? void 0 : formContext.currentForm)), _cx)),
+    ref: ref
+  }), /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Row, null, /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.Column, {
+    xlg: 12,
+    lg: 12,
+    md: 8,
+    sm: 8
+  }, /*#__PURE__*/_react.default.createElement("h4", {
+    className: "".concat(blockClass, "--title")
+  }, title), subtitle && /*#__PURE__*/_react.default.createElement("h6", {
+    className: "".concat(blockClass, "--subtitle")
+  }, subtitle), description && /*#__PURE__*/_react.default.createElement("p", {
+    className: "".concat(blockClass, "--description")
+  }, description))), hasFieldset ? /*#__PURE__*/_react.default.createElement(_carbonComponentsReact.FormGroup, {
+    legendText: fieldsetLegendText,
+    className: "".concat(blockClass, "--fieldset")
+  }, children) : children) : _pconsole.default.warn("You have tried using a ".concat(componentName, " component outside of a EditTearsheet. This is not allowed. ").concat(componentName, "s should always be children of the EditTearsheet"));
+}); // Return a placeholder if not released and not enabled by feature flag
+
+exports.EditTearsheetForm = EditTearsheetForm;
+exports.EditTearsheetForm = EditTearsheetForm = _settings.pkg.checkComponentEnabled(EditTearsheetForm, componentName);
+EditTearsheetForm.propTypes = {
+  /**
+   * Content that shows in the tearsheet form
+   */
+  children: _propTypes.default.node,
+
+  /**
+   * Sets an optional className to be added to the tearsheet form
+   */
+  className: _propTypes.default.string,
+
+  /**
+   * Sets an optional description on the form component
+   */
+  description: _propTypes.default.string,
+
+  /**
+   * 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 form content.
+   * Otherwise, use CSS to hide/remove this label text.
+   */
+  fieldsetLegendText: _propTypes.default.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 form content.
+   */
+  hasFieldset: _propTypes.default.bool,
+
+  /**
+   * Sets an optional subtitle on the form component
+   */
+  subtitle: _propTypes.default.string,
+
+  /**
+   * Sets the title text for a tearsheet form
+   */
+  title: _propTypes.default.node.isRequired
+};

package/lib/components/EditTearsheet/index.js

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "EditTearsheet", {
+  enumerable: true,
+  get: function get() {
+    return _EditTearsheet.EditTearsheet;
+  }
+});
+Object.defineProperty(exports, "EditTearsheetForm", {
+  enumerable: true,
+  get: function get() {
+    return _EditTearsheetForm.EditTearsheetForm;
+  }
+});
+
+var _EditTearsheet = require("./EditTearsheet");
+
+var _EditTearsheetForm = require("./EditTearsheetForm");