@carbon/ibm-products 1.5.0 → 1.6.0

package/es/components/InlineEdit/InlineEdit.js

@@ -2,11 +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 = ["className", "disabled", "editDescription", "id", "inline", "invalid", "invalidText", "labelText", "onChange", "onInput", "onRevert", "revertDescription", "saveDescription", "saveDisabled", "size", "value", "warn", "warnText"];
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+var _excluded = ["cancelDescription", "className", "disabled", "editDescription", "editVisibleOnHoverOnly", "id", "invalid", "invalidText", "labelText", "light", "onCancel", "onSave", "onChange", "saveDescription", "saveDisabled", "size", "value", "warn", "warnText"];
 
 /**
  * Copyright IBM Corp. 2022, 2022
@@ -15,18 +11,17 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
  * LICENSE file in the root directory of this source tree.
  */
 // Import portions of React that are needed.
-import React, { 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 } from '../../settings'; // Carbon and package components we use.
 
 /* TODO: @import(s) of carbon components and other package components. */
 
-import { CancelableTextEdit } from '../';
 import { Button } from 'carbon-components-react';
-import { Edit16, EditOff16 } from '@carbon/icons-react'; // The block part of our conventional BEM class names (blockClass__E--M).
+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.
@@ -35,19 +30,22 @@ var componentName = 'InlineEdit'; // NOTE: the component SCSS is not imported he
  * TODO: A description of the component.
  */
 
