@carbon/ibm-products 2.0.0-rc.7 → 2.0.0-rc.8

package/lib/components/InlineEditV2/InlineEditV2.js

@@ -0,0 +1,309 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InlineEditV2 = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _react2 = require("@carbon/react");
+
+var _classnames = _interopRequireDefault(require("classnames"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _icons = require("@carbon/react/icons");
+
+var _settings = require("../../settings");
+
+var _devtools = require("../../global/js/utils/devtools");
+
+var _excluded = ["cancelLabel", "editLabel", "id", "invalid", "invalidLabel", "labelText", "onCancel", "onChange", "onSave", "saveLabel", "value"];
+
+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 = 'InlineEditV2';
+var blockClass = "".concat(_settings.pkg.prefix, "--inline-edit-v2");
+var InlineEditV2 = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
+  var cancelLabel = _ref.cancelLabel,
+      editLabel = _ref.editLabel,
+      id = _ref.id,
+      invalid = _ref.invalid,
+      invalidLabel = _ref.invalidLabel,
+      labelText = _ref.labelText,
+      onCancel = _ref.onCancel,
+      onChange = _ref.onChange,
+      onSave = _ref.onSave,
+      saveLabel = _ref.saveLabel,
+      value = _ref.value,
+      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+
+  var _useState = (0, _react.useState)(false),
+      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+      focused = _useState2[0],
+      setFocused = _useState2[1];
+
+  var _useState3 = (0, _react.useState)(''),
+      _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+      initialValue = _useState4[0],
+      setInitialValue = _useState4[1];
+
+  var _useState5 = (0, _react.useState)(false),
+      _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
+      dirtyInput = _useState6[0],
+      setDirtyInput = _useState6[1];
+
+  var inputRef = (0, _react.useRef)(null);
+  var canSave = value !== initialValue && !invalid;
+  var escaping = (0, _react.useRef)(false);
+  (0, _react.useEffect)(function () {
+    if (!initialValue && !dirtyInput) {
+      setInitialValue(value);
+    }
+  }, [initialValue, dirtyInput, value]);
+
+  var isTargetingChild = function isTargetingChild(_ref2) {
+    var currentTarget = _ref2.currentTarget,
+        relatedTarget = _ref2.relatedTarget;
+    return currentTarget.contains(relatedTarget);
+  };
+
+  var onChangeHandler = function onChangeHandler(_ref3) {
+    var target = _ref3.target;
+
+    if (!dirtyInput) {
+      setDirtyInput(true);
+    }
+
+    onChange(target.value);
+  };
+
+  var onFocusHandler = function onFocusHandler(e) {
+    // if (readOnly) {
+    //   return;
+    // }
+    if (!isTargetingChild(e)) {
+      inputRef.current.focus();
+      setFocused(true);
+    }
+  };
+
+  var onSaveHandler = function onSaveHandler() {
+    setInitialValue(value);
+    setFocused(false);
+    setDirtyInput(false);
+    onSave();
+  };
+
+  var onCancelHandler = function onCancelHandler() {
+    setFocused(false);
+    setDirtyInput(false);
+    onCancel(initialValue);
+  };
+
+  var onBlurHandler = function onBlurHandler(e) {
+    // if (readOnly || escaping.current) {
+    if (escaping.current) {
+      return;
+    }
+
+    if (!isTargetingChild(e)) {
+      if (canSave) {
+        onSaveHandler();
+      } else {
+        onCancelHandler();
+      }
+    }
+  };
+
+  var returnHandler = function returnHandler() {
+    if (canSave) {
+      onSaveHandler();
+    }
+  };
+
+  var escapeHandler = function escapeHandler() {
+    onCancelHandler();
+  };
+
+  var onKeyHandler = function onKeyHandler(e) {
+    // to prevent blur handler from being called twice add additional state to check if escape is being used
+    escaping.current = true;
+
+    switch (e.key) {
+      case 'Escape':
+        inputRef.current.blur();
+        escapeHandler();
+        break;
+
+      case 'Enter':
+        inputRef.current.blur();
+        returnHandler();
+        break;
+
+      default:
+        break;
+    }
+
+    escaping.current = false;
+  };
+
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    ref: ref
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _classnames.default)(blockClass, (0, _defineProperty2.default)({}, "".concat(blockClass, "-focused"), focused)),
+    onFocus: onFocusHandler,
+    onBlur: onBlurHandler
+  }, /*#__PURE__*/_react.default.createElement("label", {
+    className: "".concat(blockClass, "__text-input-label"),
+    htmlFor: id
+  }, labelText), /*#__PURE__*/_react.default.createElement("input", {
+    id: id,
+    className: (0, _classnames.default)("".concat(blockClass, "__text-input"), "".concat(_settings.carbon.prefix, "--text-input"), "".concat(_settings.carbon.prefix, "--text-input--sm")),
+    type: "text",
+    value: value,
+    onChange: onChangeHandler,
+    ref: inputRef // readOnly={readOnly}
+    ,
+    onKeyDown: onKeyHandler
+  }), focused ? /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, invalid && /*#__PURE__*/_react.default.createElement(_icons.WarningFilled, {
+    size: 16,
+    className: "".concat(blockClass, "__warning-icon")
+  }), /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    hasIconOnly: true,
+    renderIcon: function renderIcon() {
+      return /*#__PURE__*/_react.default.createElement(_icons.Close, {
+        size: 24
+      });
+    },
+    size: "sm",
+    iconDescription: cancelLabel,
+    onClick: onCancelHandler,
+    kind: "ghost",
+    tabIndex: 0,
+    key: "cancel",
+    className: "".concat(blockClass, "__btn ").concat(blockClass, "__btn-cancel")
+  }), /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    hasIconOnly: true,
+    renderIcon: function renderIcon() {
+      return /*#__PURE__*/_react.default.createElement(_icons.Checkmark, {
+        size: 24
+      });
+    },
+    size: "sm",
+    iconDescription: saveLabel,
+    onClick: onSaveHandler,
+    kind: "ghost",
+    tabIndex: 0,
+    key: "save",
+    className: "".concat(blockClass, "__btn ").concat(blockClass, "__btn-save"),
+    disabled: !canSave
+  })) : /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    className: "".concat(blockClass, "__btn ").concat(blockClass, "__btn-edit"),
+    hasIconOnly: true // renderIcon={readOnly ? EditOff24 : Edit24}
+    ,
+    renderIcon: function renderIcon() {
+      return /*#__PURE__*/_react.default.createElement(_icons.Edit, {
+        size: 24
+      });
+    },
+    size: "sm" // iconDescription={readOnly ? readOnlyLabel : editLabel}
+    ,
+    iconDescription: editLabel,
+    onClick: onFocusHandler,
+    kind: "ghost",
+    tabIndex: 0,
+    key: "edit"
+  })), focused && invalid && /*#__PURE__*/_react.default.createElement("p", {
+    className: "".concat(blockClass, "__warning-text")
+  }, invalidLabel));
+});
+exports.InlineEditV2 = InlineEditV2;
+exports.InlineEditV2 = InlineEditV2 = _settings.pkg.checkComponentEnabled(InlineEditV2, componentName);
+InlineEditV2.displayName = componentName;
+InlineEditV2.propTypes = {
+  /**
+   * label for cancel button
+   */
+  cancelLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * label for edit button
+   */
+  editLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * Specify a custom id for the input
+   */
+  id: _propTypes.default.string.isRequired,
+
+  /**
+   * determines if the input is invalid
+   */
+  invalid: _propTypes.default.bool,
+
+  /**
+   * text that is displayed if the input is invalid
+   */
+  invalidLabel: _propTypes.default.string,
+
+  /**
+   * Provide the text that will be read by a screen reader when visiting this control
+   */
+  labelText: _propTypes.default.string.isRequired,
+
+  /**
+   * handler that is called when the cancel button is pressed or when the user removes focus from the input and there is no new value
+   */
+  onCancel: _propTypes.default.func.isRequired,
+
+  /**
+   * handler that is called when the input is updated
+   */
+  onChange: _propTypes.default.func.isRequired,
+
+  /**
+   * handler that is called when the save button is pressed or when the user removes focus from the input if it has a new value
+   */
+  onSave: _propTypes.default.func.isRequired,
+
+  /**
+   * determines if the input is in readOnly mode
+   */
+  // readOnly: PropTypes.bool,
+
+  /**
+   * label for the edit button that displays when in read only mode
+   */
+  // readOnlyLabel: PropTypes.string,
+
+  /**
+   * label for save button
+   */
+  saveLabel: _propTypes.default.string.isRequired,
+
+  /**
+   * current value of the input
+   */
+  value: _propTypes.default.string.isRequired
+};
+InlineEditV2.defaultProps = {
+  invalid: false,
+  invalidLabel: '' // readOnly: false,
+
+};

