@carbon/ibm-products 1.34.1 → 1.35.0

package/lib/components/InlineEdit/InlineEdit.js

@@ -1,47 +1,30 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
 var _typeof3 = require("@babel/runtime/helpers/typeof");
-
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.InlineEdit = void 0;
-
 var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
-
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
 var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
-
 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 _devtools = require("../../global/js/utils/devtools");
-
 var _settings = require("../../settings");
-
 var _carbonComponentsReact = require("carbon-components-react");
-
 var _iconsReact = require("@carbon/icons-react");
-
 var _excluded = ["buttonTooltipAlignment", "buttonTooltipPosition", "cancelDescription", "className", "disabled", "editAlwaysVisible", "editDescription", "id", "invalid", "invalidText", "labelText", "light", "onCancel", "onSave", "onChange", "placeholder", "saveDescription", "size", "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 || _typeof3(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; }
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(_settings.pkg.prefix, "--inline-edit");
-var componentName = 'InlineEdit'; // NOTE: the component SCSS is not imported here: it is rolled up separately.
+var componentName = 'InlineEdit';
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
 
 var defaults = {
   buttonTooltipAlignment: 'center',
@@ -51,62 +34,56 @@ var defaults = {
   size: 'md'
 };
 var buttons = ['cancel', 'edit', 'save'];
+
 /**
  * TODO: A description of the component.
  */
-
 var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
   var _cx, _refInput$current, _refInput$current$tex, _cx3;
-
   var buttonTooltipAlignment = _ref.buttonTooltipAlignment,
-      buttonTooltipPosition = _ref.buttonTooltipPosition,
-      cancelDescription = _ref.cancelDescription,
-      className = _ref.className,
-      disabled = _ref.disabled,
-      editAlwaysVisible = _ref.editAlwaysVisible,
-      editDescription = _ref.editDescription,
-      id = _ref.id,
-      invalid = _ref.invalid,
-      invalidText = _ref.invalidText,
-      labelText = _ref.labelText,
-      _ref$light = _ref.light,
-      light = _ref$light === void 0 ? defaults.light : _ref$light,
-      onCancel = _ref.onCancel,
-      onSave = _ref.onSave,
-      onChange = _ref.onChange,
-      placeholder = _ref.placeholder,
-      saveDescription = _ref.saveDescription,
-      _ref$size = _ref.size,
-      size = _ref$size === void 0 ? defaults.size : _ref$size,
-      value = _ref.value,
-      rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+    buttonTooltipPosition = _ref.buttonTooltipPosition,
+    cancelDescription = _ref.cancelDescription,
+    className = _ref.className,
+    disabled = _ref.disabled,
+    editAlwaysVisible = _ref.editAlwaysVisible,
+    editDescription = _ref.editDescription,
+    id = _ref.id,
+    invalid = _ref.invalid,
+    invalidText = _ref.invalidText,
+    labelText = _ref.labelText,
+    _ref$light = _ref.light,
+    light = _ref$light === void 0 ? defaults.light : _ref$light,
+    onCancel = _ref.onCancel,
+    onSave = _ref.onSave,
+    onChange = _ref.onChange,
+    placeholder = _ref.placeholder,
+    saveDescription = _ref.saveDescription,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? defaults.size : _ref$size,
+    value = _ref.value,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
   var refInput = (0, _react.useRef)({
     textContent: value
   });
   var localRef = (0, _react.useRef)(null);
   var ref = refIn || localRef;
-
   var _useState = (0, _react.useState)(false),
-      _useState2 = (0, _slicedToArray2.default)(_useState, 2),
-      editing = _useState2[0],
-      setEditing = _useState2[1];
-
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    editing = _useState2[0],
+    setEditing = _useState2[1];
   var _useState3 = (0, _react.useState)(value),
-      _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
-      internalValue = _useState4[0],
-      setInternalValue = _useState4[1];
-
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    internalValue = _useState4[0],
+    setInternalValue = _useState4[1];
   var showValidation = invalid; // || warn;
-
   var validationText = invalidText; // || warnText;
+  var validationIcon = showValidation ? /*#__PURE__*/_react.default.createElement(_iconsReact.WarningFilled16, null) : null;
 
-  var validationIcon = showValidation ? /*#__PURE__*/_react.default.createElement(_iconsReact.WarningFilled16, null) : null; // sanitize the tooltip values
-
+  // sanitize the tooltip values
   var alignIsObject = (0, _typeof2.default)(buttonTooltipAlignment) === 'object';
   var directionIsObject = (0, _typeof2.default)(buttonTooltipPosition) === 'object';
   var tipPositions = buttons.reduce(function (acc, button) {
     var _ref2, _ref3;
-
     var tooltipAlignment = (_ref2 = alignIsObject ? buttonTooltipAlignment[button] : buttonTooltipAlignment) !== null && _ref2 !== void 0 ? _ref2 : defaults.buttonTooltipAlignment;
     var tooltipPosition = (_ref3 = directionIsObject ? buttonTooltipPosition[button] : buttonTooltipPosition) !== null && _ref3 !== void 0 ? _ref3 : defaults.buttonTooltipPosition;
     acc[button] = {
@@ -115,29 +92,26 @@ var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
     };
     return acc;
   }, {});
-
   var doSetEditing = function doSetEditing(value) {
     if (value === false) {
       // move scroll to start
       refInput.current.scrollLeft = 0;
     }
-
     setEditing(!disabled && value);
   };
-
   var handleEdit = function handleEdit(ev) {
     /* istanbul ignore else */
     if (!disabled) {
       var rightOfInput = ev.currentTarget.classList.contains("".concat(blockClass, "__edit")) || ev.target.classList.contains("".concat(blockClass, "__after-input-elements"));
-      var leftOfInput = ev.currentTarget = ev.target.classList.contains("".concat(blockClass)); // clicking on the content editable element should not set either of these to true
+      var leftOfInput = ev.currentTarget = ev.target.classList.contains("".concat(blockClass));
 
+      // clicking on the content editable element should not set either of these to true
       if (rightOfInput || leftOfInput) {
         doSetEditing(true);
         setTimeout(function () {
-          refInput.current.focus(); // select all the content
-
+          refInput.current.focus();
+          // select all the content
           document.getSelection().selectAllChildren(refInput.current);
-
           if (rightOfInput) {
             document.getSelection().collapseToEnd();
             refInput.current.scrollLeft = 9999; // never going to get there but ensures at end.
@@ -149,40 +123,34 @@ var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
       }
     }
   };
-
   var handleFocus = function handleFocus(ev) {
     ev.preventDefault();
-
     if (!editing && ev.target.classList.contains("".concat(blockClass, "__input"))) {
       doSetEditing(true);
     }
   };
-
   var handleSave = function handleSave() {
     doSetEditing(false);
     document.getSelection().removeAllRanges();
-
     if (onSave) {
       onSave(refInput.current.textContent);
     }
   };
-
   var handleInput = function handleInput() {
     setInternalValue(refInput.current.textContent);
-
     if (onChange) {
       onChange(refInput.current.textContent);
     }
-  }; // pasting into contentEditable not supported by userEvent
-
+  };
 
-  var handlePaste =
-  /* istanbul ignore next */
-  function handlePaste(ev) {
-    ev.preventDefault(); // Get clipboard as plain text
+  // pasting into contentEditable not supported by userEvent
+  var handlePaste = /* istanbul ignore next */function handlePaste(ev) {
+    ev.preventDefault();
 
-    var text = (ev.clipboardData || window.clipboardData).getData('text/plain'); // remove \n
+    // Get clipboard as plain text
+    var text = (ev.clipboardData || window.clipboardData).getData('text/plain');
 
+    // remove \n
     var sanitizedText = text.replaceAll(/\n/g, '') // remove carriage returns
     .replaceAll(/\t/g, '  '); // replace tab with two spaces
 
@@ -193,48 +161,45 @@ var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
       var range = document.getSelection().getRangeAt(0);
       range.deleteContents();
       var textNode = document.createTextNode(sanitizedText);
-      range.insertNode(textNode); // move selection end of textNode
-
+      range.insertNode(textNode);
+      // move selection end of textNode
       range.selectNodeContents(textNode);
-      range.collapse(false); // remove existing range
+      range.collapse(false);
 
+      // remove existing range
       var selection = document.getSelection();
-      selection.removeAllRanges(); // set the new range
+      selection.removeAllRanges();
 
+      // set the new range
       selection.addRange(range);
     }
   };
-
   var handleCancel = function handleCancel() {
     refInput.current.textContent = value;
     handleInput(value);
     doSetEditing(false);
     document.getSelection().removeAllRanges();
-
     if (onCancel) {
       onCancel(value);
     }
   };
-
   var handleBlur = function handleBlur(ev) {
     if (!ref.current.contains(ev.relatedTarget)) {
       handleSave();
     }
   };
-
   var handleKeyDown = function handleKeyDown(ev) {
     switch (ev.key) {
       case 'Enter':
         ev.preventDefault();
         refInput.current.blur(); // will cause save
-
         break;
-
       case 'Escape':
         handleCancel();
         break;
     }
   };
+
   /*
     The HTML is structured as follows:
    <container>
@@ -258,13 +223,13 @@ var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
    - Placing the cursor at the start or end depending on area clicked (before for left-padding)
   */
 
-
   var toolbarAnimation = true;
   return (
     /*#__PURE__*/
     // eslint-disable-next-line
     _react.default.createElement("div", {
-      className: (0, _classnames.default)(blockClass, // Apply the block class to the main HTML element
+      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.
       "".concat(blockClass, "--").concat(size), (_cx = {}, (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--disabled"), disabled), (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--editing"), editing), (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--invalid"), invalid), (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--light"), light), (0, _defineProperty2.default)(_cx, "".concat(blockClass, "--overflows"), refInput.current && refInput.current.scrollWidth > refInput.current.offsetWidth), _cx)),
       onClick: handleEdit // disabled eslint for click handler
@@ -287,7 +252,8 @@ var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
       ref: refInput,
       "data-placeholder": placeholder
     }), value), /*#__PURE__*/_react.default.createElement("div", {
-      className: (0, _classnames.default)("".concat(blockClass, "__after-input-elements")) // tabindex -1 fixes blur target test when clicking on after-input-elements background
+      className: (0, _classnames.default)("".concat(blockClass, "__after-input-elements"))
+      // tabindex -1 fixes blur target test when clicking on after-input-elements background
       ,
       tabIndex: "-1"
     }, /*#__PURE__*/_react.default.createElement("div", {
@@ -327,17 +293,19 @@ var InlineEdit = /*#__PURE__*/_react.default.forwardRef(function (_ref, refIn) {
       className: "".concat(blockClass, "__validation-text ").concat(_settings.carbon.prefix, "--form-requirement")
     }, validationText))
   );
-}); // Return a placeholder if not released and not enabled by feature flag
-
+});
 