-export var InlineEdit = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
-  var className = _ref.className,
+export var InlineEdit = /*#__PURE__*/React.forwardRef(function (_ref, refIn) {
+  var _cx, _cx2;
+
+  var cancelDescription = _ref.cancelDescription,
+      className = _ref.className,
       disabled = _ref.disabled,
       editDescription = _ref.editDescription,
+      editVisibleOnHoverOnly = _ref.editVisibleOnHoverOnly,
       id = _ref.id,
-      inline = _ref.inline,
       invalid = _ref.invalid,
       invalidText = _ref.invalidText,
       labelText = _ref.labelText,
+      light = _ref.light,
+      onCancel = _ref.onCancel,
+      onSave = _ref.onSave,
       onChange = _ref.onChange,
-      onInput = _ref.onInput,
-      onRevert = _ref.onRevert,
-      revertDescription = _ref.revertDescription,
       saveDescription = _ref.saveDescription,
       saveDisabled = _ref.saveDisabled,
       size = _ref.size,
@@ -56,62 +54,208 @@ export var InlineEdit = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
       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 handleEdit = function handleEdit() {
-    return setEditing(function (prev) {
-      return !prev;
-    });
+  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 handleEdit = function handleEdit(ev) {
+    if (!disabled) {
+      var rightOfInput = ev.currentTarget.classList.contains("".concat(blockClass, "__edit")) || ev.target.classList.contains("".concat(blockClass, "__controls"));
+      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) {
+        setEditing(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) {
+    if (!editing && ev.target.classList.contains("".concat(blockClass, "__input"))) {
+      // console.log(editing);
+      setEditing(true);
+    }
   };
 
-  var handleChange = function handleChange(val) {
+  var handleSave = function handleSave() {
     setEditing(false);
-    onChange(val);
+    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 handleRevert = function handleRevert() {
+  var handleInput = function handleInput() {
+    setInternalValue(refInput.current.innerText);
+
+    if (onChange) {
+      onChange(refInput.current.innerText);
+    }
+  };
+
+  var handleCancel = function handleCancel() {
+    refInput.current.innerText = value;
+    handleInput(value);
     setEditing(false);
-    onRevert(value);
+    document.getSelection().removeAllRanges();
+
+    if (onCancel) {
+      onCancel(value);
+    }
   };
 
-  var stdProps = _objectSpread(_objectSpread({}, rest), {}, {
-    className: cx(blockClass, // Apply the block class to the main HTML element
-    className, // Apply any supplied class names to the main HTML element.
-    _defineProperty({}, "".concat(blockClass, "--editing"), editing)),
-    id: id,
-    size: size,
-    ref: ref
-  }, getDevtoolsProps(componentName));
-
-  return editing ? /*#__PURE__*/React.createElement(CancelableTextEdit, _extends({}, stdProps, {
-    hideLabel: true,
-    inline: inline,
-    invalid: invalid,
-    invalidText: invalidText,
-    labelText: labelText,
-    onChange: handleChange,
-    onInput: onInput,
-    onRevert: handleRevert,
-    revertDescription: revertDescription,
-    saveDescription: saveDescription,
-    saveDisabled: saveDisabled,
-    value: value,
-    warn: warn,
-    warnText: warnText
-  })) : /*#__PURE__*/React.createElement("div", stdProps, /*#__PURE__*/React.createElement("div", {
-    className: "".concat(blockClass, "__value")
-  }, value), /*#__PURE__*/React.createElement(Button, {
-    className: "".concat(blockClass, "__button ").concat(carbon.prefix, "--btn--md"),
-    kind: "ghost",
-    hasIconOnly: true,
-    iconDescription: editDescription,
-    onClick: handleEdit,
-    renderIcon: disabled ? EditOff16 : Edit16,
-    disabled: disabled
-  }));
+  var handleBlur = function handleBlur(ev) {
+    if (!ref.current.contains(ev.relatedTarget)) {
+      setEditing(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 controls -->
+    <controls>
+  </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 controls 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 controlsAnimation = 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, "--editing"), editing), _defineProperty(_cx, "".concat(blockClass, "--invalid"), invalid), _defineProperty(_cx, "".concat(blockClass, "--light"), light), _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: "".concat(blockClass, "__input"),
+      contentEditable: true,
+      "aria-label": labelText,
+      role: "textbox",
+      tabIndex: "0",
+      onFocus: handleFocus,
+      onInput: handleInput,
+      onKeyDown: handleKeyDown,
+      onPaste: handlePaste,
+      suppressContentEditableWarning: true,
+      ref: refInput
+    }), value), refInput.current && refInput.current.innerText.length === 0 && /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__placeholder")
+    }, labelText), showValidationText && validationText.length > 0 && /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__validation-text")
+    }, validationText), /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__validation-icon")
+    }, validationIcon), /*#__PURE__*/React.createElement("div", {
+      className: cx("".concat(blockClass, "__controls"), (_cx2 = {}, _defineProperty(_cx2, "".concat(blockClass, "__controls--animation"), controlsAnimation), _defineProperty(_cx2, "".concat(blockClass, "__controls--saveable"), invalid || saveDisabled || refInput.current && value !== internalValue), _cx2))
+    }, 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
+    })))
+  );
 }); // 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
@@ -122,6 +266,11 @@ InlineEdit.displayName = componentName; // The types and DocGen commentary for t
 // 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.
    */
@@ -138,16 +287,15 @@ InlineEdit.propTypes = {
   editDescription: PropTypes.string.isRequired,
 
   /**
-   * ID for inline edit
+   * 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.
    */
-  id: PropTypes.string,
-
-  /* TODO: add types and DocGen for all props. */
+  editVisibleOnHoverOnly: PropTypes.bool,
 
   /**
-  * inline variant
-  */
-  inline: PropTypes.bool,
+   * ID for inline edit
+   */
+  id: PropTypes.string,
 
   /**
    * set invalid state for input
@@ -165,24 +313,24 @@ InlineEdit.propTypes = {
   labelText: PropTypes.string,
 
   /**
-   * method called on change event
+   * change background to light version (mimic React TextInput)
    */
-  onChange: PropTypes.func,
+  light: PropTypes.bool,
 
   /**
-   * method called on input event
+   * method called on cancel event
    */
-  onInput: PropTypes.func,
+  onCancel: PropTypes.func,
 
   /**
-   * method called on revert event
+   * method called on input event (it's a React thing onChange behaves like on input)
    */
-  onRevert: PropTypes.func,
+  onChange: PropTypes.func,
 
   /**
-   * label for revert button
+   * method called on change event
    */
-  revertDescription: PropTypes.string.isRequired,
+  onSave: PropTypes.func,
 
   /**
    * label for save button
@@ -219,6 +367,7 @@ InlineEdit.propTypes = {
 // component needs to make a choice or assumption when a prop is not supplied.
 
 InlineEdit.defaultProps = {
-  /* TODO: add defaults for relevant props. */
+  light: true,
+  // defaults to true to reflect design
   size: 'md'
 };

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/PageHeader/PageHeader.js