package/lib/components/InlineEditV2/index.js

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

package/lib/components/PageHeader/PageHeaderTitle.js

@@ -81,12 +81,10 @@ var PageHeaderTitle = function PageHeaderTitle(_ref) {
     titleText = asText;
   }
 
-  return /*#__PURE__*/_react.default.createElement("div", {
+  return /*#__PURE__*/_react.default.createElement("h1", {
     className: (0, _classnames.default)("".concat(blockClass, "__title"), (0, _defineProperty2.default)({}, "".concat(blockClass, "__title--editable"), isEditable), (0, _defineProperty2.default)({}, "".concat(blockClass, "__title--fades"), hasBreadcrumbRow)),
     title: titleText
-  }, /*#__PURE__*/_react.default.createElement("h1", {
-    className: "".concat(blockClass, "__title-wrapper")
-  }, titleInnards));
+  }, titleInnards);
 };
 
 exports.PageHeaderTitle = PageHeaderTitle;

package/lib/global/js/package-settings.js

@@ -40,6 +40,7 @@ var defaults = {
     HTTPErrorOther: true,
     ImportModal: true,
     InlineEdit: true,
+    InlineEditV1: true,
     NotificationsPanel: true,
     NoDataEmptyState: true,
     NoTagsEmptyState: true,
@@ -74,7 +75,8 @@ var defaults = {
     EditTearsheet: false,
     EditTearsheetNarrow: false,
     EditFullPage: false,
-    EditUpdateCards: false
+    EditUpdateCards: false,
+    InlineEditV2: false
     /* new component flags here - comment used by generate CLI */
 
   },

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/ibm-products",
   "description": "Carbon for IBM Products",
-  "version": "2.0.0-rc.7",
+  "version": "2.0.0-rc.8",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -94,5 +94,5 @@
     "react": "^16.8.6 || ^17.0.1",
     "react-dom": "^16.8.6 || ^17.0.1"
   },
