@carbon/ibm-products 1.3.0 → 1.6.1

package/es/components/InlineEdit/InlineEdit.js

@@ -0,0 +1,397 @@
+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 = ["cancelDescription", "className", "disabled", "editDescription", "editVisibleOnHoverOnly", "id", "invalid", "invalidText", "labelText", "light", "onCancel", "onSave", "onChange", "placeholder", "saveDescription", "saveDisabled", "size", "value", "warn", "warnText"];
+
+/**
+ * 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 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.
+
+/* TODO: @import(s) of carbon components and other package components. */
+
+import { Button } from 'carbon-components-react';
+import { Close16, Edit16, EditOff16, Checkmark16, WarningFilled16, WarningAltFilled16 } 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.
+
+/**
+ * TODO: A description of the component.
+ */
+
+export var InlineEdit = /*#__PURE__*/React.forwardRef(function (_ref, refIn) {
+  var _cx, _cx3;
+
+  var cancelDescription = _ref.cancelDescription,
+      className = _ref.className,
+      disabled = _ref.disabled,
+      editDescription = _ref.editDescription,
+      editVisibleOnHoverOnly = _ref.editVisibleOnHoverOnly,
+      id = _ref.id,
+      invalid = _ref.invalid,
+      invalidText = _ref.invalidText,
+      labelText = _ref.labelText,
+      light = _ref.light,
+      onCancel = _ref.onCancel,
+      onSave = _ref.onSave,
+      onChange = _ref.onChange,
+      placeholder = _ref.placeholder,
+      saveDescription = _ref.saveDescription,
+      saveDisabled = _ref.saveDisabled,
+      size = _ref.size,
+      value = _ref.value,
+      warn = _ref.warn,
+      warnText = _ref.warnText,
+      rest = _objectWithoutProperties(_ref, _excluded);
+
+  var refInput = useRef(null);
+  var localRef = useRef(null);
+  var ref = refIn || localRef;
+
+  var _useState = useState(false),
+      _useState2 = _slicedToArray(_useState, 2),
+      editing = _useState2[0],
+      setEditing = _useState2[1];
+
+  var _useState3 = useState(value),
+      _useState4 = _slicedToArray(_useState3, 2),
+      internalValue = _useState4[0],
+      setInternalValue = _useState4[1];
+
+  var showValidationText = invalid || warn;
+  var validationText = invalidText || warnText;
+  var validationIcon = showValidationText ? invalid ? /*#__PURE__*/React.createElement(WarningFilled16, null) : /*#__PURE__*/React.createElement(WarningAltFilled16, null) : null;
+
+  var doSetEditing = function doSetEditing(value) {
+    if (value === false) {
+      // move scroll to start
+      refInput.current.scrollLeft = 0;
+    }
+
+    setEditing(!disabled && value);
+  };
+
+  var handleEdit = function handleEdit(ev) {
+    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
+
+      if (rightOfInput || leftOfInput) {
+        doSetEditing(true);
+        setTimeout(function () {
+          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.
+          } else {
+            document.getSelection().collapseToStart();
+            refInput.current.scrollLeft = 0; // scroll to start
+          }
+        }, 0);
+      }
+    }
+  };
+
+  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.innerText);
+    }
+  };
+
+  var handlePaste = function handlePaste(ev) {
+    ev.preventDefault(); // 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
+
+    if (document.queryCommandSupported('insertText')) {
+      document.execCommand('insertText', false, sanitizedText);
+    } else {
+      // Insert text at the current position of caret
+      var range = document.getSelection().getRangeAt(0);
+      range.deleteContents();
+      var textNode = document.createTextNode(sanitizedText);
+      range.insertNode(textNode); // move selection end of textNode
+
+      range.selectNodeContents(textNode);
+      range.collapse(false); // remove existing range
+
+      var selection = document.getSelection();
+      selection.removeAllRanges(); // set the new range
+
+      selection.addRange(range);
+    }
+  };
+
+  var handleInput = function handleInput() {
+    setInternalValue(refInput.current.innerText);
+
+    if (onChange) {
+      onChange(refInput.current.innerText);
+    }
+  };
+
+  var handleCancel = function handleCancel() {
+    refInput.current.innerText = value;
+    handleInput(value);
+    doSetEditing(false);
+    document.getSelection().removeAllRanges();
+
+    if (onCancel) {
+      onCancel(value);
+    }
+  };
+
+  var handleBlur = function handleBlur(ev) {
+    if (!ref.current.contains(ev.relatedTarget)) {
+      doSetEditing(false);
+      handleSave();
+    }
+  };
+
+  var handleKeyDown = function handleKeyDown(ev) {
+    if (ev.key === 'Enter') {
+      ev.preventDefault();
+      refInput.current.blur(); // will cause save
+    }
+  };
+  /*
+    The HTML is structured as follows:
+   <container>
+    <!-- margin left of input to match Carbon -->
+    <content-editable>
+    <-- margin right of input space for after-input-elements -->
+    <after-input-elements>
+  </container>
+    NOTE:
+   - An input is not used as this would not permit a heading tag e.g. <h2>.
+   - Some padding is added to the left 16px standard for a Carbon text input
+   - The after-input-elements are position absolute with a margin to on the input to reserve space. Using inline-flex
+   - does not measure space properly for the input otherwise.
+   - The content editable is not expected to change size when buttons are added, to ensure the text does not move space
+    is reserved up front for buttons and invalid icon. Mostly this is only noticed if the width of the component is not 100%.
+    which can be shown by setting inlineEditFullWidth to false in storybook.
+    In making content-editable behave like an input of type text we have to account for.
+   - Enforcing a single line
+   - Pasting of non-text e.g. html or text with carriage returns
+   - The padding and border not hiding typed in text.
+   - 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, // 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, "--warn"), warn), _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
+      ,
+      onBlur: handleBlur,
+      ref: ref
+    }, /*#__PURE__*/React.createElement("div", _extends({}, rest, getDevtoolsProps(componentName), {
+      id: id,
+      size: size,
+      className: cx("".concat(blockClass, "__input"), _defineProperty({}, "".concat(blockClass, "__input--empty"), refInput.current && refInput.current.innerText.length === 0)),
+      contentEditable: true,
+      "aria-label": labelText,
+      role: "textbox",
+      tabIndex: disabled ? -1 : 0,
+      onFocus: handleFocus,
+      onInput: handleInput,
+      onKeyDown: handleKeyDown,
+      onPaste: handlePaste,
+      suppressContentEditableWarning: true,
+      ref: refInput,
+      "data-placeholder": placeholder !== null && placeholder !== void 0 ? placeholder : labelText
+    }), 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
+      ,
+      tabIndex: "-1"
+    }, /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__ellipsis"),
+      "aria-hidden": !editing
+    }, "\u2026"), /*#__PURE__*/React.createElement("div", {
+      className: cx("".concat(blockClass, "__toolbar"), (_cx3 = {}, _defineProperty(_cx3, "".concat(blockClass, "__toolbar--animation"), toolbarAnimation), _defineProperty(_cx3, "".concat(blockClass, "__toolbar--saveable"), refInput.current && value !== internalValue), _cx3))
+    }, showValidationText && validationText.length > 0 && /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__validation-icon")
+    }, validationIcon), editing ? /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement(Button, {
+      className: "".concat(blockClass, "__cancel"),
+      kind: "ghost",
+      hasIconOnly: true,
+      iconDescription: cancelDescription,
+      onClick: handleCancel,
+      renderIcon: Close16
+    }), /*#__PURE__*/React.createElement(Button, {
+      className: "".concat(blockClass, "__save"),
+      kind: "ghost",
+      hasIconOnly: true,
+      iconDescription: saveDescription,
+      onClick: handleSave,
+      renderIcon: Checkmark16,
+      disabled: invalid || saveDisabled || value === internalValue
+    })) : /*#__PURE__*/React.createElement(Button, {
+      "aria-hidden": "true",
+      className: cx("".concat(blockClass, "__edit"), _defineProperty({}, "".concat(blockClass, "__edit--hover-visible"), editVisibleOnHoverOnly)),
+      kind: "ghost",
+      hasIconOnly: true,
+      iconDescription: editDescription,
+      onClick: handleEdit,
+      renderIcon: disabled ? EditOff16 : Edit16,
+      disabled: disabled,
+      tabIndex: -1
+    }))), /*#__PURE__*/React.createElement("div", {
+      className: cx("".concat(blockClass, "__disabled-cover"))
+    }), showValidationText && validationText.length > 0 && /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__validation-text ").concat(carbon.prefix, "--form-requirement")
+    }, validationText))
+  );
+}); // Return a placeholder if not released and not enabled by feature flag
+
+InlineEdit = 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; // 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 = {
+  /**
+   * 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,
+
+  /**
+   * Label for the edit button
+   */
+  editDescription: PropTypes.string.isRequired,
+
+  /**
+   * In some scenarios the edit icon only needs to be shown on hover. These cases are where continual visibility of
+   * the edit icon is redundant. E.g. a spreadsheet a property panel.
+   */
+  editVisibleOnHoverOnly: PropTypes.bool,
+
+  /**
+   * 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)
+   */
+  onChange: PropTypes.func,
+
+  /**
+   * method called on change event
+   */
+  onSave: PropTypes.func,
+
+  /**
+   * placeholder for text input
+   */
+  placeholder: PropTypes.string,
+
+  /**
+   * label for save button
+   */
+  saveDescription: PropTypes.string.isRequired,
+
+  /**
+   * disabled state of the save button
+   */
+  saveDisabled: PropTypes.bool,
+
+  /**
+   * vertical size of control
+   */
+  size: PropTypes.oneOf(['sm', 'md', 'lg']),
+
+  /**
+   * initial/unedited value
+   */
+  value: PropTypes.string,
+
+  /**
+   * set warn state for input
+   */
+  warn: PropTypes.bool,
+
+  /**
+   * text shown when warn true
+   */
+  warnText: PropTypes.string
+}; // Default values for component props. 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.
+
+InlineEdit.defaultProps = {
+  light: true,
+  // defaults to true to reflect design
+  size: 'md'
+};

