@carbon/ibm-products 2.28.1 → 2.29.0

package/lib/components/Decorator/Decorator.js

@@ -0,0 +1,355 @@
+/**
+ * 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 index = require('../../node_modules/prop-types/index.js');
+var cx = require('classnames');
+var devtools = require('../../global/js/utils/devtools.js');
+var settings = require('../../settings.js');
+var utils = require('./utils.js');
+var DecoratorIcon = require('./DecoratorIcon.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+
+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(settings.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.
+ */
+exports.Decorator = /*#__PURE__*/React__default["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 = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
+  var magnitude = utils.getMagnitude(score, scoreThresholds);
+  var _labelTitle = setLabelTitle && setLabelTitle(score, scoreThresholds, magnitude);
+  var _value = utils.truncate(value, truncateValue);
+
+  // These class names apply to all types of Decorator.
+  var classNames = cx__default["default"](blockClass, className, "".concat(blockClass, "--").concat(theme), _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.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["default"].createElement("span", _rollupPluginBabelHelpers["extends"]({}, rest, devtools.getDevtoolsProps(componentName), {
+      className: cx__default["default"](classNames, "".concat(blockClass, "--buttons"), _rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "-disabled"), disabled)),
+      ref: ref
+    }), /*#__PURE__*/React__default["default"].createElement("button", {
+      className: "".concat(blockClass, "__label"),
+      disabled: disabled,
+      onClick: !disabled && handleOnClickLabel,
+      onContextMenu: !disabled && handleOnContextMenuLabel,
+      title: _labelTitle || label,
+      type: "button"
+    }, !hideIcon && /*#__PURE__*/React__default["default"].createElement(DecoratorIcon.DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default["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["default"].createElement("button", _rollupPluginBabelHelpers["extends"]({}, rest, devtools.getDevtoolsProps(componentName), {
+      className: cx__default["default"](classNames, "".concat(blockClass, "--button"), _rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "-disabled"), disabled)),
+      disabled: disabled,
+      onClick: !disabled && handleOnClick,
+      onContextMenu: !disabled && handleOnContextMenu,
+      ref: ref,
+      type: "button"
+    }), /*#__PURE__*/React__default["default"].createElement("span", {
+      className: "".concat(blockClass, "__label"),
+      title: _labelTitle || label
+    }, !hideIcon && /*#__PURE__*/React__default["default"].createElement(DecoratorIcon.DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default["default"].createElement("span", {
+      className: "".concat(blockClass, "__value"),
+      title: valueTitle || value
+    }, _value));
+  }
+
+  // RETURN LINK
+  if (kind === 'link') {
+    return /*#__PURE__*/React__default["default"].createElement("a", _rollupPluginBabelHelpers["extends"]({}, rest, devtools.getDevtoolsProps(componentName), {
+      href: href,
+      className: cx__default["default"](classNames, "".concat(blockClass, "--link")),
+      onClick: handleOnClick,
+      onContextMenu: handleOnContextMenu,
+      ref: ref
+    }), /*#__PURE__*/React__default["default"].createElement("span", {
+      className: "".concat(blockClass, "__label"),
+      title: _labelTitle || label
+    }, !hideIcon && /*#__PURE__*/React__default["default"].createElement(DecoratorIcon.DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default["default"].createElement("span", {
+      className: "".concat(blockClass, "__value"),
+      title: valueTitle || value
+    }, _value));
+  }
+
+  // RETURN DEFAULT (NON-INTERACTIVE)
+  if (kind === 'default') {
+    return /*#__PURE__*/React__default["default"].createElement("span", _rollupPluginBabelHelpers["extends"]({}, rest, devtools.getDevtoolsProps(componentName), {
+      className: cx__default["default"](classNames, "".concat(blockClass, "--default")),
+      ref: ref
+    }), /*#__PURE__*/React__default["default"].createElement("span", {
+      className: "".concat(blockClass, "__label"),
+      title: _labelTitle || label
+    }, !hideIcon && /*#__PURE__*/React__default["default"].createElement(DecoratorIcon.DecoratorIcon, decoratorIconsProps), !!label && label), /*#__PURE__*/React__default["default"].createElement("span", {
+      className: "".concat(blockClass, "__value"),
+      title: valueTitle || value
+    }, _value));
+  }
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.Decorator = settings.pkg.checkComponentEnabled(exports.Decorator, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+exports.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.
+exports.Decorator.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: index["default"].string,
+  /**
+   * `disabled` only applies if `kind` is "single-button" or "dual-button".
+   */
+  disabled: index["default"].bool,
+  /**
+   * Do not show the icon, regardless of score.
+   */
+  hideIcon: index["default"].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: index["default"].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: index["default"].oneOf(['default', 'link', 'single-button', 'dual-button']),
+  /**
+   * The label for the data.
+   */
+  label: index["default"].string,
+  /**
+   * Optional callback function if `kind` is "link" or "single-button".
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClick: index["default"].func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClickLabel: index["default"].func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onClickValue: index["default"].func,
+  /**
+   * Optional callback function if `kind` is "link" or "single-button".
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenu: index["default"].func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenuLabel: index["default"].func,
+  /**
+   * Optional callback functions if `kind` is "dual-button" only.
+   *
+   * Returns two objects: `event` and `{ score, label, value, magnitude }`
+   */
+  onContextMenuValue: index["default"].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: index["default"].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: index["default"].arrayOf(index["default"].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: index["default"].func,
+  /**
+   * Styled smaller to better fit inline with text.
+   */
+  small: index["default"].bool,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: index["default"].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: index["default"].oneOfType([index["default"].oneOf(['end', 'start']), index["default"].shape({
+    maxLength: index["default"].number,
+    front: index["default"].number,
+    back: index["default"].number
+  })]),
+  /**
+   * The value of the data.
+   */
+  value: index["default"].string.isRequired,
+  /**
+   * Overrides the default title for the Decorator's value.
+   */
+  valueTitle: index["default"].string
+};

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

@@ -0,0 +1,102 @@
+/**
+ * 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 index = require('../../node_modules/prop-types/index.js');
+var cx = require('classnames');
+var icons = require('@carbon/react/icons');
+var devtools = require('../../global/js/utils/devtools.js');
+var settings = require('../../settings.js');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+
+var _excluded = ["className", "magnitude", "small"];
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(settings.pkg.prefix, "--decorator-icon");
+var componentName = 'DecoratorIcon';
+var defaults = {
+  magnitude: 'unknown',
+  small: false
+};
+
+/**
+ * The shape and color of the Decorator's icon.
+ */
+exports.DecoratorIcon = /*#__PURE__*/React__default["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 = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
+  var Icon;
+  switch (magnitude) {
+    case 'benign':
+      Icon = icons.CircleFill;
+      break;
+    case 'low':
+      Icon = icons.SquareFill;
+      break;
+    case 'medium':
+      Icon = icons.DiamondFill;
+      break;
+    case 'high':
+      Icon = icons.Caution;
+      break;
+    case 'critical':
+      Icon = icons.ChevronMini;
+      break;
+    default:
+      Icon = icons.CircleStroke;
+      break;
+  }
+  return /*#__PURE__*/React__default["default"].createElement(Icon, _rollupPluginBabelHelpers["extends"]({}, rest, {
+    "aria-hidden": true,
+    className: cx__default["default"](blockClass, className, "".concat(blockClass, "__magnitude-").concat(magnitude), _rollupPluginBabelHelpers.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'
+  }, devtools.getDevtoolsProps(componentName)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.DecoratorIcon = settings.pkg.checkComponentEnabled(exports.DecoratorIcon, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+exports.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.
+exports.DecoratorIcon.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: index["default"].string,
+  /**
+   * Determines the shape and color of the icon.
+   */
+  magnitude: index["default"].oneOf(['unknown', 'benign', 'low', 'medium', 'high', 'critical']),
+  /**
+   * Reduce the size of the icon in proportion to a smaller Decorator.
+   */
+  small: index["default"].bool
+};

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

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

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

@@ -0,0 +1,48 @@
+/**
+ * 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 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;
+};
+
+exports.getMagnitude = getMagnitude;
+exports.truncate = truncate;

package/lib/components/DescriptionList/DescriptionList.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Type layouts provide an orderly layout of terms and definitions.
+ */
+export let DescriptionList: React.ForwardRefExoticComponent<React.RefAttributes<any>>;
+export function DescriptionListBody({ children, className, ...rest }: {
+    [x: string]: any;
+    children: any;
+    className: any;
+}): import("react/jsx-runtime").JSX.Element;
+export namespace DescriptionListBody {
+    export namespace propTypes {
+        let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        let className: PropTypes.Requireable<string>;
+    }
+    export { componentNameBody as displayName };
+}
+export function DescriptionListRow({ children, className, ...other }: {
+    [x: string]: any;
+    children: any;
+    className: any;
+}): import("react/jsx-runtime").JSX.Element;
+export namespace DescriptionListRow {
+    export namespace propTypes_1 { }
+    export { propTypes_1 as propTypes };
+    export { componentNameRow as displayName };
+}
+export function DescriptionListCell({ children, className, ...rest }: {
+    [x: string]: any;
+    children: any;
+    className: any;
+}): import("react/jsx-runtime").JSX.Element;
+export namespace DescriptionListCell {
+    export namespace propTypes_2 { }
+    export { propTypes_2 as propTypes };
+    export { componentNameCell as displayName };
+}
+import React from 'react';
+import PropTypes from 'prop-types';
+declare const componentNameBody: "DescriptionListBody";
+declare const componentNameRow: "DescriptionListRow";
+declare const componentNameCell: "DescriptionListCell";
+export {};

package/lib/components/DescriptionList/DescriptionList.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.
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _rollupPluginBabelHelpers = require('../../_virtual/_rollupPluginBabelHelpers.js');
+var React = require('react');
+var index = require('../../node_modules/prop-types/index.js');
+var cx = require('classnames');
+var devtools = require('../../global/js/utils/devtools.js');
+var settings = require('../../settings.js');
+var constants = require('./constants.js');
+var react = require('@carbon/react');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var React__default = /*#__PURE__*/_interopDefaultLegacy(React);
+var cx__default = /*#__PURE__*/_interopDefaultLegacy(cx);
+
+var _excluded = ["border", "children", "className", "size"];
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(settings.pkg.prefix, "--description-list");
+var componentName = 'DescriptionList';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values can be included here and then assigned to the prop params,
+// e.g. prop = defaults.prop,
+// This gathers default values together neatly and ensures non-primitive
+// values are initialized early to avoid react making unnecessary re-renders.
+// Note that default values are not required for props that are 'required',
+// nor for props where the component can apply undefined values reasonably.
+// Default values should be provided when the component needs to make a choice
+// or assumption when a prop is not supplied.
+
+// Default values for props
+var defaults = {
+  border: false,
+  size: constants.DescriptionListSize.Medium
+};
+
+/**
+ * Type layouts provide an orderly layout of terms and definitions.
+ */
+exports.DescriptionList = /*#__PURE__*/React__default["default"].forwardRef(function (_ref, ref) {
+  var _ref$border = _ref.border,
+    border = _ref$border === void 0 ? defaults.border : _ref$border,
+    children = _ref.children,
+    className = _ref.className,
+    _ref$size = _ref.size,
+    size = _ref$size === void 0 ? defaults.size : _ref$size,
+    rest = _rollupPluginBabelHelpers.objectWithoutProperties(_ref, _excluded);
+  return /*#__PURE__*/React__default["default"].createElement("div", _rollupPluginBabelHelpers["extends"]({}, rest, {
+    className: cx__default["default"](blockClass, // Apply the block class to the main HTML element
+    _rollupPluginBabelHelpers.defineProperty(_rollupPluginBabelHelpers.defineProperty({}, "".concat(blockClass, "--bordered"), border), "".concat(blockClass, "--").concat(size), size), className // Apply any supplied class names to the main HTML element.
+    ),
+    ref: ref
+  }, devtools.getDevtoolsProps(componentName)), /*#__PURE__*/React__default["default"].createElement(react.StructuredListWrapper, {
+    role: "table",
+    selection: false
+  }, children));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.DescriptionList = settings.pkg.checkComponentEnabled(exports.DescriptionList, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+exports.DescriptionList.displayName = componentName;
+var propTypes = {
+  /** Provide the contents of the node */
+  children: index["default"].node,
+  /** Provide an optional class to be applied to the containing node */
+  className: index["default"].string
+};
+
+// The types and DocGen commentary for the component props,
+// in alphabetical order (for consistency).
+// See https://www.npmjs.com/package/prop-types#usage.
+exports.DescriptionList.propTypes = _rollupPluginBabelHelpers.objectSpread2(_rollupPluginBabelHelpers.objectSpread2({}, propTypes), {}, {
+  /** Specify if the type layout has a border */
+  border: index["default"].bool,
+  /** Specify the size of the type layout, from a list of available sizes */
+  size: index["default"].oneOf(Object.values(constants.DescriptionListSize))
+});
+_rollupPluginBabelHelpers.objectSpread2({}, propTypes);
+_rollupPluginBabelHelpers.objectSpread2({}, propTypes);
+_rollupPluginBabelHelpers.objectSpread2({}, propTypes);

package/lib/components/DescriptionList/constants.d.ts

@@ -0,0 +1,6 @@
+export namespace DescriptionListSize {
+    let XSmall: string;
+    let Small: string;
+    let Medium: string;
+    let Large: string;
+}