@carbon/ibm-products 1.34.1 → 1.35.0

package/es/components/InlineEdit/InlineEdit.js

@@ -4,28 +4,31 @@ import _typeof from "@babel/runtime/helpers/typeof";
 import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["buttonTooltipAlignment", "buttonTooltipPosition", "cancelDescription", "className", "disabled", "editAlwaysVisible", "editDescription", "id", "invalid", "invalidText", "labelText", "light", "onCancel", "onSave", "onChange", "placeholder", "saveDescription", "size", "value"];
-
 /**
  * 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.
  */
+
 // Import portions of React that are needed.
-import React, { useRef, useState } from 'react'; // Other standard imports.
+import React, { useRef, useState } from 'react';
 
+// Other standard imports.
 import PropTypes from 'prop-types';
 import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
-import { pkg, carbon } from '../../settings'; // Carbon and package components we use.
+import { pkg, carbon } from '../../settings';
 
+// Carbon and package components we use.
 /* TODO: @import(s) of carbon components and other package components. */
-
 import { Button } from 'carbon-components-react';
-import { Close16, Edit16, EditOff16, Checkmark16, WarningFilled16 } from '@carbon/icons-react'; // The block part of our conventional BEM class names (blockClass__E--M).
+import { Close16, Edit16, EditOff16, Checkmark16, WarningFilled16 } from '@carbon/icons-react';
 
+// The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(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',
@@ -35,63 +38,56 @@ var defaults = {
   size: 'md'
 };
 var buttons = ['cancel', 'edit', 'save'];
+
 /**
  * TODO: A description of the component.
  */