-  "gitHead": "85f73a55da546c111f110732a27921769d970c03"
+  "gitHead": "84c6ea6511d0f4502aa315888ecb4ff108ec97f9"
 }

package/scss/components/{InlineEdit → InlineEditV1}/_index-with-carbon.scss

@@ -6,4 +6,4 @@
 //
 
 @use './carbon-imports';
-@use './inline-edit';
+@use './inline-edit-v1';

package/scss/components/{InlineEdit → InlineEditV1}/_index.scss

@@ -5,4 +5,4 @@
 // LICENSE file in the root directory of this source tree.
 //
 
-@use './inline-edit';
+@use './inline-edit-v1';

package/scss/components/InlineEditV2/_carbon-imports.scss

@@ -0,0 +1,9 @@
+//
+// Copyright IBM Corp. 2022, 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.
+//
+
+@use '@carbon/react/scss/components/button';
+@use '@carbon/react/scss/components/text-input';

package/scss/components/InlineEditV2/_index-with-carbon.scss

@@ -0,0 +1,9 @@
+//
+// Copyright IBM Corp. 2022, 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.
+//
+
+@use './carbon-imports';
+@use './inline-edit-v2';

package/scss/components/InlineEditV2/_index.scss

@@ -0,0 +1,10 @@
+//
+// Copyright IBM Corp. 2022, 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.
+//
+
+// An index file is most useful when you have multiple components
+
+@use './inline-edit-v2';

package/scss/components/InlineEditV2/_inline-edit-v2.scss

