@carbon/ibm-products 2.0.0-rc.9 → 2.0.1

package/es/components/PageHeader/PageHeaderDemo.data.js

@@ -6,7 +6,6 @@
  */
 
 /* istanbul ignore file */
-
 /* cSpell:disable */
 export var demoTableData = [{
   Index: 'C8205413-BD94-0B62-DB0A-BE26CF8C60CD',

package/es/components/PageHeader/PageHeaderTitle.js

@@ -1,62 +1,61 @@
 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", "onSave", "editDescription", "editableLabel", "revertDescription", "saveDescription"];
+var _excluded = ["text", "content", "loading", "icon", "asText", "onChange", "onSave", "editDescription", "editableLabel", "cancelDescription", "saveDescription"];
 import React from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
 import { SkeletonText } from '@carbon/react';
-import { InlineEdit } from '../';
+import { EditInPlace } from '../';
+
 /**
  *
  * Utility component used by Page Header
  */
 // eslint-disable-next-line react/prop-types
-
 export var PageHeaderTitle = function PageHeaderTitle(_ref) {
   var blockClass = _ref.blockClass,
-      hasBreadcrumbRow = _ref.hasBreadcrumbRow,
-      title = _ref.title;
-  var titleInnards; // eslint-disable-next-line
+    hasBreadcrumbRow = _ref.hasBreadcrumbRow,
+    title = _ref.title;
+  var titleInnards;
+  // eslint-disable-next-line
   // debugger;
 
   var text = title.text,
-      content = title.content,
-      loading = title.loading,
-      icon = title.icon,
-      asText = title.asText,
-      onChange = title.onChange,
-      onSave = title.onSave,
-      editDescription = title.editDescription,
-      editableLabel = title.editableLabel,
-      revertDescription = title.revertDescription,
-      saveDescription = title.saveDescription,
-      rest = _objectWithoutProperties(title, _excluded);
-
+    content = title.content,
+    loading = title.loading,
+    icon = title.icon,
+    asText = title.asText,
+    onChange = title.onChange,
+    onSave = title.onSave,
+    editDescription = title.editDescription,
+    editableLabel = title.editableLabel,
+    cancelDescription = title.cancelDescription,
+    saveDescription = title.saveDescription,
+    rest = _objectWithoutProperties(title, _excluded);
   var titleText;
   var isEditable = !!onSave;
-
   if (text || !content) {
     if (text === undefined && typeof title === 'string') {
       text = title;
       asText = title;
     }
-
     var TitleIcon = icon;
     titleInnards = /*#__PURE__*/React.createElement(React.Fragment, null, icon && !loading ? /*#__PURE__*/React.createElement(TitleIcon, {
       className: "".concat(blockClass, "__title-icon")
     }) : null, loading ? /*#__PURE__*/React.createElement(SkeletonText, {
       className: "".concat(blockClass, "__title-skeleton")
-    }) : isEditable ? /*#__PURE__*/React.createElement(InlineEdit, _extends({
-      hideLabel: true,
+    }) : isEditable ? /*#__PURE__*/React.createElement(EditInPlace, _extends({
+      tooltipAlignment: "bottom",
       value: text,
-      editDescription: editDescription,
+      cancelLabel: cancelDescription,
+      editLabel: editDescription,
+      saveLabel: saveDescription,
+      labelText: editableLabel,
       onChange: onChange,
       onSave: onSave,
-      labelText: editableLabel,
-      revertDescription: revertDescription,
-      saveDescription: saveDescription,
-      buttonTooltipPosition: "bottom"
+      size: "md",
+      inheritTypography: true
     }, rest)) : /*#__PURE__*/React.createElement("span", {
       title: !loading ? asText : null
     }, text));
@@ -64,25 +63,22 @@ export var PageHeaderTitle = function PageHeaderTitle(_ref) {
     titleInnards = content;
     titleText = asText;
   }
-
   return /*#__PURE__*/React.createElement("h1", {
     className: cx("".concat(blockClass, "__title"), _defineProperty({}, "".concat(blockClass, "__title--editable"), isEditable), _defineProperty({}, "".concat(blockClass, "__title--fades"), hasBreadcrumbRow)),
     title: titleText
   }, titleInnards);
 };
-export var inlineEditRequired = function inlineEditRequired(_ref2) {
+export var editInPlaceRequired = function editInPlaceRequired(_ref2) {
   var onSave = _ref2.onSave;
   return !!onSave;
 };
 PageHeaderTitle.propTypes = {
   // passed from page header
   blockClass: PropTypes.string.isRequired,
-
   /**
    * controlled from within page header
    */
   hasBreadcrumbRow: PropTypes.bool,
-
   /**
    * An optional page title supplied as a string or object with the following attributes: text, icon, loading
    *
@@ -96,7 +92,7 @@ PageHeaderTitle.propTypes = {
    *    - onSave: function to process a confirmed change
    *    - editDescription: description for edit button
    *    - editableLabel: label for edit required if onSave supplied
-   *    - revertDescription: description for edit revert button
+   *    - cancelDescription: description for edit cancel 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.
    *    - content: title or name of current location shown in main part of page header
@@ -109,14 +105,14 @@ PageHeaderTitle.propTypes = {
     icon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
     loading: PropTypes.bool,
     // inline edit version properties
-    editDescription: PropTypes.string.isRequired.if(inlineEditRequired),
-    editableLabel: PropTypes.string.isRequired.if(inlineEditRequired),
-    id: PropTypes.string.isRequired.if(inlineEditRequired),
+    editDescription: PropTypes.string.isRequired.if(editInPlaceRequired),
+    editableLabel: PropTypes.string.isRequired.if(editInPlaceRequired),
+    id: PropTypes.string.isRequired.if(editInPlaceRequired),
     onChange: PropTypes.func,
     onSave: PropTypes.func,
-    revertDescription: PropTypes.string.isRequired.if(inlineEditRequired),
-    saveDescription: PropTypes.string.isRequired.if(inlineEditRequired) // Update docgen if changed
-
+    cancelDescription: PropTypes.string.isRequired.if(editInPlaceRequired),
+    saveDescription: PropTypes.string.isRequired.if(editInPlaceRequired)
+    // Update docgen if changed
   }), PropTypes.string, PropTypes.shape({
     content: PropTypes.node.isRequired,
     breadcrumbContent: PropTypes.node,

package/es/components/PageHeader/PageHeaderUtils.js

@@ -1,21 +1,20 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
-
 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; }
-
 /**
  * Copyright IBM Corp. 2020, 2021
  *
  * 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 cx from 'classnames';
 import { pkg } from '../../settings';
 import { scrollableAncestor } from '../../global/js/utils/scrollableAncestor';
 import { SkeletonText } from '@carbon/react';
 export var blockClass = "".concat(pkg.prefix, "--page-header");
+
 /**
  * Assesses the vertical height of various elements and calls setMetrics with update
  * @param {{}} headerRef
@@ -26,33 +25,24 @@ export var blockClass = "".concat(pkg.prefix, "--page-header");
  * @param {boolean} widthIsNarrow
  * @param {()} setMetrics
  */
-
 export var utilCheckUpdateVerticalSpace = function utilCheckUpdateVerticalSpace(headerRef, offsetTopMeasuringRef, navigation, enableBreadcrumbScroll, hasActionBar, widthIsNarrow, setMetrics) {
   var dynamicRefs = {};
-
   var getDynamicRef = function getDynamicRef(selector) {
     // would love to do this differently but digging in the dom seems easier
     // than getting a ref to a conditionally rendered item
-
     /* don't know how to test resize */
-
     /* istanbul ignore if */
     if (!headerRef.current) {
       return undefined;
     } else {
       var dRef = dynamicRefs[selector];
       /* istanbul ignore else */
-
-      if (!dRef ||
-      /* istanbul ignore next */
-      dRef.parentNode === null) {
+      if (!dRef || /* istanbul ignore next */dRef.parentNode === null) {
         dynamicRefs[selector] = headerRef.current.querySelector(selector);
       }
     }
-
     return dynamicRefs[selector];
   };
-
   setMetrics(function (previous) {
     // Utility function that checks the heights of various elements which are used to determine layout
     var update = {};
@@ -63,100 +53,87 @@ export var utilCheckUpdateVerticalSpace = function utilCheckUpdateVerticalSpace(
     var availableRowEl = getDynamicRef(".".concat(blockClass, "__available-row"));
     var navigationRowEl = getDynamicRef(".".concat(blockClass, "__navigation-row"));
     var pageActionsEl = getDynamicRef(".".concat(blockClass, "__page-actions"));
-    /* istanbul ignore next */
 
+    /* istanbul ignore next */
     update.headerHeight = headerRef.current ? headerRef.current.clientHeight : 0;
     /* istanbul ignore next */
+    update.headerWidth = headerRef.current ? headerRef.current.offsetWidth : 0;
 
-    update.headerWidth = headerRef.current ? headerRef.current.offsetWidth : 0; // The header offset is the vertical distance from the top of the document to
+    // The header offset is the vertical distance from the top of the document to
     // the page header, which we obtain using getBoundingClientRect() for robust
     // behavior. We use this offset as the scroll/fixed threshold.
-
     var scrollableContainer = scrollableAncestor(headerRef.current);
+
     /* istanbul ignore next */
+    var scrollableContainerTop = scrollableContainer ? scrollableContainer.scrollTop - scrollableContainer.offsetTop : 0;
 
-    var scrollableContainerTop = scrollableContainer ? scrollableContainer.scrollTop - scrollableContainer.offsetTop : 0; // The header offset calculation is either going to work out at 0 if we have no gap between scrolling container
+    // The header offset calculation is either going to work out at 0 if we have no gap between scrolling container
     // top and the measuring ref top, or the difference between. It does not change on scroll or resize.
-
     update.headerOffset = scrollableContainerTop + offsetTopMeasuringRef.current.getBoundingClientRect().top;
-    /* istanbul ignore next */
 
+    /* istanbul ignore next */
     update.breadcrumbRowHeight = breadcrumbRowEl ? breadcrumbRowEl.clientHeight : 0;
     /* istanbul ignore next */
-
     update.breadcrumbRowWidth = breadcrumbRowEl ? breadcrumbRowEl.offsetWidth : 0;
-    /* istanbul ignore next */
 
+    /* istanbul ignore next */
     update.breadcrumbTitleHeight = breadcrumbTitleEl ? breadcrumbTitleEl.offsetHeight // clientHeight returns 0 when window small
     : 1;
-    /* istanbul ignore next */
 
+    /* istanbul ignore next */
     update.titleRowHeight = titleRowEl ? titleRowEl.clientHeight : 0;
     /* istanbul ignore next */
-
     update.subtitleRowHeight = subtitleRowEl ? subtitleRowEl.clientHeight : 0;
     /* istanbul ignore next */
-
     update.availableRowHeight = availableRowEl ? availableRowEl.clientHeight : 0;
     /* istanbul ignore next */
+    update.navigationRowHeight = navigationRowEl ? navigationRowEl.clientHeight : 1;
 
-    update.navigationRowHeight = navigationRowEl ? navigationRowEl.clientHeight : 1; // Base for calculating sticky top
-
+    // Base for calculating sticky top
     update.headerTopValue = -update.headerHeight;
-
     if (navigation) {
       // adjust top for sticky with navigation
       update.headerTopValue += update.navigationRowHeight;
     }
-
     if (!hasActionBar && !widthIsNarrow) {
       // Add difference between $spacing-08 and $spacing-07 to ensure space below breadcrumb is correct on scroll
       // $spacing-07 is used as size for breadcrumb when no action bar otherwise $spacing-08
       update.headerTopValue += 8;
     }
-
     if (!enableBreadcrumbScroll || !navigation) {
       // adjust sticky top if no navigation or breadcrumb is to stay on screen
       update.headerTopValue += update.breadcrumbRowHeight;
     }
-
     if (enableBreadcrumbScroll) {
       // adjust header top value when scroll enabled for breadcrumb
       update.headerTopValue -= navigation ? hasActionBar ? 0 : 10 : update.headerHeight;
-    } // if (window) {
-
+    }
 
+    // if (window) {
     var val;
     /* don't know how to test resize */
-
     /* istanbul ignore if */
-
     if (breadcrumbRowEl) {
       val = parseFloat(window.getComputedStyle(breadcrumbRowEl).getPropertyValue('margin-bottom'), 10);
       update.breadcrumbRowSpaceBelow = isNaN(val) ? 0 : val;
     }
     /* don't know how to test resize */
-
     /* istanbul ignore if */
-
-
     if (titleRowEl) {
       val = parseFloat(window.getComputedStyle(titleRowEl).getPropertyValue('margin-top'), 10);
       update.titleRowSpaceAbove = isNaN(val) ? 0 : val;
-
       if (pageActionsEl) {
         val = parseFloat(window.getComputedStyle(pageActionsEl).getPropertyValue('margin-top'), 10);
         update.pageActionsSpaceAbove = titleRowEl.clientHeight - pageActionsEl.clientHeight + update.titleRowSpaceAbove - (isNaN(val) ? 0 : val);
       }
     }
-
     return _objectSpread(_objectSpread({}, previous), update);
   });
-}; // Trigger a window scroll, if necessary, to set the collapsed state.
+};
 
+// Trigger a window scroll, if necessary, to set the collapsed state.
 export var utilSetCollapsed = function utilSetCollapsed(collapse, headerOffset, headerTopValue) {
   /* don't know how to test resize */
-
   /* istanbul ignore else */
   if (collapse) {
     window.scrollTo({
@@ -172,7 +149,6 @@ export var utilSetCollapsed = function utilSetCollapsed(collapse, headerOffset,
 };
 export var utilGetBreadcrumbItemForTitle = function utilGetBreadcrumbItemForTitle(blockClass, collapseTitle, title) {
   var breadcrumbTitle;
-
   if (title) {
     if (title.text !== undefined) {
       // Shape title provided
@@ -182,7 +158,6 @@ export var utilGetBreadcrumbItemForTitle = function utilGetBreadcrumbItemForTitl
       };
     } else if (title.content !== undefined) {
       var _ref, _title$breadcrumbCont;
-
       // user defined content
       breadcrumbTitle = {
         label: (_ref = (_title$breadcrumbCont = title.breadcrumbContent) !== null && _title$breadcrumbCont !== void 0 ? _title$breadcrumbCont : title.content) !== null && _ref !== void 0 ? _ref : title.asText,
@@ -194,13 +169,11 @@ export var utilGetBreadcrumbItemForTitle = function utilGetBreadcrumbItemForTitl
         title: title
       };
     }
-
     if (breadcrumbTitle) {
       breadcrumbTitle.key = 'breadcrumb-title';
       breadcrumbTitle.isCurrentPage = true;
       breadcrumbTitle.className = cx(["".concat(blockClass, "__breadcrumb-title"), _defineProperty({}, "".concat(blockClass, "__breadcrumb-title--pre-collapsed"), collapseTitle)]);
     }
-
     return breadcrumbTitle;
   }
 };

package/es/components/PageHeader/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 { PageHeader } from './PageHeader';

package/es/components/ProductiveCard/ProductiveCard.js

@@ -2,33 +2,31 @@ import _extends from "@babel/runtime/helpers/extends";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
 var _excluded = ["actionsPlacement"];
-
 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; }
-
 //
 // Copyright IBM Corp. 2020, 2021
 //
 // 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, { forwardRef } from 'react';
 import PropTypes from 'prop-types';
 import { Card } from '../Card';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
 import { prepareProps } from '../../global/js/utils/props-helper';
 import { pkg } from '../../settings';
-var componentName = 'ProductiveCard'; // Default values for props
+var componentName = 'ProductiveCard';
 
+// Default values for props
 var defaults = {
   actionsPlacement: 'top'
 };
 export var ProductiveCard = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _ref$actionsPlacement = _ref.actionsPlacement,
-      actionsPlacement = _ref$actionsPlacement === void 0 ? defaults.actionsPlacement : _ref$actionsPlacement,
-      rest = _objectWithoutProperties(_ref, _excluded);
-
+    actionsPlacement = _ref$actionsPlacement === void 0 ? defaults.actionsPlacement : _ref$actionsPlacement,
+    rest = _objectWithoutProperties(_ref, _excluded);
   var validProps = prepareProps(rest, ['media', 'mediaPosition', 'onSecondaryButtonClick', 'pictogram', 'primaryButtonClick', 'productive', 'secondaryButtonKind', 'secondaryButtonText']);
   return /*#__PURE__*/React.createElement(Card, _extends({}, _objectSpread(_objectSpread({}, validProps), {}, {
     actionsPlacement: actionsPlacement,
@@ -36,8 +34,9 @@ export var ProductiveCard = /*#__PURE__*/forwardRef(function (_ref, ref) {
   }), {
     productive: true
   }, getDevtoolsProps(componentName)));
-}); // Return a placeholder if not released and not enabled by feature flag
+});
 
+// Return a placeholder if not released and not enabled by feature flag
 ProductiveCard = pkg.checkComponentEnabled(ProductiveCard, componentName);
 ProductiveCard.propTypes = {
   /**
@@ -51,47 +50,38 @@ ProductiveCard.propTypes = {
     iconDescription: PropTypes.string,
     href: PropTypes.string
   })),
-
   /**
    * Determines if the action icons are on the top or bottom of the card
    */
   actionsPlacement: PropTypes.oneOf(['top', 'bottom']),
-
   /**
    * Content that shows in the body of the card
    */
   children: PropTypes.node,
-
   /**
    * Optional user provided class
    */
   className: PropTypes.string,
-
   /**
    * Designates which zones of the card are clickable. Refer to design documentation for implementation guidelines
    */
   clickZone: PropTypes.oneOf(['one', 'two', 'three']),
-
   /**
    * Optional header description
    */
-  description: PropTypes.string,
-
+  description: PropTypes.oneOfType([PropTypes.string, PropTypes.object, PropTypes.node]),
   /**
    * Optional label for the top of the card
    */
-  label: PropTypes.string,
-
+  label: PropTypes.oneOfType([PropTypes.string, PropTypes.object, PropTypes.node]),
   /**
    * Provides the callback for a clickable card
    */
   onClick: PropTypes.func,
-
   /**
    * Function that's called from the primary button or action icon
    */
   onPrimaryButtonClick: PropTypes.func,
-
   /**
    * Use an overflow menu instead of action icons. Refer to design documentation for implementation guidelines
    */
@@ -101,37 +91,30 @@ ProductiveCard.propTypes = {
     onClick: PropTypes.func,
     onKeyDown: PropTypes.func
   })),
-
   /**
    * Aria label prop required for OverflowMenu
    */
   overflowAriaLabel: PropTypes.string,
-
   /**
    * Optionally specify an href for your Button to become an <a> element
    */
   primaryButtonHref: PropTypes.string,
-
   /**
    * Optional prop to allow overriding the icon rendering. Can be a React component class
    */
   primaryButtonIcon: PropTypes.oneOfType([PropTypes.func, PropTypes.object]),
-
   /**
    * Determines if the primary button is on the top or bottom of the card
    */
   primaryButtonPlacement: PropTypes.oneOf(['top', 'bottom']),
-
   /**
    * The text that's displayed in the primary button
    */
   primaryButtonText: PropTypes.node,
-
   /**
    * Title that's displayed at the top of the card
    */
-  title: PropTypes.string,
-
+  title: PropTypes.oneOfType([PropTypes.string, PropTypes.object, PropTypes.node]),
   /**
    * Determines title size
    */

package/es/components/ProductiveCard/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 { ProductiveCard } from './ProductiveCard';