@@ -361,16 +361,17 @@ export var PageHeader = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
   }, /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__non-navigation-row-content")
   }, hasBreadcrumbRow ? /*#__PURE__*/React.createElement(Row, {
-    className: cx("".concat(blockClass, "__breadcrumb-row"), (_cx2 = {}, _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--next-to-tabs"), nextToTabsCheck()), _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--has-breadcrumbs"), breadcrumbs), _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--has-action-bar"), hasActionBar || widthIsNarrow), _defineProperty(_cx2, "".concat(blockClass, "__has-page-actions-without-action-bar"), !hasActionBar && !widthIsNarrow && pageActions), _cx2))
+    className: cx("".concat(blockClass, "__breadcrumb-row"), (_cx2 = {}, _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--next-to-tabs"), nextToTabsCheck()), _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--has-breadcrumbs"), breadcrumbs || breadcrumbItemForTitle), _defineProperty(_cx2, "".concat(blockClass, "__breadcrumb-row--has-action-bar"), hasActionBar || widthIsNarrow), _defineProperty(_cx2, "".concat(blockClass, "__has-page-actions-without-action-bar"), !hasActionBar && !widthIsNarrow && pageActions), _cx2))
   }, /*#__PURE__*/React.createElement("div", {
     className: "".concat(blockClass, "__breadcrumb-row--container")
   }, /*#__PURE__*/React.createElement(Column, {
     className: cx("".concat(blockClass, "__breadcrumb-column"), _defineProperty({}, "".concat(blockClass, "__breadcrumb-column--background"), !!breadcrumbs || hasActionBar || widthIsNarrow))
-  }, breadcrumbs ? /*#__PURE__*/React.createElement(BreadcrumbWithOverflow, {
+  }, breadcrumbs || breadcrumbItemForTitle ? /*#__PURE__*/React.createElement(BreadcrumbWithOverflow, {
     className: "".concat(blockClass, "__breadcrumb"),
     noTrailingSlash: !!title,
     overflowAriaLabel: breadcrumbOverflowAriaLabel,
-    breadcrumbs: breadcrumbs ? breadcrumbItemForTitle ? breadcrumbs.concat(breadcrumbItemForTitle) : breadcrumbs : null
+    breadcrumbs: breadcrumbs && breadcrumbItemForTitle ? breadcrumbs.concat(breadcrumbItemForTitle) : breadcrumbItemForTitle ? [breadcrumbItemForTitle] : breadcrumbs // breadcrumbs may be null or undefined
+
   }) : null), /*#__PURE__*/React.createElement(Column, {
     className: cx(["".concat(blockClass, "__action-bar-column ").concat(blockClass, "__action-bar-column--background"), (_ref7 = {}, _defineProperty(_ref7, "".concat(blockClass, "__action-bar-column--has-page-actions"), pageActions), _defineProperty(_ref7, "".concat(blockClass, "__action-bar-column--influenced-by-collapse-button"), spaceForCollapseButton), _ref7)])
   }, /*#__PURE__*/React.createElement("div", {
@@ -766,7 +767,8 @@ PageHeader.propTypes = _objectSpread({
    *    - text: title string
    *    - icon: optional icon
    *    - loading: boolean shows loading indicator if true
-   *    - onChange: function to process edits only supply if in place edit is desired
+   *    - onChange: function to process the live value (React change === HTML Input)
+   *    - onSave: function to process a confirmed change
    *    - editableLabel: label for edit required if onChange supplied
    *    - revertDescription: label for edit revert button
    *    - saveDescription: label for edit save button
@@ -786,6 +788,7 @@ PageHeader.propTypes = _objectSpread({
     id: PropTypes.string,
     // .isRequired.if(inlineEditRequired),
     onChange: PropTypes.func,
+    onSave: PropTypes.func,
     revertDescription: PropTypes.string,
     //.isRequired.if(inlineEditRequired),
     saveDescription: PropTypes.string //.isRequired.if(inlineEditRequired),

package/es/components/PageHeader/PageHeaderTitle.js

@@ -1,7 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _extends from "@babel/runtime/helpers/extends";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["text", "content", "loading", "icon", "asText", "onChange", "editDescription", "editableLabel", "revertDescription", "saveDescription"];
+var _excluded = ["text", "content", "loading", "icon", "asText", "onChange", "onSave", "editDescription", "editableLabel", "revertDescription", "saveDescription"];
 import React from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
@@ -26,6 +26,7 @@ export var PageHeaderTitle = function PageHeaderTitle(_ref) {
       icon = title.icon,
       asText = title.asText,
       onChange = title.onChange,
+      onSave = title.onSave,
       editDescription = title.editDescription,
       editableLabel = title.editableLabel,
       revertDescription = title.revertDescription,
@@ -33,7 +34,7 @@ export var PageHeaderTitle = function PageHeaderTitle(_ref) {
       rest = _objectWithoutProperties(title, _excluded);
 
   var titleText;
-  var isEditable = !!onChange;
+  var isEditable = !!onSave;
 
   if (text || !content) {
     if (text === undefined && typeof title === 'string') {
@@ -51,6 +52,7 @@ export var PageHeaderTitle = function PageHeaderTitle(_ref) {
       value: text,
       editDescription: editDescription,
       onChange: onChange,
+      onSave: onSave,
       labelText: editableLabel,
       revertDescription: revertDescription,
       saveDescription: saveDescription
@@ -68,8 +70,8 @@ export var PageHeaderTitle = function PageHeaderTitle(_ref) {
   }, titleInnards);
 };
 export var inlineEditRequired = function inlineEditRequired(_ref2) {
-  var onChange = _ref2.onChange;
-  return !!onChange;
+  var onSave = _ref2.onSave;
+  return !!onSave;
 };
 PageHeaderTitle.propTypes = {
   // passed from page header
@@ -89,9 +91,10 @@ PageHeaderTitle.propTypes = {
    *    - text: title string
    *    - icon: optional icon
    *    - loading: boolean shows loading indicator if true
-   *    - onChange: function to process edits only supply if in place edit is desired
+   *    - onChange: function to process the live value (React change === HTML Input)
+   *    - onSave: function to process a confirmed change
    *    - editDescription: description for edit button
-   *    - editableLabel: label for edit required if onChange supplied
+   *    - editableLabel: label for edit required if onSave supplied
    *    - revertDescription: description for edit revert button
    *    - saveDescription: description for edit save button
    * - Object containing user defined contents. These must fit within the area defined for the title in both main part of the header and the breadcrumb.
@@ -109,6 +112,7 @@ PageHeaderTitle.propTypes = {
     editableLabel: PropTypes.string.isRequired.if(inlineEditRequired),
     id: PropTypes.string.isRequired.if(inlineEditRequired),
     onChange: PropTypes.func,
+    onSave: PropTypes.func,
     revertDescription: PropTypes.string.isRequired.if(inlineEditRequired),
     saveDescription: PropTypes.string.isRequired.if(inlineEditRequired) // Update docgen if changed