@carbon/ibm-products 2.29.0-alpha.10 → 2.30.0-alpha.9

package/es/components/Decorator/Decorator.js

@@ -0,0 +1,348 @@
+/**
+ * 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 { objectWithoutProperties as _objectWithoutProperties, defineProperty as _defineProperty, extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+import { getMagnitude, truncate } from './utils.js';
+import { DecoratorIcon } from './DecoratorIcon.js';
+
+var _excluded = ["className", "disabled", "hideIcon", "href", "kind", "label", "setLabelTitle", "onClick", "onClickLabel", "onClickValue", "onContextMenu", "onContextMenuLabel", "onContextMenuValue", "score", "scoreThresholds", "small", "theme", "truncateValue", "value", "valueTitle"];
+var blockClass = "".concat(pkg.prefix, "--decorator");
+var componentName = 'Decorator';
+var defaults = {
+  kind: 'default',
+  onClick: function onClick() {},
+  onClickLabel: function onClickLabel() {},
+  onClickValue: function onClickValue() {},
+  onContextMenu: function onContextMenu() {},
+  onContextMenuLabel: function onContextMenuLabel() {},
+  onContextMenuValue: function onContextMenuValue() {},
+  scoreThresholds: [0, 4, 7, 10],
+  theme: 'light'
+};
+
+/**
+ * The Decorator groups a key/value pair to look and behave like a single UI element.
+ */
+var Decorator = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    disabled = _ref.disabled,
+    hideIcon = _ref.hideIcon,
+    href = _ref.href,
+    _ref$kind = _ref.kind,
+    kind = _ref$kind === void 0 ? defaults.kind : _ref$kind,
+    label = _ref.label,
+    setLabelTitle = _ref.setLabelTitle,
+    _ref$onClick = _ref.onClick,
+    onClick = _ref$onClick === void 0 ? defaults.onClick : _ref$onClick,
+    _ref$onClickLabel = _ref.onClickLabel,
+    onClickLabel = _ref$onClickLabel === void 0 ? defaults.onClickLabel : _ref$onClickLabel,
+    _ref$onClickValue = _ref.onClickValue,
+    onClickValue = _ref$onClickValue === void 0 ? defaults.onClickValue : _ref$onClickValue,
+    _ref$onContextMenu = _ref.onContextMenu,
+    onContextMenu = _ref$onContextMenu === void 0 ? defaults.onContextMenu : _ref$onContextMenu,
+    _ref$onContextMenuLab = _ref.onContextMenuLabel,
+    onContextMenuLabel = _ref$onContextMenuLab === void 0 ? defaults.onContextMenuLabel : _ref$onContextMenuLab,
+    _ref$onContextMenuVal = _ref.onContextMenuValue,
+    onContextMenuValue = _ref$onContextMenuVal === void 0 ? defaults.onContextMenuValue : _ref$onContextMenuVal,
+    score = _ref.score,
+    _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,
+    truncateValue = _ref.truncateValue,
+    value = _ref.value,
+    valueTitle = _ref.valueTitle,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var magnitude = getMagnitude(score, scoreThresholds);
+  var _labelTitle = setLabelTitle && setLabelTitle(score, scoreThresholds, magnitude);
+  var _value = truncate(value, truncateValue);
+
+  // These class names apply to all types of Decorator.
+  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));
+
+  // These properties apply to all <DecoratorIcons>.
+  var decoratorIconsProps = {
+    className: "".concat(blockClass, "__icon"),
+    magnitude: magnitude.toLowerCase(),
+    // e.g. "Medium" -> "medium"
+    small: small
+  };
+
+  // Optional callback functions if `kind` is "link" or "single-button".
+  var handleOnClick = function handleOnClick(event) {
+    onClick(event, {
+      score: score,
+      label: label,
+      value: value,
+      magnitude: magnitude
+    });
+  };
+  var handleOnContextMenu = function handleOnContextMenu(event) {
+    onContextMenu(event, {
+      score: score,
+      label: label,
+      value: value,
+      magnitude: magnitude
+    });
+  };
+
+  // RETURN DUAL BUTTONS
+  if (kind === 'dual-button') {
+    // Optional callback functions if `kind` is "dual-button" only.
+    var handleOnClickLabel = function handleOnClickLabel(event) {
+      onClickLabel(event, {
+        score: score,
+        label: label,
+        value: value,
+        magnitude: magnitude
+      });
+    };
+    var handleOnClickValue = function handleOnClickValue(event) {
+      onClickValue(event, {
+        score: score,
+        label: label,
+        value: value,
+        magnitude: magnitude
+      });
+    };
+    var handleOnContextMenuLabel = function handleOnContextMenuLabel(event) {
+      onContextMenuLabel(event, {
+        score: score,
+        label: label,
+        value: value,
+        magnitude: magnitude
+      });
+    };
+    var handleOnContextMenuValue = function handleOnContextMenuValue(event) {
+      onContextMenuValue(event, {
+        score: score,
+        label: label,
+        value: value,
+        magnitude: magnitude
+      });
+    };
+    return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, getDevtoolsProps(componentName), {
+      className: cx(classNames, "".concat(blockClass, "--buttons"), _defineProperty({}, "".concat(blockClass, "-disabled"), disabled)),
+      ref: ref
+    }), /*#__PURE__*/React__default.createElement("button", {
+      className: "".concat(blockClass, "__label"),
+      disabled: disabled,
+      onClick: !disabled && handleOnClickLabel,
+      onContextMenu: !disabled && handleOnContextMenuLabel,
+      title: _labelTitle || label,
+      type: "button"
+    }, !hideIcon && /*#__PURE__*/React__default.createElement(DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default.createElement("button", {
+      className: "".concat(blockClass, "__value"),
+      disabled: disabled,
+      onClick: !disabled && handleOnClickValue,
+      onContextMenu: !disabled && handleOnContextMenuValue,
+      title: valueTitle || value,
+      type: "button"
+    }, _value));
+  }
+
+  // RETURN SINGLE BUTTON
+  if (kind === 'single-button') {
+    return /*#__PURE__*/React__default.createElement("button", _extends({}, rest, getDevtoolsProps(componentName), {
+      className: cx(classNames, "".concat(blockClass, "--button"), _defineProperty({}, "".concat(blockClass, "-disabled"), disabled)),
+      disabled: disabled,
+      onClick: !disabled && handleOnClick,
+      onContextMenu: !disabled && handleOnContextMenu,
+      ref: ref,
+      type: "button"
+    }), /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(blockClass, "__label"),
+      title: _labelTitle || label
+    }, !hideIcon && /*#__PURE__*/React__default.createElement(DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(blockClass, "__value"),
+      title: valueTitle || value
+    }, _value));
+  }
+
+  // RETURN LINK
+  if (kind === 'link') {
+    return /*#__PURE__*/React__default.createElement("a", _extends({}, rest, getDevtoolsProps(componentName), {
+      href: href,
+      className: cx(classNames, "".concat(blockClass, "--link")),
+      onClick: handleOnClick,
+      onContextMenu: handleOnContextMenu,
+      ref: ref
+    }), /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(blockClass, "__label"),
+      title: _labelTitle || label
+    }, !hideIcon && /*#__PURE__*/React__default.createElement(DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(blockClass, "__value"),
+      title: valueTitle || value
+    }, _value));
+  }
+
+  // RETURN DEFAULT (NON-INTERACTIVE)
+  if (kind === 'default') {
+    return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, getDevtoolsProps(componentName), {
+      className: cx(classNames, "".concat(blockClass, "--default")),
+      ref: ref
+    }), /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(blockClass, "__label"),
+      title: _labelTitle || label
+    }, !hideIcon && /*#__PURE__*/React__default.createElement(DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default.createElement("span", {
+      className: "".concat(blockClass, "__value"),
+      title: valueTitle || value
+    }, _value));
+  }
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+Decorator = pkg.checkComponentEnabled(Decorator, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+Decorator.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+Decorator.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * `disabled` only applies if `kind` is "single-button" or "dual-button".
+   */
+  disabled: PropTypes.bool,
+  /**
+   * Do not show the icon, regardless of score.
+   */
+  hideIcon: PropTypes.bool,
+  /**
+   * `href` is req'd if `kind` is "link".
+   *
+   * These two properties together will render the `label` and `value` as a single anchor tag.
+   */
+  href: PropTypes.string,
+  /**
+   * If `kind` is "dual-button" then refer to the `onClickLabel`, `onClickValue`, `onContextMenuLabel`, and `onContextMenuValue` callback functions.
+   *
+   * If `kind` is "single-button" then refer to the `onClick` and `onContextMenu` callback functions.
+   *
+   * If `kind` is "link" then also populate `href`.
+   *
+   * `kind's` default value is "default" and has no other requirements.
+   */
+  kind: PropTypes.oneOf(['default', 'link', 'single-button', 'dual-button']),
+  /**
+   * The label for the data.
+   */
+  label: PropTypes.string,
+  /**
+   * Optional callback function if `kind` is "link" or "single-button".
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClick: PropTypes.func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClickLabel: PropTypes.func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClickValue: PropTypes.func,
+  /**
+   * Optional callback function if `kind` is "link" or "single-button".
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenu: PropTypes.func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenuLabel: PropTypes.func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenuValue: PropTypes.func,
+  /**
+   * Used in conjunction with `scoreThresholds`, determines the color, shape, and type of magnitude of the icon.
+   *
+   * If you don't want to show the icon at all, set `hideIcon={true}`.
+   */
+  score: PropTypes.number,
+  /**
+   * Used in conjunction with `score`, determines the color, shape, and type of magnitude of the icon.
+   *
+   * An array of 4 numbers determines the range of thresholds.
+   *
+   * Example using `[0, 4, 7, 10]`:
+   * <br/>- `<= 0` "Benign"
+   * <br/>- `1-3` "Low"
+   * <br/>- `4-6` "Medium"
+   * <br/>- `7-9` "High"
+   * <br/>- `>= 10` "Critical"
+   * <br/>- `NaN` "Unknown"
+   */
+  scoreThresholds: PropTypes.arrayOf(PropTypes.number),
+  /**
+   * Callback function for building the label's descriptive text for screen readers.
+   *
+   * The default description is in the form of `"(magnitude)" magnitude: score X out of Y"`.
+   * E.g. `"Medium" magnitude: score 5 out of 10`.
+   *
+   * Where `magnitude` is the label associated with the specific score,
+   * X is the `score`, and Y is the last element of the `setLabelTitle` array.
+   *
+   * If not defined, the title will default to the `label` prop.
+   */
+  setLabelTitle: PropTypes.func,
+  /**
+   * Styled smaller to better fit inline with text.
+   */
+  small: PropTypes.bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark']),
+  /**
+   * If not defined, it will behave as `display:inline-block`.
+   *
+   * If `end` it will append "..." to the `value` if there is not enough space.
+   *
+   * If `start` it will prepend "..." to the `value` if there is not enough space.
+   *
+   * If `{maxLength, front, back}` it will inject "..." in the middle
+   * of the `value` regardless of available space.
+   */
+  truncateValue: PropTypes.oneOfType([PropTypes.oneOf(['end', 'start']), PropTypes.shape({
+    maxLength: PropTypes.number,
+    front: PropTypes.number,
+    back: PropTypes.number
+  })]),
+  /**
+   * The value of the data.
+   */
+  value: PropTypes.string.isRequired,
+  /**
+   * Overrides the default title for the Decorator's value.
+   */
+  valueTitle: PropTypes.string
+};
+
+export { Decorator };