+// Return a placeholder if not released and not enabled by feature flag
 exports.InlineEdit = InlineEdit;
-exports.InlineEdit = InlineEdit = _settings.pkg.checkComponentEnabled(InlineEdit, componentName); // The display name of the component, used by React. Note that displayName
+exports.InlineEdit = InlineEdit = _settings.pkg.checkComponentEnabled(InlineEdit, componentName);
+
+// The display name of the component, used by React. Note that displayName
 // is used in preference to relying on function.name.
+InlineEdit.displayName = componentName;
 
-InlineEdit.displayName = componentName; // The types and DocGen commentary for the component props,
+// The types and DocGen commentary for the component props,
 // in alphabetical order (for consistency).
 // See https://www.npmjs.com/package/prop-types#usage.
-
 InlineEdit.propTypes = {
   /**
    * buttonTooltipAlignment from the standard tooltip. Default center.
@@ -349,7 +317,6 @@ InlineEdit.propTypes = {
     edit: _propTypes.default.oneOf(['start', 'center', 'end']),
     save: _propTypes.default.oneOf(['start', 'center', 'end'])
   })]),
-
   /**
    * buttonTooltipPosition from the standard tooltip
    *
@@ -360,91 +327,74 @@ InlineEdit.propTypes = {
     edit: _propTypes.default.oneOf(['top', 'right', 'bottom', 'left']),
     save: _propTypes.default.oneOf(['top', 'right', 'bottom', 'left'])
   })]),
-
   /**
    * label for cancel button
    */
   cancelDescription: _propTypes.default.string.isRequired,
-
   /**
    * Provide an optional class to be applied to the containing node.
    */
   className: _propTypes.default.string,
-
   /**
    * disable edit
    */
   disabled: _propTypes.default.bool,
-
   /**
    * By default the edit icon is shown on hover only.
    */
   editAlwaysVisible: _propTypes.default.bool,
-
   /**
    * Label for the edit button
    */
   editDescription: _propTypes.default.string.isRequired,
-
   /**
    * ID for inline edit
    */
   id: _propTypes.default.string,
-
   /**
    * set invalid state for input
    */
   invalid: _propTypes.default.bool,
-
   /**
    * text shown when invalid is true
    */
   invalidText: _propTypes.default.string,
-
   /**
    * label for text input
    */
   labelText: _propTypes.default.string,
-
   /**
    * change background to light version (mimic React TextInput)
    */
   light: _propTypes.default.bool,
-
   /**
    * method called on cancel event
    */
   onCancel: _propTypes.default.func,
-
   /**
    * method called on input event (it's a React thing onChange behaves like on input).
    *
    * NOTE: caller to handle invalid states and associated text
    */
   onChange: _propTypes.default.func,
-
   /**
    * method called on change event
    *
    * NOTE: caller to handle invalid states and associated text
    */
   onSave: _propTypes.default.func,
-
   /**
    * placeholder for text input
    */
   placeholder: _propTypes.default.string,
-
   /**
    * label for save button
    */
   saveDescription: _propTypes.default.string.isRequired,
-
   /**
    * vertical size of control
    */
   size: _propTypes.default.oneOf(['sm', 'md', 'lg']),
-
   /**
    * initial/unedited value
    */

package/lib/components/InlineEdit/index.js

@@ -9,5 +9,4 @@ Object.defineProperty(exports, "InlineEdit", {
     return _InlineEdit.InlineEdit;
   }
 });
-
 var _InlineEdit = require("./InlineEdit");