@carbon/ibm-products 2.43.2-canary.2 → 2.43.2-canary.200

package/es/components/Datagrid/useNestedRows.js

@@ -15,33 +15,52 @@ var blockClass = "".concat(pkg.prefix, "--datagrid");
 var useNestedRows = function useNestedRows(hooks) {
   useNestedRowExpander(hooks);
   var useInstance = function useInstance(instance) {
+    useEffect(function () {
+      var _ref = instance,
+        rows = _ref.rows;
+      var defaultExpandedRows = rows.filter(function (row) {
+        var _row$original;
+        return row === null || row === void 0 || (_row$original = row.original) === null || _row$original === void 0 ? void 0 : _row$original.defaultExpanded;
+      });
+      if (defaultExpandedRows !== null && defaultExpandedRows !== void 0 && defaultExpandedRows.length) {
+        defaultExpandedRows.map(function (defaultExpandedRow) {
+          if (!(defaultExpandedRow !== null && defaultExpandedRow !== void 0 && defaultExpandedRow.isExpanded) && !(defaultExpandedRow !== null && defaultExpandedRow !== void 0 && defaultExpandedRow.hasExpanded)) {
+            var _defaultExpandedRow$t;
+            defaultExpandedRow === null || defaultExpandedRow === void 0 || (_defaultExpandedRow$t = defaultExpandedRow.toggleRowExpanded) === null || _defaultExpandedRow$t === void 0 || _defaultExpandedRow$t.call(defaultExpandedRow);
+            defaultExpandedRow.hasExpanded = true;
+            return;
+          }
+        });
+      }
+    }, [instance, instance.rows]);
     // This useEffect will expand rows if they exist in the initialState obj
     useEffect(function () {
       var rows = instance.rows,
         initialState = instance.initialState;
-      var _ref = initialState,
-        expandedRowIds = _ref.expandedRowIds;
+      var _ref2 = initialState,
+        expandedRowIds = _ref2.expandedRowIds;
       if (expandedRowIds) {
         Object.keys(expandedRowIds).forEach(function (key) {
+          var _row$0$original;
           var row = rows.filter(function (r) {
-            return r.id.toString() === key.toString();
+            var _r$original;
+            return r.id.toString() === key.toString() || ((_r$original = r.original) === null || _r$original === void 0 || (_r$original = _r$original.id) === null || _r$original === void 0 ? void 0 : _r$original.toString()) === key.toString();
           });
-          if (row !== null && row !== void 0 && row.length && key.toString() === row[0].id.toString()) {
-            var _row$;
-            (_row$ = row[0]) === null || _row$ === void 0 || _row$.toggleRowExpanded();
+          if (row.length && key.toString() === row[0].id.toString() || row.length && key.toString() === ((_row$0$original = row[0].original) === null || _row$0$original === void 0 || (_row$0$original = _row$0$original.id) === null || _row$0$original === void 0 ? void 0 : _row$0$original.toString())) {
+            row[0].toggleRowExpanded();
           }
         });
       }
     }, [instance]);
     var marginLeft = 24;
-    var getRowProps = function getRowProps(props, _ref2) {
-      var row = _ref2.row;
+    var getRowProps = function getRowProps(props, _ref3) {
+      var row = _ref3.row;
       return [props, {
         className: cx(_defineProperty(_defineProperty({}, "".concat(blockClass, "__carbon-nested-row"), row.depth > 0), "".concat(blockClass, "__carbon-row-expanded"), row.isExpanded))
       }];
     };
-    var getRowStyles = function getRowStyles(props, _ref3) {
-      var row = _ref3.row;
+    var getRowStyles = function getRowStyles(props, _ref4) {
+      var row = _ref4.row;
       return [props, {
         style: {
           paddingLeft: "".concat(row.depth > 1 ? marginLeft * 2 + (row.depth - 1) * (marginLeft + marginLeft / 3) : row.depth === 1 ? marginLeft * 2 : 0, "px")
@@ -51,9 +70,9 @@ var useNestedRows = function useNestedRows(hooks) {
     var getIndentation = function getIndentation(depth) {
       return 32 * depth + 16;
     }; // row indentation padding
-    var getCellProps = function getCellProps(props, _ref4) {
-      var cell = _ref4.cell,
-        instance = _ref4.instance;
+    var getCellProps = function getCellProps(props, _ref5) {
+      var cell = _ref5.cell,
+        instance = _ref5.instance;
       // we add a dynamic -ve margin right only if the cell is resized below minimum width i.e 50px, else we set the width based on indentation at different levels
       var isFirstCell = instance.columns.findIndex(function (c) {
         return c.id === cell.column.id;

package/es/components/Datagrid/useRowExpander.js

@@ -50,9 +50,7 @@ var useRowExpander = function useRowExpander(hooks) {
           type: "button",
           "aria-label": expanderTitle,
           className: cx("".concat(blockClass, "__row-expander"), "".concat(carbon.prefix, "--btn"), "".concat(carbon.prefix, "--btn--ghost"))
-        }, expanderButtonProps, {
-          title: expanderTitle
-        }), row.isExpanded ? /*#__PURE__*/React__default.createElement(ChevronUp, {
+        }, expanderButtonProps), row.isExpanded ? /*#__PURE__*/React__default.createElement(ChevronUp, {
           className: "".concat(blockClass, "__row-expander--icon")
         }) : /*#__PURE__*/React__default.createElement(ChevronDown, {
           className: "".concat(blockClass, "__row-expander--icon")

package/es/components/Datagrid/useRowIsMouseOver.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Copyright IBM Corp. 2024
+ *
+ * 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 { Hooks } from 'react-table';
 declare const useRowIsMouseOver: (hooks: Hooks) => void;
 export default useRowIsMouseOver;

package/es/components/Datagrid/useRowRenderer.js

@@ -5,18 +5,60 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import { toConsumableArray as _toConsumableArray } from '../../_virtual/_rollupPluginBabelHelpers.js';
 import DatagridRow from './Datagrid/DatagridRow.js';
 
 var useRowRenderer = function useRowRenderer(hooks) {
   var useInstance = function useInstance(instance) {
-    var rows = instance.rows;
+    var _newRows;
+    var rows = instance.rows,
+      state = instance.state;
+    var newRows = null;
+    if (state !== null && state !== void 0 && state.dynamicRowSkeleton) {
+      var _state$dynamicRowSkel;
+      var depthIndexArray = state === null || state === void 0 || (_state$dynamicRowSkel = state.dynamicRowSkeleton) === null || _state$dynamicRowSkel === void 0 ? void 0 : _state$dynamicRowSkel.id.split('').filter(function (r) {
+        return r !== '.';
+      });
+      if (depthIndexArray.length > 1) {
+        var subRows;
+        var finalRow;
+        // This will find the subRow that requested to find dynamic rows
+        // and will apply the skeleton row after that row
+        depthIndexArray.map(function (depthIndex, index) {
+          if (index === 0) {
+            subRows = rows[depthIndex].subRows;
+            return;
+          }
+          if (depthIndexArray.length - 1 === index) {
+            finalRow = subRows.find(function (r) {
+              return r.index === parseInt(depthIndex);
+            });
+            subRows.splice(finalRow.index + 1, 0, state === null || state === void 0 ? void 0 : state.dynamicRowSkeleton); // + 1 because we want to add the skeleton row after the row initiating the dynamic request
+            return;
+          }
+          var foundRow = subRows.find(function (r) {
+            return r.index === parseInt(depthIndex);
+          });
+          subRows = foundRow.subRows;
+        });
+      }
+      var rootRowIndexWithDynamicRow = rows.findIndex(function (r) {
+        var _state$dynamicRowSkel2;
+        return r.id === (state === null || state === void 0 || (_state$dynamicRowSkel2 = state.dynamicRowSkeleton) === null || _state$dynamicRowSkel2 === void 0 ? void 0 : _state$dynamicRowSkel2.id);
+      });
+      if (rootRowIndexWithDynamicRow > -1) {
+        newRows = [].concat(_toConsumableArray(rows.slice(0, rootRowIndexWithDynamicRow + 1)), [// + 1 because we want to add the skeleton row after the row initiating the dynamic request
+        state === null || state === void 0 ? void 0 : state.dynamicRowSkeleton], _toConsumableArray(rows.slice(rootRowIndexWithDynamicRow + 1)));
+      }
+    }
+    newRows = (_newRows = newRows) !== null && _newRows !== void 0 ? _newRows : rows;
     var addRowRenderer = function addRowRenderer(row) {
       return Object.assign(row, {
         RowRenderer: DatagridRow,
         subRows: (row.subRows || []).map(addRowRenderer)
       });
     };
-    var rowsWithRenderer = rows.map(addRowRenderer);
+    var rowsWithRenderer = newRows.map(addRowRenderer);
     Object.assign(instance, {
       rows: rowsWithRenderer
     });

package/es/components/Datagrid/useSelectRows.js

@@ -81,11 +81,12 @@ var SelectRow = function SelectRow(datagridState) {
     withStickyColumn = datagridState.withStickyColumn,
     dispatch = datagridState.dispatch,
     getRowId = datagridState.getRowId;
-  var _useState = useState(typeof window !== 'undefined' ? window.innerWidth : ''),
+  var _useState = useState(),
     _useState2 = _slicedToArray(_useState, 2),
     windowSize = _useState2[0],
     setWindowSize = _useState2[1];
   useLayoutEffect(function () {
+    setWindowSize(window.innerWidth);
     function updateSize() {
       setWindowSize(window.innerWidth);
     }

package/es/components/Datagrid/useSortableColumns.d.ts

@@ -5,9 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import { Hooks } from 'react-table';
-export declare const getNewSortOrder: (sortOrder?: boolean | string) => {
-    newSortDesc: boolean;
-    newOrder: string;
-};
+interface Order {
+    newOrder: 'ASC' | 'DESC' | 'NONE';
+    newSortDesc: undefined | boolean;
+}
+export declare const getNewSortOrder: (currentOrder?: boolean | string) => Order;
 declare const useSortableColumns: (hooks: Hooks) => void;
 export default useSortableColumns;

package/es/components/Datagrid/useSortableColumns.js

@@ -15,23 +15,28 @@ import { SelectAll } from './Datagrid/DatagridSelectAll.js';
 import { DatagridSlug } from './Datagrid/addons/Slug/DatagridSlug.js';
 
 var blockClass = "".concat(pkg.prefix, "--datagrid");
-var ordering = {
-  ASC: 'ASC',
-  DESC: 'DESC',
-  NONE: 'NONE'
-};
-var getNewSortOrder = function getNewSortOrder(sortOrder) {
+var getNewSortOrder = function getNewSortOrder(currentOrder) {
   var order = {
-    newSortDesc: false,
-    newOrder: ordering.NONE
+    newOrder: 'NONE',
+    newSortDesc: undefined
   };
-  if (sortOrder === false || sortOrder === ordering.DESC) {
-    order.newOrder = ordering.DESC;
+
+  // NONE => ASC
+  if (currentOrder === undefined) {
+    order.newOrder = 'ASC';
+    order.newSortDesc = false;
+  }
+
+  // ACS => DESC
+  if (currentOrder === false || currentOrder === 'DESC') {
+    order.newOrder = 'DESC';
     order.newSortDesc = true;
   }
-  if (sortOrder === undefined || sortOrder === ordering.ASC) {
-    order.newOrder = ordering.ASC;
-    order.newSortDesc = false;
+
+  // DESC => NONE
+  if (currentOrder === true || currentOrder === 'ASC') {
+    order.newOrder = 'NONE';
+    order.newSortDesc = undefined;
   }
   return order;
 };
@@ -108,6 +113,15 @@ var useSortableColumns = function useSortableColumns(hooks) {
         }
         return /*#__PURE__*/React__default.createElement(ArrowsVertical, iconProps);
       };
+      var handleKey = function handleKey(e, columnId) {
+        var key = e.key;
+        if (key === 'Enter') {
+          setTimeout(function () {
+            var _document$getElementB;
+            return (_document$getElementB = document.getElementById(columnId)) === null || _document$getElementB === void 0 ? void 0 : _document$getElementB.focus();
+          }, 0);
+        }
+      };
       var Header = function Header(headerProp) {
         return column.disableSortBy === true || column.id === 'datagridSelection' || column.isAction ? column.disableSortBy || column.isAction ? column.Header : /*#__PURE__*/React__default.createElement(SelectAll, instance) : /*#__PURE__*/React__default.createElement(Button, {
           "aria-sort": getAriaSortValue(headerProp === null || headerProp === void 0 ? void 0 : headerProp.column, {
@@ -126,7 +140,11 @@ var useSortableColumns = function useSortableColumns(hooks) {
               slug: headerProp === null || headerProp === void 0 || (_headerProp$column = headerProp.column) === null || _headerProp$column === void 0 ? void 0 : _headerProp$column.slug
             }), icon(headerProp === null || headerProp === void 0 ? void 0 : headerProp.column, props));
           },
-          className: cx("".concat(carbon.prefix, "--table-sort ").concat(blockClass, "--table-sort"), _defineProperty(_defineProperty({}, "".concat(blockClass, "--table-sort--desc"), headerProp === null || headerProp === void 0 ? void 0 : headerProp.column.isSortedDesc), "".concat(blockClass, "--table-sort--asc"), (headerProp === null || headerProp === void 0 ? void 0 : headerProp.column.isSortedDesc) === false))
+          id: column === null || column === void 0 ? void 0 : column.id,
+          className: cx("".concat(carbon.prefix, "--table-sort ").concat(blockClass, "--table-sort"), _defineProperty(_defineProperty({}, "".concat(blockClass, "--table-sort--desc"), headerProp === null || headerProp === void 0 ? void 0 : headerProp.column.isSortedDesc), "".concat(blockClass, "--table-sort--asc"), (headerProp === null || headerProp === void 0 ? void 0 : headerProp.column.isSortedDesc) === false)),
+          onKeyDown: function onKeyDown(event) {
+            return handleKey(event, column.id);
+          }
         }, column.Header);
       };
       return _objectSpread2(_objectSpread2({}, column), {}, {

package/es/components/Datagrid/useStickyColumn.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Copyright IBM Corp. 2021, 2023
+ *
+ * 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 { Hooks } from 'react-table';
+declare const useStickyColumn: (hooks: Hooks) => void;
 export default useStickyColumn;
-declare function useStickyColumn(hooks: any): void;

package/es/components/Datagrid/useStickyColumn.js

@@ -18,12 +18,13 @@ var OFFSET_SCROLL_CLASS = "".concat(styleClassPrefix, "-offset-scroll");
 var useStickyColumn = function useStickyColumn(hooks) {
   var tableBodyRef = useRef();
   var stickyHeaderCellRef = useRef();
-  var _useState = useState(null),
+  var _useState = useState(),
     _useState2 = _slicedToArray(_useState, 2),
     windowSize = _useState2[0],
     setWindowSize = _useState2[1];
   useEffect(function () {
-    setWindowSize(window.innerWidth);
+    var _window;
+    setWindowSize((_window = window) === null || _window === void 0 ? void 0 : _window.innerWidth);
   }, []);
   useLayoutEffect(function () {
     /* istanbul ignore next */
@@ -49,10 +50,11 @@ var useStickyColumn = function useStickyColumn(hooks) {
   var useEventListener = function useEventListener(instance) {
     useEffect(function () {
       var tableBodyElement = tableBodyRef.current;
-      var headerCellElement = stickyHeaderCellRef.current;
+      var headerCellElement = stickyHeaderCellRef === null || stickyHeaderCellRef === void 0 ? void 0 : stickyHeaderCellRef.current;
       /* istanbul ignore next */
       if (hasVertScroll(tableBodyElement) && headerCellElement) {
-        headerCellElement.classList.add(OFFSET_SCROLL_CLASS);
+        var _headerCellElement$cl;
+        headerCellElement === null || headerCellElement === void 0 || (_headerCellElement$cl = headerCellElement.classList) === null || _headerCellElement$cl === void 0 || _headerCellElement$cl.add(OFFSET_SCROLL_CLASS);
       }
       var boundListener = debounce(onBodyResize.bind(null, tableBodyElement, headerCellElement), 250);
       /* istanbul ignore next */
@@ -74,7 +76,7 @@ var useStickyColumn = function useStickyColumn(hooks) {
       };
       toggleStickyShadow(tableBodyElement, headerCellElement);
       if (tableBodyElement) {
-        tableBodyElement.addEventListener('scroll', listener);
+        tableBodyElement === null || tableBodyElement === void 0 || tableBodyElement.addEventListener('scroll', listener);
       }
       return function () {
         if (tableBodyElement) {
@@ -138,18 +140,19 @@ var addTableBodyProps = function addTableBodyProps(tableBodyRef, props) {
   }];
 };
 var changeProps = function changeProps(elementName, headerCellRef, windowSize, props, data) {
-  var column = data.column || data.cell.column;
-  if (column.sticky === 'right') {
+  var _data$cell;
+  var column = data.column || ((_data$cell = data.cell) === null || _data$cell === void 0 ? void 0 : _data$cell.column);
+  if ((column === null || column === void 0 ? void 0 : column.sticky) === 'right') {
     return [props, _objectSpread2({
       className: cx(_defineProperty(_defineProperty(_defineProperty({}, "".concat(styleClassPrefix, "-").concat(elementName), true), "".concat(blockClass, "__resizableColumn"), false), "".concat(blockClass, "__sortableColumn"), false))
     }, headerCellRef && {
       ref: headerCellRef
     })];
   }
-  if (column.sticky === 'left') {
+  if ((column === null || column === void 0 ? void 0 : column.sticky) === 'left') {
     var _data$instance;
     return [props, _objectSpread2({
-      className: cx(_defineProperty(_defineProperty({}, "".concat(leftStickyStyleClassPrefix, "-").concat(elementName), windowSize > 671), "".concat(leftStickyStyleClassPrefix, "-").concat(elementName, "--with-extra-select-column"), (data === null || data === void 0 || (_data$instance = data.instance) === null || _data$instance === void 0 ? void 0 : _data$instance.withSelectRows) && windowSize > 671))
+      className: cx(_defineProperty(_defineProperty({}, "".concat(leftStickyStyleClassPrefix, "-").concat(elementName), windowSize && windowSize > 671), "".concat(leftStickyStyleClassPrefix, "-").concat(elementName, "--with-extra-select-column"), (data === null || data === void 0 || (_data$instance = data.instance) === null || _data$instance === void 0 ? void 0 : _data$instance.withSelectRows) && windowSize && windowSize > 671))
     }, headerCellRef && {
       ref: headerCellRef
     })];

package/es/components/Decorator/Decorator.js

@@ -87,7 +87,8 @@ Decorator.propTypes = {
    */
   small: PropTypes.bool,
   /**
-   * Determines the theme of the component.
+   * Override the default theme of the component.
+   * Useful if you want "invert" the component's theme.
    */
   theme: PropTypes.oneOf(['light', 'dark']),
   /**

package/es/components/DecoratorBase/DecoratorBase.js

@@ -23,8 +23,7 @@ var defaults = {
   onContextMenu: function onContextMenu() {},
   onContextMenuLabel: function onContextMenuLabel() {},
   onContextMenuValue: function onContextMenuValue() {},
-  scoreThresholds: [0, 4, 7, 10],
-  theme: 'light'
+  scoreThresholds: [0, 4, 7, 10]
 };
 
 /**
@@ -56,8 +55,7 @@ var DecoratorBase = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
     _ref$scoreThresholds = _ref.scoreThresholds,
     scoreThresholds = _ref$scoreThresholds === void 0 ? defaults.scoreThresholds : _ref$scoreThresholds,
     small = _ref.small,
-    _ref$theme = _ref.theme,
-    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    theme = _ref.theme,
     truncateValue = _ref.truncateValue,
     value = _ref.value,
     valueTitle = _ref.valueTitle,
@@ -67,7 +65,7 @@ var DecoratorBase = /*#__PURE__*/React__default.forwardRef(function (_ref, ref)
   var _value = truncate(value, truncateValue);
 
   // These class names apply to all types of DecoratorBase.
-  var classNames = cx(blockClass, className, "".concat(blockClass, "--").concat(theme), _defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(blockClass, "--sm"), small), "".concat(blockClass, "--truncate-end"), truncateValue === 'end'), "".concat(blockClass, "--truncate-start"), truncateValue === 'start'), "".concat(blockClass, "--truncate-midline"), truncateValue === null || truncateValue === void 0 ? void 0 : truncateValue.maxLength));
+  var classNames = cx(blockClass, className, _defineProperty(_defineProperty(_defineProperty(_defineProperty(_defineProperty({}, "".concat(blockClass, "--").concat(theme), theme), "".concat(blockClass, "--sm"), small), "".concat(blockClass, "--truncate-end"), truncateValue === 'end'), "".concat(blockClass, "--truncate-start"), truncateValue === 'start'), "".concat(blockClass, "--truncate-midline"), truncateValue === null || truncateValue === void 0 ? void 0 : truncateValue.maxLength));
 
   // These properties apply to all <DecoratorIcons>.
   var decoratorIconsProps = {

package/es/components/DecoratorDualButton/DecoratorDualButton.js

@@ -111,7 +111,8 @@ DecoratorDualButton.propTypes = {
    */
   small: PropTypes.bool,
   /**
-   * Determines the theme of the component.
+   * Override the default theme of the component.
+   * Useful if you want "invert" the component's theme.
    */
   theme: PropTypes.oneOf(['light', 'dark']),
   /**

package/es/components/DecoratorLink/DecoratorLink.js

@@ -101,7 +101,8 @@ DecoratorLink.propTypes = {
    */
   small: PropTypes.bool,
   /**
-   * Determines the theme of the component.
+   * Override the default theme of the component.
+   * Useful if you want "invert" the component's theme.
    */
   theme: PropTypes.oneOf(['light', 'dark']),
   /**

package/es/components/DecoratorSingleButton/DecoratorSingleButton.js

@@ -101,7 +101,8 @@ DecoratorSingleButton.propTypes = {
    */
   small: PropTypes.bool,
   /**
-   * Determines the theme of the component.
+   * Override the default theme of the component.
+   * Useful if you want "invert" the component's theme.
    */
   theme: PropTypes.oneOf(['light', 'dark']),
   /**

package/es/components/DelimitedList/DelimitedList.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { PropsWithChildren } from 'react';
-interface DelimitedListProps extends PropsWithChildren {
+export interface DelimitedListProps extends PropsWithChildren {
     /**
      * Provide an optional class to be applied to the containing node.
      */
@@ -28,4 +28,3 @@ interface DelimitedListProps extends PropsWithChildren {
  * comma-separated values.
  */
 export declare let DelimitedList: React.ForwardRefExoticComponent<DelimitedListProps & React.RefAttributes<HTMLDivElement>>;
-export {};

package/es/components/DelimitedList/index.d.ts

@@ -1 +1,8 @@
-export { DelimitedList } from "./DelimitedList";
+/**
+ * Copyright IBM Corp. 2024, 2024
+ *
+ * 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 { DelimitedList } from './DelimitedList';
+export type { DelimitedListProps } from './DelimitedList';

package/es/components/EditFullPage/EditFullPage.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import React, { ReactNode } from 'react';
-interface EditFullPageProps {
+export interface EditFullPageProps {
     /**
      * Provide an optional class to be applied to the containing node.
      */
@@ -20,4 +20,3 @@ interface EditFullPageProps {
  * See usage guidance for further details.
  */
 export declare let EditFullPage: React.ForwardRefExoticComponent<EditFullPageProps & React.RefAttributes<HTMLDivElement>>;
-export {};

package/es/components/EditFullPage/index.d.ts

@@ -1 +1,8 @@
-export { EditFullPage } from "./EditFullPage";
+/**
+ * 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 { EditFullPage } from './EditFullPage';
+export type { EditFullPageProps } from './EditFullPage';

package/es/components/EditInPlace/EditInPlace.d.ts

@@ -13,7 +13,7 @@ type Shape = {
     edit: AlignPropType;
     save: AlignPropType;
 };
-interface EditInplaceProps extends PropsWithChildren {
+export interface EditInplaceProps extends PropsWithChildren {
     /**
      * label for cancel button
      */
@@ -50,6 +50,10 @@ interface EditInplaceProps extends PropsWithChildren {
      * Provide the text that will be read by a screen reader when visiting this control
      */
     labelText: string;
+    /**
+     * handler to add custom onBlur event
+     */
+    onBlur?: (value: string) => void;
     /**
      * 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
      */
@@ -86,6 +90,10 @@ interface EditInplaceProps extends PropsWithChildren {
      * current value of the input
      */
     value: string;
+    /**
+     * placeholder for the input
+     */
+    placeholder?: string;
 }
 export declare let EditInPlace: React.ForwardRefExoticComponent<EditInplaceProps & React.RefAttributes<HTMLDivElement>>;
 export declare const deprecatedProps: {

package/es/components/EditInPlace/EditInPlace.js

@@ -5,17 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import { objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, typeof as _typeof, extends as _extends, defineProperty as _defineProperty, objectSpread2 as _objectSpread2 } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { objectSpread2 as _objectSpread2, objectWithoutProperties as _objectWithoutProperties, slicedToArray as _slicedToArray, typeof as _typeof, extends as _extends, defineProperty as _defineProperty } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import { WarningFilled, Close, Checkmark, Edit } from '@carbon/react/icons';
 import React__default, { forwardRef, useState, useRef, useEffect } from 'react';
+import { pkg, carbon } from '../../settings.js';
 import { IconButton } from '@carbon/react';
-import cx from 'classnames';
 import PropTypes from '../../node_modules/prop-types/index.js';
-import { WarningFilled, Close, Checkmark, Edit } from '@carbon/react/icons';
-import { pkg, carbon } from '../../settings.js';
+import cx from 'classnames';
 import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
 
 var _Close, _Checkmark, _Edit;
-var _excluded = ["cancelLabel", "editAlwaysVisible", "editLabel", "id", "inheritTypography", "invalid", "invalidLabel", "invalidText", "labelText", "onCancel", "onChange", "onSave", "saveLabel", "size", "tooltipAlignment", "value"];
+var _excluded = ["cancelLabel", "editAlwaysVisible", "editLabel", "id", "inheritTypography", "invalid", "invalidLabel", "invalidText", "labelText", "onCancel", "onChange", "onSave", "onBlur", "saveLabel", "size", "tooltipAlignment", "value", "placeholder"];
 var componentName = 'EditInPlace';
 var blockClass = "".concat(pkg.prefix, "--edit-in-place");
 var defaults = {
@@ -36,11 +36,13 @@ var EditInPlace = /*#__PURE__*/forwardRef(function (_ref, ref) {
     onCancel = _ref.onCancel,
     onChange = _ref.onChange,
     onSave = _ref.onSave,
+    onBlur = _ref.onBlur,
     saveLabel = _ref.saveLabel,
     _ref$size = _ref.size,
     size = _ref$size === void 0 ? 'sm' : _ref$size,
     tooltipAlignment = _ref.tooltipAlignment,
     value = _ref.value,
+    placeholder = _ref.placeholder,
     rest = _objectWithoutProperties(_ref, _excluded);
   var _useState = useState(false),
     _useState2 = _slicedToArray(_useState, 2),
@@ -93,25 +95,29 @@ var EditInPlace = /*#__PURE__*/forwardRef(function (_ref, ref) {
   };
   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) {
-    if (escaping.current) {
-      return;
-    }
-    if (!isTargetingChild(e)) {
-      if (canSave) {
-        onSaveHandler();
-      } else {
-        onCancelHandler();
+    // Use custom function provided if passed through
+    if (typeof onBlur === 'function' && !isTargetingChild(e)) {
+      onBlur(initialValue);
+      setFocused(false);
+    } else {
+      // Use Default behavior if no custom function provided
+      if (escaping.current) {
+        return;
+      }
+      if (!isTargetingChild(e)) {
+        if (canSave) {
+          onSaveHandler();
+        } else {
+          onCancelHandler();
+        }
       }
     }
   };
@@ -123,17 +129,21 @@ var EditInPlace = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var escapeHandler = function escapeHandler() {
     onCancelHandler();
   };
+  var removeFocus = function removeFocus() {
+    var _inputRef$current2;
+    (_inputRef$current2 = inputRef.current) === null || _inputRef$current2 === void 0 || _inputRef$current2.blur();
+    setFocused(false);
+  };
   var onKeyHandler = function onKeyHandler(e) {
-    var _inputRef$current2, _inputRef$current3;
     // 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$current2 = inputRef.current) === null || _inputRef$current2 === void 0 || _inputRef$current2.blur();
+        removeFocus();
         escapeHandler();
         break;
       case 'Enter':
-        (_inputRef$current3 = inputRef.current) === null || _inputRef$current3 === void 0 || _inputRef$current3.blur();
+        removeFocus();
         returnHandler();
         break;
     }
@@ -149,6 +159,7 @@ var EditInPlace = /*#__PURE__*/forwardRef(function (_ref, ref) {
     id: id,
     className: cx("".concat(blockClass, "__text-input"), "".concat(carbon.prefix, "--text-input"), "".concat(carbon.prefix, "--text-input--").concat(size)),
     type: "text",
+    placeholder: placeholder,
     value: value,
     onChange: onChangeHandler,
     ref: inputRef
@@ -251,6 +262,10 @@ EditInPlace.propTypes = _objectSpread2({
    * Provide the text that will be read by a screen reader when visiting this control
    */
   labelText: PropTypes.string.isRequired,
+  /**
+   * handler to add custom onBlur event
+   */
+  onBlur: PropTypes.func,
   /**
    * 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
    */
@@ -263,6 +278,10 @@ EditInPlace.propTypes = _objectSpread2({
    * 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,
+  /**
+   * Placeholder for text input
+   */
+  placeholder: PropTypes.string,
   /**
    * determines if the input is in readOnly mode
    */

package/es/components/EditInPlace/index.d.ts

@@ -1 +1,8 @@
-export { EditInPlace } from "./EditInPlace";
+/**
+ * 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 { EditInPlace } from './EditInPlace';
+export type { EditInplaceProps } from './EditInPlace';