@carbon/ibm-products 2.31.0-alpha.5 → 2.31.1

package/es/components/DecoratorBase/DecoratorBase.js

@@ -0,0 +1,233 @@
+/**
+ * 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 { 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 = 'DecoratorBase';
+var defaults = {
+  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 DecoratorBase groups a key/value pair to look and behave like a single UI element.
+ *
+ * DecoratorBase is for internal use only. Refer to the other Decorator types as components for your app.
+ */
+var DecoratorBase = /*#__PURE__*/React__default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    disabled = _ref.disabled,
+    hideIcon = _ref.hideIcon,
+    href = _ref.href,
+    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 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));
+
+  // These properties apply to all <DecoratorIcons>.
+  var decoratorIconsProps = {
+    className: "".concat(blockClass, "__icon"),
+    magnitude: magnitude.toLowerCase(),
+    // e.g. "Medium" -> "medium"
+    small: small
+  };
+
+  // Optional callback functions specific to "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 specific to "dual-button".
+    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, {
+      className: cx(classNames, "".concat(blockClass, "--dual-button"), _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, {
+      className: cx(classNames, "".concat(blockClass, "--single-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, {
+      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)
+  return /*#__PURE__*/React__default.createElement("span", _extends({}, rest, {
+    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));
+});
+DecoratorBase.displayName = componentName;
+
+// See the other Decorator types for detailed, context-specific comments.
+DecoratorBase.propTypes = {
+  className: PropTypes.string,
+  disabled: PropTypes.bool,
+  hideIcon: PropTypes.bool,
+  href: PropTypes.string,
+  /**
+   * `kind` differentiates between each type of Decorator, and is for internal use only.
+   */
+  kind: PropTypes.oneOf(['default', 'link', 'single-button', 'dual-button']),
+  label: PropTypes.string,
+  onClick: PropTypes.func,
+  onClickLabel: PropTypes.func,
+  onClickValue: PropTypes.func,
+  onContextMenu: PropTypes.func,
+  onContextMenuLabel: PropTypes.func,
+  onContextMenuValue: PropTypes.func,
+  score: PropTypes.number,
+  scoreThresholds: PropTypes.arrayOf(PropTypes.number),
+  setLabelTitle: PropTypes.func,
+  small: PropTypes.bool,
+  theme: PropTypes.oneOf(['light', 'dark']),
+  truncateValue: PropTypes.oneOfType([PropTypes.oneOf(['end', 'start']), PropTypes.shape({
+    maxLength: PropTypes.number,
+    front: PropTypes.number,
+    back: PropTypes.number
+  })]),
+  value: PropTypes.string.isRequired,
+  valueTitle: PropTypes.string
+};
+
+export { DecoratorBase };

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

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

package/{lib/components/Decorator → es/components/DecoratorBase}/utils.d.ts

@@ -5,4 +5,4 @@
  * 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;
+export function truncate(inputText: any, truncateValue: any): any;

package/es/components/{Decorator → DecoratorBase}/utils.js

@@ -6,31 +6,31 @@
  */
 
 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';
-    }
+  if (typeof score !== 'number') {
+    return 'Unknown';
   }
-  return 'Unknown';
+  if (score <= thresholds[0]) {
+    return 'Benign';
+  }
+  if (score < thresholds[1]) {
+    return 'Low';
+  }
+  if (score < thresholds[2]) {
+    return 'Medium';
+  }
+  if (score < thresholds[3]) {
+    return 'High';
+  }
+  return 'Critical';
 };
 
 // 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 truncate = function truncate(inputText, truncateValue) {
+  if (!truncateValue) {
+    return inputText;
+  }
   var maxLength = truncateValue.maxLength,
     front = truncateValue.front,
     back = truncateValue.back;

package/es/components/DecoratorDualButton/DecoratorDualButton.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The DecoratorDualButton groups a key/value pair where the key and value each behave like a button.
+ */
+export let DecoratorDualButton: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/DecoratorDualButton/DecoratorDualButton.js

@@ -0,0 +1,135 @@
+/**
+ * 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 { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { prepareProps } from '../../global/js/utils/props-helper.js';
+import { pkg } from '../../settings.js';
+import { DecoratorBase } from '../DecoratorBase/DecoratorBase.js';
+
+var componentName = 'DecoratorDualButton';
+
+/**
+ * The DecoratorDualButton groups a key/value pair where the key and value each behave like a button.
+ */
+var DecoratorDualButton = /*#__PURE__*/React__default.forwardRef(function (props, ref) {
+  var validProps = prepareProps(props, ['href', 'kind', 'onClick', 'onContextMenu']);
+  return /*#__PURE__*/React__default.createElement(DecoratorBase, _extends({
+    ref: ref
+  }, validProps, {
+    kind: "dual-button"
+  }, getDevtoolsProps(componentName)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+DecoratorDualButton = pkg.checkComponentEnabled(DecoratorDualButton, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+DecoratorDualButton.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.
+DecoratorDualButton.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,
+  /**
+   * The label for the data.
+   */
+  label: PropTypes.string,
+  /**
+   * Optional callback function.
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClickLabel: PropTypes.func,
+  /**
+   * Optional callback function.
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClickValue: PropTypes.func,
+  /**
+   * Optional callback function.
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenuLabel: PropTypes.func,
+  /**
+   * Optional callback function.
+   * 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),
+  /**
+   * Optional callback function for building a more detailed descriptive text.
+   * Returns `score`, `scoreThresholds`, `magnitude`.
+   *
+   * Typical description is in the form of
+   * '"(magnitude)" magnitude: score (score) out of (last element of scoreThresholds array)'.
+   *
+   * E.g. `"Medium" magnitude: score 5 out of 10`.
+   *
+   * 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`.
+   */
+  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 { DecoratorDualButton };

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

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

package/es/components/DecoratorLink/DecoratorLink.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The DecoratorLink groups a key/value pair to behave like a link.
+ */
+export let DecoratorLink: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';

package/es/components/DecoratorLink/DecoratorLink.js

@@ -0,0 +1,125 @@
+/**
+ * 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 { extends as _extends } from '../../_virtual/_rollupPluginBabelHelpers.js';
+import React__default from 'react';
+import PropTypes from '../../node_modules/prop-types/index.js';
+import { getDevtoolsProps } from '../../global/js/utils/devtools.js';
+import { prepareProps } from '../../global/js/utils/props-helper.js';
+import { pkg } from '../../settings.js';
+import { DecoratorBase } from '../DecoratorBase/DecoratorBase.js';
+
+var componentName = 'DecoratorLink';
+
+/**
+ * The DecoratorLink groups a key/value pair to behave like a link.
+ */
+var DecoratorLink = /*#__PURE__*/React__default.forwardRef(function (props, ref) {
+  var validProps = prepareProps(props, ['disabled', 'kind', 'onClickLabel', 'onClickValue', 'onContextMenuLabel', 'onContextMenuValue']);
+  return /*#__PURE__*/React__default.createElement(DecoratorBase, _extends({
+    ref: ref
+  }, validProps, {
+    kind: "link"
+  }, getDevtoolsProps(componentName)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+DecoratorLink = pkg.checkComponentEnabled(DecoratorLink, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+DecoratorLink.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.
+DecoratorLink.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * Do not show the icon, regardless of score.
+   */
+  hideIcon: PropTypes.bool,
+  /**
+   * The component's URL.
+   */
+  href: PropTypes.string.isRequired,
+  /**
+   * The label for the data.
+   */
+  label: PropTypes.string,
+  /**
+   * Optional callback function.
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClick: PropTypes.func,
+  /**
+   * Optional callback function.
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenu: 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),
+  /**
+   * Optional callback function for building a more detailed descriptive text.
+   * Returns `score`, `scoreThresholds`, `magnitude`.
+   *
+   * Typical description is in the form of
+   * '"(magnitude)" magnitude: score (score) out of (last element of scoreThresholds array)'.
+   *
+   * E.g. `"Medium" magnitude: score 5 out of 10`.
+   *
+   * 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`.
+   */
+  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 { DecoratorLink };

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

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

package/es/components/DecoratorSingleButton/DecoratorSingleButton.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The DecoratorSingleButton groups a key/value pair to behave like a button.
+ */
+export let DecoratorSingleButton: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+import React from 'react';