package/es/components/InlineEdit/index.js

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

package/es/components/MultiAddSelect/MultiAddSelect.js

@@ -0,0 +1,16 @@
+import _extends from "@babel/runtime/helpers/extends";
+import React, { forwardRef } from 'react'; // import PropTypes from 'prop-types';
+
+import { AddSelect } from '../AddSelect';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg } from '../../settings';
+var componentName = 'MultiAddSelect';
+export var MultiAddSelect = /*#__PURE__*/forwardRef(function (props, ref) {
+  return /*#__PURE__*/React.createElement(AddSelect, _extends({}, props, {
+    multi: true,
+    ref: ref
+  }, getDevtoolsProps(componentName)));
+});
+MultiAddSelect = pkg.checkComponentEnabled(MultiAddSelect, componentName);
+MultiAddSelect.propTypes = {};
+MultiAddSelect.displayName = componentName;

package/es/components/MultiAddSelect/index.js

@@ -0,0 +1 @@
+export { MultiAddSelect } from './MultiAddSelect';

package/es/components/NotificationsPanel/NotificationsPanel.js

@@ -5,7 +5,7 @@ import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProper
 var _excluded = ["className", "data", "daysAgoText", "dismissAllLabel", "dismissSingleNotificationIconDescription", "doNotDisturbDefaultToggled", "doNotDisturbLabel", "emptyStateLabel", "hoursAgoText", "hourAgoText", "minuteAgoText", "minutesAgoText", "monthsAgoText", "monthAgoText", "nowText", "onClickOutside", "onDismissAllNotifications", "onDismissSingleNotification", "onDoNotDisturbChange", "onSettingsClick", "onViewAllClick", "open", "previousLabel", "readLessLabel", "readMoreLabel", "secondsAgoText", "settingsIconDescription", "title", "todayLabel", "viewAllLabel", "yearsAgoText", "yearAgoText", "yesterdayAtText", "yesterdayLabel"];
 
 /**
- * Copyright IBM Corp. 2020, 2021
+ * Copyright IBM Corp. 2020, 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.
@@ -22,7 +22,8 @@ import { timeAgo } from './utils';
 import { NotificationsEmptyState } from '../EmptyStates/NotificationsEmptyState'; // Carbon and package components we use.
 
 import { Button, Link, Toggle } from 'carbon-components-react';
-import { ErrorFilled16, WarningAltFilled16, CheckmarkFilled16, InformationSquareFilled16, ChevronDown16, Close16, Settings16 } from '@carbon/icons-react'; // The block part of our conventional BEM class names (blockClass__E--M).
+import { ErrorFilled16, WarningAltFilled16, CheckmarkFilled16, InformationSquareFilled16, ChevronDown16, Close16, Settings16 } from '@carbon/icons-react';
+import { usePreviousValue } from '../../global/js/hooks'; // The block part of our conventional BEM class names (blockClass__E--M).
 
 var componentName = 'NotificationsPanel';
 var blockClass = "".concat(pkg.prefix, "--notifications-panel");
@@ -75,6 +76,12 @@ export var NotificationsPanel = /*#__PURE__*/React.forwardRef(function (_ref, re
       allNotifications = _useState4[0],
       setAllNotifications = _useState4[1];
 
+  var previousState = usePreviousValue({
+    open: open
+  });
+  var reducedMotion = window && window.matchMedia ? window.matchMedia('(prefers-reduced-motion: reduce)') : {
+    matches: true
+  };
   useEffect(function () {
     // Set the notifications passed to the state within this component
     setAllNotifications(data);
@@ -94,6 +101,12 @@ export var NotificationsPanel = /*#__PURE__*/React.forwardRef(function (_ref, re
     !open && setRender(false);
   };
 
+  useEffect(function () {
+    if (!open && previousState !== null && previousState !== void 0 && previousState.open && reducedMotion.matches) {
+      setRender(false);
+    }
+  }, [open, reducedMotion.matches, previousState === null || previousState === void 0 ? void 0 : previousState.open]);
+
   var sortChronologically = function sortChronologically(arr) {
     if (!arr || arr && !arr.length) {
       return;
@@ -233,7 +246,7 @@ export var NotificationsPanel = /*#__PURE__*/React.forwardRef(function (_ref, re
     id: blockClass,
     className: cx(blockClass, className, "".concat(blockClass, "__container")),
     style: {
-      animation: "".concat(open ? 'fadeIn 250ms' : 'fadeOut 250ms')
+      animation: !reducedMotion.matches ? "".concat(open ? 'fade-in 250ms' : 'fade-out 250ms') : null
     },
     onAnimationEnd: onAnimationEnd,
     ref: ref || notificationPanelRef

package/es/components/OptionsTile/OptionsTile.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 = ["children", "className", "enabled", "heading", "headingId", "invalid", "invalidText", "locked", "lockedText", "onToggle", "size", "summary", "warn", "warnText"];
+var _excluded = ["children", "className", "enabled", "heading", "headingId", "invalid", "invalidText", "locked", "lockedText", "onToggle", "open", "size", "summary", "warn", "warnText"];
 
 /**
  * Copyright IBM Corp. 2021, 2021
@@ -41,22 +41,27 @@ export var OptionsTile = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       locked = _ref.locked,
       lockedText = _ref.lockedText,
       onToggle = _ref.onToggle,
-      _ref$size = _ref.size,
-      size = _ref$size === void 0 ? 'xl' : _ref$size,
+      open = _ref.open,
+      size = _ref.size,
       summary = _ref.summary,
       warn = _ref.warn,
       warnText = _ref.warnText,
       rest = _objectWithoutProperties(_ref, _excluded);
 
-  var _useState = useState(false),
+  var _useState = useState(open),
       _useState2 = _slicedToArray(_useState, 2),
-      open = _useState2[0],
-      setOpen = _useState2[1];
+      isOpen = _useState2[0],
+      setIsOpen = _useState2[1];
 
-  var _useState3 = useState(false),
+  var _useState3 = useState(open),
       _useState4 = _slicedToArray(_useState3, 2),
-      closing = _useState4[0],
-      setClosing = _useState4[1];
+      prevIsOpen = _useState4[0],
+      setPrevIsOpen = _useState4[1];
+
+  var _useState5 = useState(false),
+      _useState6 = _slicedToArray(_useState5, 2),
+      closing = _useState6[0],
+      setClosing = _useState6[1];
 
   var detailsRef = useRef(null);
   var contentRef = useRef(null);
@@ -70,9 +75,19 @@ export var OptionsTile = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     matches: true
   };
 
+  if (open !== prevIsOpen) {
+    if (isOpen && !open) {
+      collapse();
+    } else if (!isOpen && open) {
+      expand();
+    }
+
+    setPrevIsOpen(open);
+  }
+
   function expand() {
     if (detailsRef.current && contentRef.current && !reducedMotion.matches) {
-      setOpen(true);
+      setIsOpen(true);
       detailsRef.current.open = true;
 
       var _getComputedStyle = getComputedStyle(contentRef.current),
@@ -98,7 +113,7 @@ export var OptionsTile = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       });
     } else {
       // in case the refs are not set or the user prefers reduced motion, skip the animation
-      setOpen(true);
+      setIsOpen(true);
     }
   }
 
@@ -127,7 +142,7 @@ export var OptionsTile = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       });
 
       var callback = function callback() {
-        setOpen(false);
+        setIsOpen(false);
         setClosing(false);
       };
 
@@ -135,14 +150,14 @@ export var OptionsTile = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       animation.oncancel = callback;
     } else {
       // in case the ref is not set or the user prefers reduced motion, skip the animation
-      setOpen(false);
+      setIsOpen(false);
     }
   }
 
   function toggle(e) {
     e.preventDefault();
 
-    if (open) {
+    if (isOpen) {
       collapse();
     } else {
       expand();
@@ -199,7 +214,7 @@ export var OptionsTile = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
     size: "sm",
     disabled: isLocked
   })), isExpandable ? /*#__PURE__*/React.createElement("details", {
-    open: open,
+    open: isOpen,
     ref: detailsRef
   }, /*#__PURE__*/React.createElement("summary", {
     className: "".concat(blockClass, "__header"),
@@ -277,6 +292,11 @@ OptionsTile.propTypes = {
    */
   onToggle: PropTypes.func,
 
+  /**
+   * Whether the OptionsTile is in open state.
+   */
+  open: PropTypes.bool,
+
   /**
    * Define the size of the OptionsTile.
    */
@@ -302,5 +322,6 @@ OptionsTile.propTypes = {
 // component needs to make a choice or assumption when a prop is not supplied.
 
 OptionsTile.defaultProps = {
+  open: false,
   size: 'xl'
 };