-
 export var InlineEdit = /*#__PURE__*/React.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 = _objectWithoutProperties(_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 = _objectWithoutProperties(_ref, _excluded);
   var refInput = useRef({
     textContent: value
   });
   var localRef = useRef(null);
   var ref = refIn || localRef;
-
   var _useState = useState(false),
-      _useState2 = _slicedToArray(_useState, 2),
-      editing = _useState2[0],
-      setEditing = _useState2[1];
-
+    _useState2 = _slicedToArray(_useState, 2),
+    editing = _useState2[0],
+    setEditing = _useState2[1];
   var _useState3 = useState(value),
-      _useState4 = _slicedToArray(_useState3, 2),
-      internalValue = _useState4[0],
-      setInternalValue = _useState4[1];
-
+    _useState4 = _slicedToArray(_useState3, 2),
+    internalValue = _useState4[0],
+    setInternalValue = _useState4[1];
   var showValidation = invalid; // || warn;
-
   var validationText = invalidText; // || warnText;
+  var validationIcon = showValidation ? /*#__PURE__*/React.createElement(WarningFilled16, null) : null;
 
-  var validationIcon = showValidation ? /*#__PURE__*/React.createElement(WarningFilled16, null) : null; // sanitize the tooltip values
-
+  // sanitize the tooltip values
   var alignIsObject = _typeof(buttonTooltipAlignment) === 'object';
   var directionIsObject = _typeof(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] = {
@@ -100,29 +96,26 @@ export var InlineEdit = /*#__PURE__*/React.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.
@@ -134,40 +127,34 @@ export var InlineEdit = /*#__PURE__*/React.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
 
@@ -178,48 +165,45 @@ export var InlineEdit = /*#__PURE__*/React.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>
@@ -243,13 +227,13 @@ export var InlineEdit = /*#__PURE__*/React.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.createElement("div", {
-      className: cx(blockClass, // Apply the block class to the main HTML element
+      className: cx(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 = {}, _defineProperty(_cx, "".concat(blockClass, "--disabled"), disabled), _defineProperty(_cx, "".concat(blockClass, "--editing"), editing), _defineProperty(_cx, "".concat(blockClass, "--invalid"), invalid), _defineProperty(_cx, "".concat(blockClass, "--light"), light), _defineProperty(_cx, "".concat(blockClass, "--overflows"), refInput.current && refInput.current.scrollWidth > refInput.current.offsetWidth), _cx)),
       onClick: handleEdit // disabled eslint for click handler
@@ -272,7 +256,8 @@ export var InlineEdit = /*#__PURE__*/React.forwardRef(function (_ref, refIn) {
       ref: refInput,
       "data-placeholder": placeholder
     }), value), /*#__PURE__*/React.createElement("div", {
-      className: cx("".concat(blockClass, "__after-input-elements")) // tabindex -1 fixes blur target test when clicking on after-input-elements background
+      className: cx("".concat(blockClass, "__after-input-elements"))
+      // tabindex -1 fixes blur target test when clicking on after-input-elements background
       ,
       tabIndex: "-1"
     }, /*#__PURE__*/React.createElement("div", {
@@ -312,15 +297,18 @@ export var InlineEdit = /*#__PURE__*/React.forwardRef(function (_ref, refIn) {
       className: "".concat(blockClass, "__validation-text ").concat(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
+InlineEdit = pkg.checkComponentEnabled(InlineEdit, componentName);
 
-InlineEdit = pkg.checkComponentEnabled(InlineEdit, componentName); // The display name of the component, used by React. Note that displayName
+// 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.
@@ -332,7 +320,6 @@ InlineEdit.propTypes = {
     edit: PropTypes.oneOf(['start', 'center', 'end']),
     save: PropTypes.oneOf(['start', 'center', 'end'])
   })]),
-
   /**
    * buttonTooltipPosition from the standard tooltip
    *
@@ -343,91 +330,74 @@ InlineEdit.propTypes = {
     edit: PropTypes.oneOf(['top', 'right', 'bottom', 'left']),
     save: PropTypes.oneOf(['top', 'right', 'bottom', 'left'])
   })]),
-
   /**
    * label for cancel button
    */
   cancelDescription: PropTypes.string.isRequired,
-
   /**
    * Provide an optional class to be applied to the containing node.
    */
   className: PropTypes.string,
-
   /**
    * disable edit
    */
   disabled: PropTypes.bool,
-
   /**
    * By default the edit icon is shown on hover only.
    */
   editAlwaysVisible: PropTypes.bool,
-
   /**
    * Label for the edit button
    */
   editDescription: PropTypes.string.isRequired,
-
   /**
    * ID for inline edit
    */
   id: PropTypes.string,
-
   /**
    * set invalid state for input
    */
   invalid: PropTypes.bool,
-
   /**
    * text shown when invalid is true
    */
   invalidText: PropTypes.string,
-
   /**
    * label for text input
    */
   labelText: PropTypes.string,
-
   /**
    * change background to light version (mimic React TextInput)
    */
   light: PropTypes.bool,
-
   /**
    * method called on cancel event
    */
   onCancel: PropTypes.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.func,
-
   /**
    * method called on change event
    *
    * NOTE: caller to handle invalid states and associated text
    */
   onSave: PropTypes.func,
-
   /**
    * placeholder for text input
    */
   placeholder: PropTypes.string,
-
   /**
    * label for save button
    */
   saveDescription: PropTypes.string.isRequired,
-
   /**
    * vertical size of control
    */
   size: PropTypes.oneOf(['sm', 'md', 'lg']),
-
   /**
    * initial/unedited value
    */

package/es/components/InlineEdit/index.js

@@ -4,4 +4,5 @@
  * 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 { InlineEdit } from './InlineEdit';

package/es/components/InlineEditV2/InlineEditV2.js

@@ -2,7 +2,7 @@ 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 = ["cancelLabel", "editLabel", "invalid", "invalidLabel", "onCancel", "onChange", "onSave", "readOnly", "saveLabel", "value"];
+var _excluded = ["cancelLabel", "editLabel", "invalid", "invalidLabel", "onCancel", "onChange", "onSave", "readOnly", "readOnlyLabel", "saveLabel", "value"];
 import React, { useState, useEffect, forwardRef, useRef } from 'react';
 import { Button } from 'carbon-components-react';
 import cx from 'classnames';
@@ -14,34 +14,30 @@ var componentName = 'InlineEditV2';
 var blockClass = "".concat(pkg.prefix, "--inline-edit-v2");
 export var InlineEditV2 = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _cx;
-
   var cancelLabel = _ref.cancelLabel,
-      editLabel = _ref.editLabel,
-      invalid = _ref.invalid,
-      invalidLabel = _ref.invalidLabel,
-      onCancel = _ref.onCancel,
-      onChange = _ref.onChange,
-      onSave = _ref.onSave,
-      readOnly = _ref.readOnly,
-      saveLabel = _ref.saveLabel,
-      value = _ref.value,
-      rest = _objectWithoutProperties(_ref, _excluded);
-
+    editLabel = _ref.editLabel,
+    invalid = _ref.invalid,
+    invalidLabel = _ref.invalidLabel,
+    onCancel = _ref.onCancel,
+    onChange = _ref.onChange,
+    onSave = _ref.onSave,
+    readOnly = _ref.readOnly,
+    readOnlyLabel = _ref.readOnlyLabel,
+    saveLabel = _ref.saveLabel,
+    value = _ref.value,
+    rest = _objectWithoutProperties(_ref, _excluded);
   var _useState = useState(false),
-      _useState2 = _slicedToArray(_useState, 2),
-      focused = _useState2[0],
-      setFocused = _useState2[1];
-
+    _useState2 = _slicedToArray(_useState, 2),
+    focused = _useState2[0],
+    setFocused = _useState2[1];
   var _useState3 = useState(''),
-      _useState4 = _slicedToArray(_useState3, 2),
-      initialValue = _useState4[0],
-      setInitialValue = _useState4[1];
-
+    _useState4 = _slicedToArray(_useState3, 2),
+    initialValue = _useState4[0],
+    setInitialValue = _useState4[1];
   var _useState5 = useState(false),
-      _useState6 = _slicedToArray(_useState5, 2),
-      dirtyInput = _useState6[0],
-      setDirtyInput = _useState6[1];
-
+    _useState6 = _slicedToArray(_useState5, 2),
+    dirtyInput = _useState6[0],
+    setDirtyInput = _useState6[1];
   var inputRef = useRef(null);
   var canSave = value !== initialValue && !invalid;
   var escaping = useRef(false);
@@ -50,52 +46,42 @@ export var InlineEditV2 = /*#__PURE__*/forwardRef(function (_ref, ref) {
       setInitialValue(value);
     }
   }, [initialValue, dirtyInput, value]);
-
   var isTargetingChild = function isTargetingChild(_ref2) {
     var currentTarget = _ref2.currentTarget,
-        relatedTarget = _ref2.relatedTarget;
+      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) {
       return;
     }
-
     if (!isTargetingChild(e)) {
       if (canSave) {
         onSaveHandler();
@@ -104,39 +90,31 @@ export var InlineEditV2 = /*#__PURE__*/forwardRef(function (_ref, ref) {
       }
     }
   };
-
   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.createElement("div", _extends({}, rest, {
     ref: ref
   }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement("div", {
@@ -144,7 +122,7 @@ export var InlineEditV2 = /*#__PURE__*/forwardRef(function (_ref, ref) {
     onFocus: onFocusHandler,
     onBlur: onBlurHandler
   }, /*#__PURE__*/React.createElement("input", {
-    className: cx("".concat(blockClass, "__text-input"), "".concat(carbon.prefix, "--text-input")),
+    className: cx("".concat(blockClass, "__text-input"), "".concat(carbon.prefix, "--text-input"), "".concat(carbon.prefix, "--text-input--sm")),
     type: "text",
     value: value,
     onChange: onChangeHandler,
@@ -163,7 +141,7 @@ export var InlineEditV2 = /*#__PURE__*/forwardRef(function (_ref, ref) {
     tabIndex: 0,
     key: "cancel",
     className: "".concat(blockClass, "__btn ").concat(blockClass, "__btn-cancel")
-  }), canSave && /*#__PURE__*/React.createElement(Button, {
+  }), /*#__PURE__*/React.createElement(Button, {
     hasIconOnly: true,
     renderIcon: Checkmark24,
     size: "sm",
@@ -179,10 +157,9 @@ export var InlineEditV2 = /*#__PURE__*/forwardRef(function (_ref, ref) {
     hasIconOnly: true,
     renderIcon: readOnly ? EditOff24 : Edit24,
     size: "sm",
-    iconDescription: editLabel,
+    iconDescription: readOnly ? readOnlyLabel : editLabel,
     onClick: onFocusHandler,
     kind: "ghost",
-    disabled: readOnly,
     tabIndex: 0,
     key: "edit"
   })), focused && invalid && /*#__PURE__*/React.createElement("p", {
@@ -196,47 +173,42 @@ InlineEditV2.propTypes = {
    * label for cancel button
    */
   cancelLabel: PropTypes.string.isRequired,
-
   /**
    * label for edit button
    */
   editLabel: PropTypes.string.isRequired,
-
   /**
    * determines if the input is invalid
    */
   invalid: PropTypes.bool,
-
   /**
    * text that is displayed if the input is invalid
    */
   invalidLabel: PropTypes.string,
-
   /**
    * 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.func.isRequired,
-
   /**
    * handler that is called when the input is updated
    */
   onChange: PropTypes.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.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.string.isRequired,
-
   /**
    * current value of the input
    */

package/es/components/ModifiedTabs/ModifiedTabLabelNew.js

@@ -4,6 +4,7 @@
 // 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 from 'react';
 import PropTypes from 'prop-types';
 import { Add20 } from '@carbon/icons-react';
@@ -22,7 +23,6 @@ ModifiedTabLabelNew.propTypes = {
    * Label content of the tab
    */
   label: PropTypes.string,
-
   /**
    * Optional onClick handler
    */