@@ -0,0 +1,83 @@
+//
+// Copyright IBM Corp. 2022, 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.
+//
+
+// Standard imports.
+@use '@carbon/styles/scss/spacing' as *;
+@use '@carbon/styles/scss/theme' as *;
+@use '../../global/styles/project-settings' as *;
+@use '@carbon/styles/scss/type';
+
+$block-class: #{$pkg-prefix}--inline-edit-v2;
+$carbon-input: #{$carbon-prefix}--text-input;
+
+.#{$block-class} {
+  display: flex;
+  align-items: center;
+  background: transparent;
+  cursor: pointer;
+}
+
+.#{$block-class}-readonly {
+  cursor: not-allowed;
+}
+
+.#{$block-class}:hover {
+  background: $field-01;
+}
+
+.#{$block-class}:hover .#{$block-class}__btn-edit {
+  visibility: visible;
+}
+
+.#{$block-class}__btn-edit {
+  visibility: hidden;
+}
+
+.#{$block-class}-focused {
+  background: $field-01;
+  outline: 2px solid $focus;
+}
+
+.#{$block-class}__text-input {
+  flex: 1;
+}
+
+.#{$block-class}__text-input-label {
+  display: none;
+}
+
+.#{$block-class}__warning-icon {
+  /* stylelint-disable-next-line carbon/layout-token-use */
+  margin-right: 0.4375rem;
+  color: $support-error;
+}
+
+.#{$block-class}__warning-text {
+  @include type.type-style('label-01');
+
+  margin-top: $spacing-03;
+  color: $support-error;
+}
+
+// overrides
+.#{$block-class}__text-input.#{$carbon-input} {
+  border: none;
+  background: transparent;
+  cursor: pointer;
+  outline: none;
+}
+
+.#{$block-class}-readonly .#{$block-class}__text-input.#{$carbon-input},
+.#{$block-class}-readonly
+  .#{$carbon-prefix}--btn.#{$carbon-prefix}--btn--icon-only.#{$carbon-prefix}--tooltip__trigger {
+  cursor: not-allowed;
+}
+
+.#{$block-class}__text-input.#{$carbon-input}:focus,
+.#{$block-class}__text-input.#{$carbon-input}:active {
+  outline: none;
+}

package/scss/components/InlineEditV2/_storybook-styles.scss

@@ -0,0 +1,9 @@
+//
+// Copyright IBM Corp. 2022, 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.
+//
+.inline-edit-v2-example {
+  width: 15rem;
+}

package/scss/components/PageHeader/_page-header.scss

@@ -466,10 +466,6 @@ $right-section-alt-width: 100% - $left-section-alt-width;
     vertical-align: middle;
   }
 
-  .#{$block-class}__title-wrapper {
-    @include type.type-style('productive-heading-04');
-  }
-
   .#{$block-class}__page-actions {
     flex: 0 0 100%;
     margin-top: $spacing-05;

package/scss/components/_index-released-only-with-carbon.scss

@@ -21,7 +21,7 @@
 @use './ExportModal/index-with-carbon' as *;
 @use './ExpressiveCard/index-with-carbon' as *;
 @use './HTTPErrors/index-with-carbon' as *;
-@use './InlineEdit/index-with-carbon' as *;
+@use './InlineEditV1/index-with-carbon' as *;
 @use './ImportModal/index-with-carbon' as *;
 @use './NotificationsPanel/index-with-carbon' as *;
 @use './PageHeader/index-with-carbon' as *;

package/scss/components/_index-released-only.scss

@@ -21,7 +21,7 @@
 @use './ExportModal';
 @use './ExpressiveCard';
 @use './HTTPErrors';
-@use './InlineEdit';
+@use './InlineEditV1';
 @use './ImportModal';
 @use './NotificationsPanel';
 @use './PageHeader';

package/scss/components/_index-with-carbon.scss

@@ -42,7 +42,8 @@
 @use './UserProfileImage/index-with-carbon' as *;
 @use './EditSidePanel/index-with-carbon' as *;
 @use './OptionsTile/index-with-carbon' as *;
-@use './InlineEdit/index-with-carbon' as *;
+@use './InlineEditV1/index-with-carbon' as *;
+@use './InlineEditV2/index-with-carbon' as *;
 @use './DataSpreadsheet/index-with-carbon' as *;
 @use './Datagrid/index-with-carbon' as *;
 @use './EditUpdateCards/index-with-carbon' as *;

package/scss/components/_index.scss

@@ -42,7 +42,8 @@
 @use './UserProfileImage';
 @use './EditSidePanel';
 @use './OptionsTile';
-@use './InlineEdit';
+@use './InlineEditV1';
+@use './InlineEditV2';
 @use './DataSpreadsheet';
 @use './Datagrid';
 @use './EditTearsheet';