package/es/components/Decorator/DecoratorIcon.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The shape and color of the Decorator's icon.
+ */
+export let DecoratorIcon: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/Decorator/DecoratorIcon.js

@@ -0,0 +1,95 @@
+/**
+ * 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 { objectWithoutProperties as _objectWithoutProperties, extends as _extends, defineProperty as _defineProperty } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import cx from 'classnames';
+import { CircleStroke, ChevronMini, Caution, DiamondFill, SquareFill, CircleFill } from '@carbon/react/icons';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { pkg } from '../../settings.js';
+
+var _excluded = ["className", "magnitude", "small"];
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--decorator-icon");
+var componentName = 'DecoratorIcon';
+var defaults = {
+  magnitude: 'unknown',
+  small: false
+};
+
+/**
+ * The shape and color of the Decorator's icon.
+ */
+var DecoratorIcon = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    _ref$magnitude = _ref.magnitude,
+    magnitude = _ref$magnitude === void 0 ? defaults.magnitude : _ref$magnitude,
+    _ref$small = _ref.small,
+    small = _ref$small === void 0 ? defaults.small : _ref$small,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var Icon;
+  switch (magnitude) {
+    case 'benign':
+      Icon = CircleFill;
+      break;
+    case 'low':
+      Icon = SquareFill;
+      break;
+    case 'medium':
+      Icon = DiamondFill;
+      break;
+    case 'high':
+      Icon = Caution;
+      break;
+    case 'critical':
+      Icon = ChevronMini;
+      break;
+    default:
+      Icon = CircleStroke;
+      break;
+  }
+  return /*#__PURE__*/React__default.createElement(Icon, _extends({}, rest, {
+    "aria-hidden": true,
+    className: cx(blockClass, className, "".concat(blockClass, "__magnitude-").concat(magnitude), _defineProperty({}, "".concat(blockClass, "--sm"), small)),
+    focusable: false,
+    ref: ref
+    // Adding viewBox allows resizing `svg` elements via CSS.
+    // The "ChevronMini" icon is half size,
+    //   so set to '8 8 8 8' to match the size of the other icons.
+    ,
+    viewBox: magnitude === 'critical' ? '8 8 8 8' : '0 0 16 16'
+  }, getDevtoolsProps(componentName)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+DecoratorIcon = pkg.checkComponentEnabled(DecoratorIcon, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+DecoratorIcon.displayName = componentName;
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+DecoratorIcon.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * Determines the shape and color of the icon.
+   */
+  magnitude: PropTypes.oneOf(['unknown', 'benign', 'low', 'medium', 'high', 'critical']),
+  /**
+   * Reduce the size of the icon in proportion to a smaller Decorator.
+   */
+  small: PropTypes.bool
+};
+
+export { DecoratorIcon };

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

@@ -0,0 +1 @@
+export { Decorator } from "./Decorator";

package/es/components/Decorator/utils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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 function getMagnitude(score: any, thresholds: any): "Medium" | "Unknown" | "Benign" | "Low" | "High" | "Critical";
+export function truncate(inputText: any, truncateValue?: {}): any;

package/es/components/Decorator/utils.js

@@ -0,0 +1,43 @@
+/**
+ * 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 getMagnitude = function getMagnitude(score, thresholds) {
+  if (typeof score === 'number') {
+    if (score <= thresholds[0]) {
+      return 'Benign';
+    }
+    if (score < thresholds[1]) {
+      return 'Low';
+    }
+    if (score < thresholds[2]) {
+      return 'Medium';
+    }
+    if (score < thresholds[3]) {
+      return 'High';
+    }
+    if (score >= thresholds[3]) {
+      return 'Critical';
+    }
+  }
+  return 'Unknown';
+};
+
+// If a "midline" truncation has been defined,
+// then return the formatted midline value generated here,
+// else return to the original value.
+var truncate = function truncate(inputText) {
+  var truncateValue = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+  var maxLength = truncateValue.maxLength,
+    front = truncateValue.front,
+    back = truncateValue.back;
+  if (maxLength && inputText.length > maxLength) {
+    return "".concat(inputText.substring(0, front), "\u2026").concat(inputText.substr(inputText.length - back));
+  }
+  return inputText;
+};
+
+export { getMagnitude, truncate };

package/es/components/Toolbar/ToolbarButton.d.ts

@@ -1,4 +1,25 @@
-export const blockClass: string;
-/** Toolbar buttons are common functions performed as part of a products interface or an open window.  */
-export let ToolbarButton: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+/**
+ * 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.
+ */
+/// <reference path="../../../src/custom-typings/index.d.ts" />
+import { IconButton } from '@carbon/react';
 import React from 'react';
+export declare const blockClass: string;
+interface ToolbarButtonProps extends React.ComponentProps<typeof IconButton> {
+    /** Determines whether the caret is rendered */
+    caret?: boolean;
+    /** Provide an optional class to be applied to the containing node */
+    className?: string;
+    /** Specifies the label for the icon button */
+    iconDescription: string;
+    /** Specifies the icon to be used by the ToolbarButton component */
+    renderIcon: React.ElementType;
+}
+/** Toolbar buttons are common functions performed as part of a products interface or an open window.  */
+export declare let ToolbarButton: React.ForwardRefExoticComponent<ToolbarButtonProps & {
+    children?: React.ReactNode;
+} & React.RefAttributes<unknown>>;
+export {};

package/es/components/Toolbar/ToolbarButton.js

@@ -15,11 +15,11 @@ import { ToolbarContext, blockClass as blockClass$1 } from './Toolbar.js';
 
 var _excluded = ["caret", "children", "className", "renderIcon", "iconDescription"];
 var blockClass = "".concat(blockClass$1, "__button");
-
 /** Toolbar buttons are common functions performed as part of a products interface or an open window.  */
 var ToolbarButton = /*#__PURE__*/forwardRef(function (_ref, ref) {
   var _useContext;
-  var caret = _ref.caret,
+  var _ref$caret = _ref.caret,
+    caret = _ref$caret === void 0 ? false : _ref$caret,
     children = _ref.children,
     className = _ref.className,
     renderIcon = _ref.renderIcon,

package/es/components/index.d.ts

@@ -40,6 +40,7 @@ export { InterstitialScreen } from "./InterstitialScreen";
 export { InterstitialScreenView } from "./InterstitialScreenView";
 export { InterstitialScreenViewModule } from "./InterstitialScreenViewModule";
 export { DelimitedList } from "./DelimitedList";
+export { Decorator } from "./Decorator";
 export { DescriptionList } from "./DescriptionList";
 export { FullPageError } from "./FullPageError";
 export { SearchBar } from "./SearchBar";

package/es/global/js/package-settings.d.ts

@@ -89,6 +89,7 @@ declare namespace defaults {
         let CoachmarkOverlayElement: boolean;
         let CoachmarkOverlayElements: boolean;
         let CoachmarkStack: boolean;
+        let Decorator: boolean;
         let DescriptionList: boolean;
         let SearchBar: boolean;
         let UserAvatar: boolean;

package/es/global/js/package-settings.js

@@ -91,6 +91,7 @@ var defaults = {
     CoachmarkOverlayElement: false,
     CoachmarkOverlayElements: false,
     CoachmarkStack: false,
+    Decorator: false,
     DescriptionList: false,
     SearchBar: false,
     UserAvatar: false,

package/es/index.js

@@ -105,6 +105,7 @@ export { InterstitialScreen } from './components/InterstitialScreen/Interstitial
 export { InterstitialScreenView } from './components/InterstitialScreenView/InterstitialScreenView.js';
 export { InterstitialScreenViewModule } from './components/InterstitialScreenViewModule/InterstitialScreenViewModule.js';
 export { DelimitedList } from './components/DelimitedList/DelimitedList.js';
+export { Decorator } from './components/Decorator/Decorator.js';
 export { DescriptionList } from './components/DescriptionList/DescriptionList.js';
 export { FullPageError } from './components/FullPageError/FullPageError.js';
 export { SearchBar } from './components/SearchBar/SearchBar.js';

package/es/settings.d.ts

@@ -75,6 +75,7 @@ export const pkg: {
         CoachmarkOverlayElement: boolean;
         CoachmarkOverlayElements: boolean;
         CoachmarkStack: boolean;
+        Decorator: boolean;
         DescriptionList: boolean;
         SearchBar: boolean;
         UserAvatar: boolean;

package/lib/components/AboutModal/AboutModal.d.ts

@@ -1,3 +1,74 @@
+/**
+ * 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, { ReactNode } from 'react';
+interface AboutModalProps {
+    /**
+     * If you are legally required to display logos of technologies used
+     * to build your product you can provide this in the additionalInfo.
+     * Additional information will be displayed in the footer.
+     */
+    additionalInfo?: ReactNode;
+    /**
+     * Provide an optional class to be applied to the modal root node.
+     */
+    className?: string;
+    /**
+     * The accessibility title for the close icon.
+     */
+    closeIconDescription: string;
+    /**
+     * Subhead text providing any relevant product disclaimers including
+     * legal information (optional)
+     */
+    content?: ReactNode;
+    /**
+     * Trademark and copyright information. Displays first year of
+     * product release to current year.
+     */
+    copyrightText: string;
+    /**
+     * An array of Carbon `Link` component if there are additional information
+     * to call out within the card. The about modal should be used to display
+     * the product information and not where users go to find help (optional)
+     */
+    links?: ReactNode[];
+    /**
+     * A visual symbol used to represent the product.
+     */
+    logo: ReactNode;
+    /**
+     * Specifies aria label for AboutModal
+     */
+    modalAriaLabel?: string;
+    /**
+     * Specifies an optional handler which is called when the AboutModal
+     * is closed. Returning `false` prevents the AboutModal from closing.
+     */
+    onClose?: () => void | boolean;
+    /**
+     * Specifies whether the AboutModal is open or not.
+     */
+    open?: boolean;
+    /**
+     * The DOM node the tearsheet should be rendered within. Defaults to document.body.
+     */
+    portalTarget?: ReactNode;
+    /**
+     * Header text that provides the product name. The IBM Services logo
+     * consists of two discrete, but required, elements: the iconic
+     * IBM 8-bar logo represented alongside the IBM Services logotype.
+     * Please follow these guidelines to ensure proper execution.
+     */
+    title: ReactNode;
+    /**
+     * Text that provides information on the version number of your product.
+     */
+    version: string;
+}
 /**
  * The `AboutModal` component provides a way to communicate product information
  * to users. It is triggered by a user’s action, appears on top of the main
@@ -5,5 +76,5 @@
  * should be immediately apparent to the user, with a clear and obvious path
  * to completion.
  */
-export let AboutModal: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
-import React from 'react';
+export declare let AboutModal: React.ForwardRefExoticComponent<AboutModalProps & React.RefAttributes<HTMLDivElement>>;
+export {};