@carbon/ibm-products 2.36.0-alpha.27 → 2.37.0

package/es/components/UserProfileImage/UserProfileImage.js

@@ -17,7 +17,6 @@ import { usePrefix, Tooltip } from '@carbon/react';
 import { TooltipTrigger } from '../TooltipTrigger/TooltipTrigger.js';
 
 var _excluded = ["backgroundColor", "className", "kind", "icon", "initials", "image", "imageDescription", "size", "theme", "tooltipText", "tooltipAlignment"];
-
 // The block part of our conventional BEM class names (blockClass__E--M).
 var blockClass = "".concat(pkg.prefix, "--user-profile-image");
 var componentName = 'UserProfileImage';
@@ -84,12 +83,13 @@ var UserProfileImage = /*#__PURE__*/React__default.forwardRef(function (_ref, re
     }
   };
   var formatInitials = function formatInitials() {
-    if (initials.length === 2) {
+    var _match;
+    if (initials && initials.length === 2) {
       return initials;
     }
     // RegEx takes in the display name and returns the first and last initials. Thomas Watson and Thomas J. Watson
     // both return JW.
-    return initials.match(/(^\S\S?|\b\S)?/g).join('').match(/(^\S|\S$)?/g).join('').toUpperCase();
+    return ((_match = (initials || '').match(/(^\S\S?|\b\S)?/g)) === null || _match === void 0 || (_match = _match.join('').match(/(^\S|\S$)?/g)) === null || _match === void 0 ? void 0 : _match.join('').toUpperCase()) || '';
   };
   var getFillItem = function getFillItem() {
     if (image) {
@@ -149,10 +149,12 @@ UserProfileImage.propTypes = {
   /**
    * When passing the image prop, supply a full path to the image to be displayed.
    */
+  /**@ts-ignore */
   image: PropTypes.string,
   /**
    * When passing the image prop use the imageDescription prop to describe the image for screen reader.
    */
+  /**@ts-ignore */
   imageDescription: PropTypes.string.isRequired.if(function (_ref2) {
     var image = _ref2.image;
     return !!image;

package/es/components/WebTerminal/WebTerminal.d.ts

@@ -1,5 +1,49 @@
+/**
+ * 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.
+ */
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+import React, { PropsWithChildren, ReactNode } from 'react';
+import { OverflowMenuItem } from '@carbon/react';
+interface Action {
+    renderIcon: () => void;
+    onClick: () => void;
+    iconDescription: string;
+}
+interface WebTerminalProps extends PropsWithChildren {
+    /**
+     * Provide your own terminal component as children to show up in the web terminal
+     */
+    children: ReactNode | ReactNode[];
+    /**
+     * An array of actions to be displayed in the web terminal header bar
+     */
+    actions?: readonly Action[];
+    /**
+     * Custom classname for additional styling of the web terminal
+     */
+    className?: string;
+    /**
+     * Icon description for the close button
+     */
+    closeIconDescription: string;
+    /**
+     * Array of objects for each documentation link. Each documentation link uses the prop types of OverflowMenuItems. See more: https://react.carbondesignsystem.com/?path=/docs/components-overflowmenu--default
+     */
+    documentationLinks?: readonly OverflowMenuItem[];
+    /**
+     * Description for the documentation link overflow menu tooltip
+     */
+    documentationLinksIconDescription?: string;
+    /**
+     * Optionally pass if the web terminal should be open by default
+     */
+    isInitiallyOpen?: boolean;
+}
 /**
  * The `WebTerminal` is prompted by the user and is persistent until dismissed. The purpose of a web terminal is to provide users with the ability to type commands manually instead of using the GUI.
  */
-export let WebTerminal: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let WebTerminal: React.ForwardRefExoticComponent<WebTerminalProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/es/components/WebTerminal/WebTerminal.js

@@ -29,7 +29,6 @@ var defaults = {
   documentationLinksIconDescription: 'Show documentation links',
   isInitiallyOpen: false
 };
-
 /**
  * The `WebTerminal` is prompted by the user and is persistent until dismissed. The purpose of a web terminal is to provide users with the ability to type commands manually instead of using the GUI.
  */
@@ -99,7 +98,7 @@ var WebTerminal = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
     ref: ref,
     className: cx([blockClass, className, _defineProperty(_defineProperty({}, "".concat(blockClass, "--open"), open), "".concat(blockClass, "--closed"), !open)]),
     style: {
-      animation: !prefersReducedMotion && webTerminalAnimationName
+      animation: !prefersReducedMotion ? webTerminalAnimationName : ''
     },
     onAnimationEnd: onAnimationEnd
   }), /*#__PURE__*/React__default.createElement("header", {
@@ -168,6 +167,7 @@ WebTerminal.propTypes = {
   /**
    * An array of actions to be displayed in the web terminal header bar
    */
+  /**@ts-ignore */
   actions: PropTypes.arrayOf(PropTypes.shape({
     renderIcon: PropTypes.func.isRequired,
     onClick: PropTypes.func.isRequired,

package/es/global/js/hooks/usePrefersReducedMotion.d.ts

@@ -0,0 +1,2 @@
+export default usePrefersReducedMotion;
+declare function usePrefersReducedMotion(): boolean;

package/es/global/js/hooks/usePrefersReducedMotion.js

@@ -0,0 +1,28 @@
+/**
+ * Copyright IBM Corp. 2020, 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 { slicedToArray as _slicedToArray } from '../../../_virtual/_rollupPluginBabelHelpers.js';
+import { useState, useEffect } from 'react';
+import { hasDocument } from '../utils/window.js';
+
+var usePrefersReducedMotion = function usePrefersReducedMotion() {
+  var _useState = useState(false),
+    _useState2 = _slicedToArray(_useState, 2),
+    prefersReducedMotion = _useState2[0],
+    setPrefersReducedMotion = _useState2[1];
+  useEffect(function () {
+    if (hasDocument()) {
+      var _window$matchMedia = window.matchMedia('(prefers-reduced-motion: reduce)'),
+        matches = _window$matchMedia.matches;
+      setPrefersReducedMotion(matches);
+    }
+  }, []);
+  return prefersReducedMotion;
+};
+var usePrefersReducedMotion$1 = usePrefersReducedMotion;
+
+export { usePrefersReducedMotion$1 as default };

package/es/global/js/utils/Wrap.d.ts

@@ -1,3 +1,32 @@
+/**
+ * Copyright IBM Corp. 2021, 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 React, { ElementType, PropsWithChildren, ReactNode } from 'react';
+interface WrapProps extends PropsWithChildren {
+    /**
+     * Specify whether the wrapper element should render even if there are no
+     * children or the children are themselves empty wrappers. Useful if there
+     * are some conditions in which the wrapper element is still required. Note
+     * that this prop takes precedence over neverRender if both are set to true.
+     */
+    alwaysRender?: boolean | null;
+    /**
+     * The element name or component to use as a wrapper for the content.
+     */
+    element?: (() => ReactNode) | string | ElementType;
+    /**
+     * Specify whether nothing should be rendered even if there are children
+     * in the content. Useful if there are some circumstances in which the
+     * component should not render at all. Note that if alwaysRender is also
+     * set to true then it will take precedence and the wrapper element and
+     * content will be rendered.
+     */
+    neverRender?: boolean;
+    className?: string;
+}
 /**
  * A simple conditional wrapper that encloses its children in a <div> (or other
  * element if specified), passing any supplied attributes to the <div> (or other
@@ -8,5 +37,5 @@
  * the ref.current will be set to the wrapper element if it renders, and will
  * remain undefined if it does not render.
  */
-export const Wrap: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare const Wrap: React.ForwardRefExoticComponent<WrapProps & React.RefAttributes<HTMLElement>>;
+export {};

package/es/global/js/utils/Wrap.js

@@ -9,7 +9,7 @@ import { objectWithoutProperties as _objectWithoutProperties, extends as _extend
 import React__default from 'react';
 import PropTypes from '../../../node_modules/prop-types/index.js';
 
-var _excluded = ["alwaysRender", "children", "element", "neverRender"];
+var _excluded = ["alwaysRender", "children", "element", "neverRender", "className"];
 
 // Examine a flat array of children to decide whether it is effectively empty.
 // If there are no children, or all the children are falsy, or all the non-falsy
@@ -24,12 +24,6 @@ var isEmpty = function isEmpty(children) {
   });
   return result;
 };
-
-// Default values for props
-var defaults = {
-  element: 'div'
-};
-
 /**
  * A simple conditional wrapper that encloses its children in a <div> (or other
  * element if specified), passing any supplied attributes to the <div> (or other
@@ -44,10 +38,13 @@ var Wrap = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
   var alwaysRender = _ref.alwaysRender,
     children = _ref.children,
     _ref$element = _ref.element,
-    Wrapper = _ref$element === void 0 ? defaults.element : _ref$element,
+    Wrapper = _ref$element === void 0 ? 'div' : _ref$element,
     neverRender = _ref.neverRender,
+    className = _ref.className,
     rest = _objectWithoutProperties(_ref, _excluded);
-  return (neverRender || isEmpty(children)) && !alwaysRender ? null : /*#__PURE__*/React__default.createElement(Wrapper, _extends({}, rest, {
+  return (neverRender || isEmpty(children)) && !alwaysRender ? null : /*#__PURE__*/React__default.createElement(Wrapper, _extends({
+    className: className
+  }, rest, {
     ref: ref
   }), children);
 });
@@ -66,6 +63,7 @@ Wrap.propTypes = {
    * components that decide not to render, nothing will be rendered in the DOM.
    */
   children: PropTypes.node,
+  className: PropTypes.string,
   /**
    * The element name or component to use as a wrapper for the content.
    */

package/es/global/js/utils/getNodeTextContent.d.ts

@@ -1 +1 @@
-export function getNodeTextContent(node: Node): string;
+export function getNodeTextContent(node: ReactNode): string;

package/es/global/js/utils/getNodeTextContent.js

@@ -25,7 +25,7 @@ import { typeof as _typeof } from '../../../_virtual/_rollupPluginBabelHelpers.j
  *          <li>Item 3</li>
  *        </ul>
  *        --> "Item 1Item 2Item 3"
- * @param {Node} node A React node
+ * @param {ReactNode} node A React node
  * @returns {string}
  */
 var getNodeTextContent = function getNodeTextContent(node) {

package/es/global/js/utils/window.d.ts

@@ -0,0 +1,2 @@
+export function hasDocument(): boolean;
+export function hasWindow(): boolean;

package/es/global/js/utils/window.js

@@ -0,0 +1,12 @@
+/**
+ * Copyright IBM Corp. 2020, 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.
+ */
+
+var hasDocument = function hasDocument() {
+  return typeof document !== 'undefined';
+};
+
+export { hasDocument };