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

package/lib/components/UserProfileImage/UserProfileImage.d.ts

@@ -1,5 +1,69 @@
 /**
- * The user profile avatar allows for an image of the user to be displayed by passing in the image prop. By default the component will display a user icon on a blue background.
+ * Copyright IBM Corp. 2021, 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.
  */
-export let UserProfileImage: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+/// <reference path="../../../src/custom-typings/index.d.ts" />
 import React from 'react';
+import { CarbonIconType } from '@carbon/icons-react/lib/CarbonIcon';
+import '../../global/js/utils/props-helper';
+import { IconButton } from '@carbon/react';
+type imageProps = {
+    /**
+     * When passing the image prop, supply a full path to the image to be displayed.
+     */
+    image: string;
+    /**
+     * When passing the image prop use the imageDescription prop to describe the image for screen reader.
+     */
+    imageDescription: string;
+} | {
+    image?: never;
+    imageDescription?: never;
+};
+type UserProfileImageBaseProps = {
+    /**
+     * The background color passed should match one of the background colors in the library documentation:
+     * https://pages.github.ibm.com/cdai-design/pal/patterns/user-profile-images/
+     */
+    backgroundColor?: string;
+    /**
+     * Provide an optional class to be applied to the containing node.
+     */
+    className?: string;
+    /**
+     * Provide a custom icon to use if you need to use an icon other than the included ones
+     */
+    icon?: () => CarbonIconType | null;
+    /**
+     * When passing the initials prop, either send the initials to be used or the user's display name. The first two capital letters of the display name will be used as the initials.
+     */
+    initials?: string;
+    /**
+     * When passing the kind prop, use either "user" or "group". The values match up to the Carbon Library icons.
+     */
+    kind?: 'user' | 'group';
+    /**
+     * Set the size of the avatar circle
+     */
+    size: 'xl' | 'lg' | 'md';
+    /**
+     * Set theme in which the component will be rendered
+     */
+    theme: 'light' | 'dark';
+    /**
+     * Specify how the trigger should align with the tooltip
+     */
+    tooltipAlignment?: React.ComponentProps<typeof IconButton>['align'];
+    /**
+     * Pass in the display name to have it shown on hover
+     */
+    tooltipText?: string;
+};
+type UserProfileImageProps = UserProfileImageBaseProps & imageProps;
+/**
+ * The user profile avatar allows for an image of the user to be displayed by passing in the image prop. By default the component will display a user icon on a blue background.
+ */
+export declare let UserProfileImage: React.ForwardRefExoticComponent<UserProfileImageProps & React.RefAttributes<HTMLDivElement>>;
+export {};

package/lib/components/UserProfileImage/UserProfileImage.js

@@ -26,7 +26,6 @@ var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
 
 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(settings.pkg.prefix, "--user-profile-image");
 var componentName = 'UserProfileImage';
@@ -93,12 +92,13 @@ exports.UserProfileImage = /*#__PURE__*/React__default["default"].forwardRef(fun
     }
   };
   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) {
@@ -158,10 +158,12 @@ exports.UserProfileImage.propTypes = {
   /**
    * When passing the image prop, supply a full path to the image to be displayed.
    */
+  /**@ts-ignore */
   image: index["default"].string,
   /**
    * When passing the image prop use the imageDescription prop to describe the image for screen reader.
    */
+  /**@ts-ignore */
   imageDescription: index["default"].string.isRequired.if(function (_ref2) {
     var image = _ref2.image;
     return !!image;

package/lib/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/lib/components/WebTerminal/WebTerminal.js

@@ -38,7 +38,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.
  */
@@ -108,7 +107,7 @@ exports.WebTerminal = /*#__PURE__*/React__default["default"].forwardRef(function
     ref: ref,
     className: cx__default["default"]([blockClass, className, _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "--open"), open), "".concat(blockClass, "--closed"), !open)]),
     style: {
-      animation: !prefersReducedMotion && webTerminalAnimationName
+      animation: !prefersReducedMotion ? webTerminalAnimationName : ''
     },
     onAnimationEnd: onAnimationEnd
   }), /*#__PURE__*/React__default["default"].createElement("header", {
@@ -177,6 +176,7 @@ exports.WebTerminal.propTypes = {
   /**
    * An array of actions to be displayed in the web terminal header bar
    */
+  /**@ts-ignore */
   actions: index$1["default"].arrayOf(index$1["default"].shape({
     renderIcon: index$1["default"].func.isRequired,
     onClick: index$1["default"].func.isRequired,

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

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

package/lib/global/js/hooks/usePrefersReducedMotion.js

@@ -0,0 +1,32 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _rollupPluginBabelHelpers = require('../../../_virtual/_rollupPluginBabelHelpers.js');
+var React = require('react');
+var window$1 = require('../utils/window.js');
+
+var usePrefersReducedMotion = function usePrefersReducedMotion() {
+  var _useState = React.useState(false),
+    _useState2 = _rollupPluginBabelHelpers.slicedToArray(_useState, 2),
+    prefersReducedMotion = _useState2[0],
+    setPrefersReducedMotion = _useState2[1];
+  React.useEffect(function () {
+    if (window$1.hasDocument()) {
+      var _window$matchMedia = window.matchMedia('(prefers-reduced-motion: reduce)'),
+        matches = _window$matchMedia.matches;
+      setPrefersReducedMotion(matches);
+    }
+  }, []);
+  return prefersReducedMotion;
+};
+var usePrefersReducedMotion$1 = usePrefersReducedMotion;
+
+exports["default"] = usePrefersReducedMotion$1;

package/lib/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/lib/global/js/utils/Wrap.js

@@ -17,7 +17,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
 
-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
@@ -32,12 +32,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
@@ -52,10 +46,13 @@ var Wrap = /*#__PURE__*/React__default["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 = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
-  return (neverRender || isEmpty(children)) && !alwaysRender ? null : /*#__PURE__*/React__default["default"].createElement(Wrapper, _rollupPluginBabelHelpers["extends"]({}, rest, {
+  return (neverRender || isEmpty(children)) && !alwaysRender ? null : /*#__PURE__*/React__default["default"].createElement(Wrapper, _rollupPluginBabelHelpers["extends"]({
+    className: className
+  }, rest, {
     ref: ref
   }), children);
 });
@@ -74,6 +71,7 @@ Wrap.propTypes = {
    * components that decide not to render, nothing will be rendered in the DOM.
    */
   children: index["default"].node,
+  className: index["default"].string,
   /**
    * The element name or component to use as a wrapper for the content.
    */

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

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

package/lib/global/js/utils/getNodeTextContent.js

@@ -29,7 +29,7 @@ var _rollupPluginBabelHelpers = require('../../../_virtual/_rollupPluginBabelHel
  *          <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/lib/global/js/utils/window.d.ts

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

package/lib/global/js/utils/window.js

@@ -0,0 +1,16 @@
+/**
+ * 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.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var hasDocument = function hasDocument() {
+  return typeof document !== 'undefined';
+};
+
+exports.hasDocument = hasDocument;