@carbon/ibm-products 1.57.0 → 1.58.0

package/es/components/Checklist/Checklist.js

@@ -0,0 +1,277 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["chartValue", "chartLabel", "checklistAriaLabel", "checklistToggleAriaLabel", "className", "onClickViewAll", "onToggle", "open", "showToggle", "taskLists", "theme", "title", "viewAllLabel"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * TODO: Breakdown titles, icons, clickable items into sub-components
+ * See
+ *   ModifiedTabs (ModifiedTabLabelNew, ModifiedTabLabelWithClose)
+ *   PageHeader (PageHeaderTitle, PageHeaderUtils)
+ */
+
+// Import portions of React that are needed.
+import React, { useEffect, useRef, useState } from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import uuidv4 from '../../global/js/utils/uuidv4';
+import { pkg /*, carbon */ } from '../../settings';
+
+// Carbon and package components we use.
+/* TODO: @import(s) of carbon components and other package components. */
+import { Button } from 'carbon-components-react';
+import { ChevronUp16 } from '@carbon/icons-react';
+import { ChecklistIcon } from './ChecklistIcon';
+import { ChecklistChart } from './ChecklistChart';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--checklist");
+var componentName = 'Checklist';
+
+// 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 = {
+  checklistAriaLabel: 'Checklist',
+  checklistToggleAriaLabel: 'Checklist toggle',
+  onClickViewAll: function onClickViewAll() {},
+  onToggle: function onToggle() {},
+  open: true,
+  showToggle: true,
+  taskLists: [],
+  theme: 'light'
+};
+
+/**
+ * TODO: A description of the component.
+ */
+export var Checklist = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var chartValue = _ref.chartValue,
+    chartLabel = _ref.chartLabel,
+    _ref$checklistAriaLab = _ref.checklistAriaLabel,
+    checklistAriaLabel = _ref$checklistAriaLab === void 0 ? defaults.checklistAriaLabel : _ref$checklistAriaLab,
+    _ref$checklistToggleA = _ref.checklistToggleAriaLabel,
+    checklistToggleAriaLabel = _ref$checklistToggleA === void 0 ? defaults.checklistToggleAriaLabel : _ref$checklistToggleA,
+    className = _ref.className,
+    _ref$onClickViewAll = _ref.onClickViewAll,
+    onClickViewAll = _ref$onClickViewAll === void 0 ? defaults.onClickViewAll : _ref$onClickViewAll,
+    _ref$onToggle = _ref.onToggle,
+    onToggle = _ref$onToggle === void 0 ? defaults.onToggle : _ref$onToggle,
+    _ref$open = _ref.open,
+    open = _ref$open === void 0 ? defaults.open : _ref$open,
+    _ref$showToggle = _ref.showToggle,
+    showToggle = _ref$showToggle === void 0 ? defaults.showToggle : _ref$showToggle,
+    _ref$taskLists = _ref.taskLists,
+    taskLists = _ref$taskLists === void 0 ? defaults.taskLists : _ref$taskLists,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    title = _ref.title,
+    viewAllLabel = _ref.viewAllLabel,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var _useState = useState(open),
+    _useState2 = _slicedToArray(_useState, 2),
+    isOpen = _useState2[0],
+    setIsOpen = _useState2[1];
+  var listContainerId = useRef(uuidv4()).current;
+  var chartLabelId = useRef(uuidv4()).current;
+
+  // Don't use this test: {chartValue && chartLabel && (render...)}.
+  // If `chartValue` is 0 (zero) - a valid value - then it will render 0 and skip the remaining statement.
+  // Use this test instead: {chartLabelAndValue && (render...)}.
+  // The ChecklistChart component will validate `chartValue`.
+  var chartLabelAndValue = typeof chartValue === 'number' && chartLabel;
+  var handleClickToggle = function handleClickToggle() {
+    setIsOpen(function (prevOpen) {
+      return !prevOpen;
+    });
+  };
+  var handleClickViewAll = function handleClickViewAll() {
+    onClickViewAll();
+  };
+
+  // If state changes, then trigger callback.
+  useEffect(function () {
+    onToggle(isOpen);
+  }, [isOpen, onToggle]);
+
+  // If the "open" prop is changed after initialization,
+  // then update internal state.
+  useEffect(function () {
+    setIsOpen(open);
+  }, [open]);
+  return /*#__PURE__*/React.createElement("aside", _extends({}, rest, {
+    "aria-label": checklistAriaLabel,
+    className: cx(blockClass,
+    // Apply the block class to the main HTML element
+    className, // Apply any supplied class names to the main HTML element.
+    // example: `${blockClass}__template-string-class-${kind}-n-${size}`,
+    _defineProperty({}, "".concat(blockClass, "__closed"), !isOpen)),
+    ref: ref
+  }, getDevtoolsProps(componentName)), (title || chartLabelAndValue) && /*#__PURE__*/React.createElement("header", {
+    className: "".concat(blockClass, "__header")
+  }, chartLabelAndValue && /*#__PURE__*/React.createElement(ChecklistChart, {
+    ariaLabelledById: chartLabelId,
+    value: chartValue,
+    theme: theme
+  }), /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__titles")
+  }, title && /*#__PURE__*/React.createElement("h2", {
+    className: "".concat(blockClass, "__title")
+  }, title), chartLabelAndValue && /*#__PURE__*/React.createElement("h3", {
+    id: chartLabelId,
+    className: "".concat(blockClass, "__chart-label")
+  }, chartLabel)), showToggle && /*#__PURE__*/React.createElement(Button, {
+    "aria-controls": listContainerId,
+    "aria-expanded": isOpen,
+    "aria-label": checklistToggleAriaLabel,
+    className: "".concat(blockClass, "__toggle"),
+    kind: "ghost",
+    onClick: handleClickToggle,
+    size: "small"
+  }, /*#__PURE__*/React.createElement(ChevronUp16, {
+    className: cx("".concat(blockClass, "__chevron"))
+  }))), /*#__PURE__*/React.createElement("div", {
+    id: listContainerId,
+    className: "".concat(blockClass, "__content-outer")
+  }, /*#__PURE__*/React.createElement("div", {
+    className: "".concat(blockClass, "__content-inner")
+  }, /*#__PURE__*/React.createElement("section", {
+    className: cx("".concat(blockClass, "__body"))
+  }, taskLists.map(function (list, index) {
+    return /*#__PURE__*/React.createElement("div", {
+      className: "".concat(blockClass, "__list-group"),
+      key: "".concat(list.title, "-").concat(index)
+    }, list.title && /*#__PURE__*/React.createElement("h3", {
+      title: list.title,
+      className: "".concat(blockClass, "__list-title")
+    }, list.title), /*#__PURE__*/React.createElement("ol", {
+      className: "".concat(blockClass, "__list")
+    }, list.tasks.map(function (item, index) {
+      return /*#__PURE__*/React.createElement("li", {
+        className: "".concat(blockClass, "__list-item"),
+        key: "".concat(item.label, "-").concat(index)
+      }, /*#__PURE__*/React.createElement(ChecklistIcon, {
+        kind: item.kind
+      }), typeof item.onClick === 'function' ? /*#__PURE__*/React.createElement(Button, {
+        className: cx("".concat(blockClass, "__button"), _defineProperty({}, "".concat(blockClass, "__button--error"), item.kind === 'error')),
+        onClick: function onClick() {
+          item.onClick(item);
+        },
+        size: "small"
+      }, /*#__PURE__*/React.createElement("div", {
+        title: item.label
+      }, item.label)) : /*#__PURE__*/React.createElement("span", {
+        className: cx("".concat(blockClass, "__label"), "".concat(blockClass, "__label--").concat(item.kind)),
+        title: item.label
+      }, item.label));
+    })));
+  })), viewAllLabel && /*#__PURE__*/React.createElement("footer", {
+    className: "".concat(blockClass, "__footer")
+  }, /*#__PURE__*/React.createElement(Button, {
+    className: cx("".concat(blockClass, "__button"), "".concat(blockClass, "__view-all")),
+    onClick: handleClickViewAll,
+    size: "small"
+  }, /*#__PURE__*/React.createElement("div", null, viewAllLabel))))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+Checklist = pkg.checkComponentEnabled(Checklist, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+Checklist.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.
+Checklist.propTypes = {
+  /**
+   * Define both `chartLabel` and `chartValue` to show the chart and its label together.
+   */
+  chartLabel: PropTypes.string,
+  /**
+   * A number between 0 and 1.
+   *
+   * Define both `chartLabel` and `chartValue` to show the chart and its label together.
+   */
+  chartValue: PropTypes.number,
+  /**
+   * Aria-label for the Checklist component.
+   */
+  checklistAriaLabel: PropTypes.string,
+  /**
+   * Aria-label for the Checklist's toggle component.
+   */
+  checklistToggleAriaLabel: PropTypes.string,
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * Callback for the "View all" button. See also `viewAllLabel`.
+   */
+  onClickViewAll: PropTypes.func,
+  /**
+   * Optional callback for when the list is opened/closed.
+   */
+  onToggle: PropTypes.func,
+  /**
+   * Specifies whether the component is opened or closed.
+   * This can be set during initialization, or changed after being rendered.
+   */
+  open: PropTypes.bool,
+  /**
+   * Whether or not to show the open/close toggle.
+   */
+  showToggle: PropTypes.bool,
+  /**
+   * The task list can be broken down into sub-lists.
+   *
+   * Each sub-list can include an optional `title`.
+   *
+   * Each task must specify the appropriate icon (`kind`) and `label`.
+   *
+   * If any task has an `onClick` callback function defined,
+   * then the `label` will be rendered as a button,
+   * else the `label` will be rendered as plain text.
+   */
+  taskLists: PropTypes.arrayOf(PropTypes.shape({
+    title: PropTypes.string,
+    tasks: PropTypes.arrayOf(PropTypes.shape({
+      kind: PropTypes.oneOf(['unchecked', 'indeterminate', 'checked', 'disabled', 'error']).isRequired,
+      label: PropTypes.string.isRequired,
+      onClick: PropTypes.func
+    })).isRequired
+  })).isRequired,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark']),
+  /**
+   * The title of the component.
+   */
+  title: PropTypes.string,
+  /**
+   * If defined, will show and enable the "View all (#)" button at the bottom of the list.
+   */
+  viewAllLabel: PropTypes.string
+};

package/es/components/Checklist/ChecklistChart.js

@@ -0,0 +1,104 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "ariaLabelledById", "value", "theme"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * TODO: Breakdown titles, icons, clickable items into sub-components
+ * See
+ *   ModifiedTabs (ModifiedTabLabelNew, ModifiedTabLabelWithClose)
+ *   PageHeader (PageHeaderTitle, PageHeaderUtils)
+ */
+
+// Import portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+import clamp from 'lodash/clamp';
+
+// Carbon and package components we use.
+/* TODO: @import(s) of carbon components and other package components. */
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--checklist__chart");
+var componentName = 'ChecklistChart';
+
+// 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 = {
+  theme: 'light'
+};
+
+/**
+ * TODO: A description of the component.
+ */
+export var ChecklistChart = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    ariaLabelledById = _ref.ariaLabelledById,
+    value = _ref.value,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var numDegrees = clamp(value * 360, 0, 360);
+  var circleColor = theme === 'light' ? '#c6c6c6' : '#525252'; // $gray-30, $gray-70
+  var progressColor = theme === 'light' ? '#6929c4' : '#A56EFF'; // $purple-70, $purple-50
+
+  return /*#__PURE__*/React.createElement("div", _extends({}, rest, {
+    "aria-labelledby": ariaLabelledById,
+    className: cx(blockClass, className),
+    style: {
+      backgroundImage: "conic-gradient(".concat(progressColor, " ").concat(numDegrees, "deg, ").concat(circleColor, " ").concat(numDegrees, "deg 360deg)"),
+      borderRadius: '50%'
+    },
+    ref: ref,
+    role: "img"
+  }, getDevtoolsProps(componentName)));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+// ChecklistChart = pkg.checkComponentEnabled(ChecklistChart, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+// ChecklistChart.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.
+ChecklistChart.propTypes = {
+  /**
+   * Id of the parent's aria-label for accessibility.
+   */
+  ariaLabelledById: PropTypes.string.isRequired,
+  /**
+   * Optional class name for this component.
+   */
+  className: PropTypes.string,
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark']),
+  /**
+   * Number between 0 and 1.
+   */
+  value: PropTypes.number.isRequired
+};

package/es/components/Checklist/ChecklistIcon.js

@@ -0,0 +1,105 @@
+import _extends from "@babel/runtime/helpers/extends";
+import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
+var _excluded = ["className", "kind", "theme"];
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * This source code is licensed under the Apache-2.0 license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/**
+ * TODO: Breakdown titles, icons, clickable items into sub-components
+ * See
+ *   ModifiedTabs (ModifiedTabLabelNew, ModifiedTabLabelWithClose)
+ *   PageHeader (PageHeaderTitle, PageHeaderUtils)
+ */
+
+// Import portions of React that are needed.
+import React from 'react';
+
+// Other standard imports.
+import PropTypes from 'prop-types';
+import cx from 'classnames';
+import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import { pkg /*, carbon */ } from '../../settings';
+
+// Carbon and package components we use.
+/* TODO: @import(s) of carbon components and other package components. */
+import { CheckmarkOutline16, CircleDash16, Incomplete16, Warning16 } from '@carbon/icons-react';
+
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(pkg.prefix, "--checklist__icon");
+var componentName = 'ChecklistIcon';
+
+// 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 = {
+  theme: 'light'
+};
+
+/**
+ * TODO: A description of the component.
+ */
+export var ChecklistIcon = /*#__PURE__*/React.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    kind = _ref.kind,
+    _ref$theme = _ref.theme,
+    theme = _ref$theme === void 0 ? defaults.theme : _ref$theme,
+    rest = _objectWithoutProperties(_ref, _excluded);
+  var Icon;
+  switch (kind) {
+    case 'error':
+      Icon = Warning16;
+      break;
+    case 'indeterminate':
+      Icon = Incomplete16;
+      break;
+    case 'checked':
+      Icon = CheckmarkOutline16;
+      break;
+    default:
+      // "unchecked" or "disabled"
+      Icon = CircleDash16;
+      break;
+  }
+  return /*#__PURE__*/React.createElement("span", _extends({}, rest, {
+    className: cx(blockClass, className, "".concat(blockClass, "--").concat(kind), "".concat(blockClass, "__").concat(theme)),
+    ref: ref
+  }, getDevtoolsProps(componentName)), /*#__PURE__*/React.createElement(Icon, null));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+// ChecklistIcon = pkg.checkComponentEnabled(ChecklistIcon, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+// ChecklistIcon.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.
+ChecklistIcon.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: PropTypes.string,
+  /**
+   * The icon to be displayed.
+   */
+  kind: PropTypes.oneOf(['unchecked', 'indeterminate', 'checked', 'disabled', 'error']),
+  /**
+   * Determines the theme of the component.
+   */
+  theme: PropTypes.oneOf(['light', 'dark'])
+};

package/es/components/Checklist/index.js

@@ -0,0 +1,8 @@
+/**
+ * Copyright IBM Corp. 2023, 2023
+ *
+ * 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 { Checklist } from './Checklist';

package/es/components/Datagrid/Datagrid/DatagridHeaderRow.js

@@ -47,6 +47,7 @@ var HeaderRow = function HeaderRow(datagridState, headRef, headerGroup) {
           gridHeight = _ref.gridHeight;
         headerRowElement.style.setProperty("--".concat(blockClass, "--row-height"), px(rowHeight));
         headerRowElement.style.setProperty("--".concat(blockClass, "--grid-height"), px(gridHeight - scrollBuffer - tableToolbarHeight));
+        headerRowElement.style.setProperty("--".concat(blockClass, "--header-height"), px(headerRowElement.offsetHeight));
       };
       setCustomValues({
         gridHeight: gridElement.offsetHeight,

package/es/components/NonLinearReading/NonLinearReading.js

@@ -9,11 +9,12 @@ var _excluded = ["children", "className", "definition", "theme"];
  * LICENSE file in the root directory of this source tree.
  */
 
-import React, { useState } from 'react';
+import React, { useRef, useState } from 'react';
 import PropTypes from 'prop-types';
 import cx from 'classnames';
 import { ChevronDown16 } from '@carbon/icons-react';
 import { getDevtoolsProps } from '../../global/js/utils/devtools';
+import uuidv4 from '../../global/js/utils/uuidv4';
 import { pkg } from '../../settings';
 
 // The block part of our conventional BEM class names (blockClass__E--M).
@@ -41,6 +42,7 @@ export var NonLinearReading = /*#__PURE__*/React.forwardRef(function (_ref, ref)
     _useState2 = _slicedToArray(_useState, 2),
     isOpen = _useState2[0],
     setOpen = _useState2[1];
+  var contentId = useRef(uuidv4()).current;
   var handleToggle = function handleToggle() {
     setOpen(function (prevState) {
       return !prevState;
@@ -52,12 +54,15 @@ export var NonLinearReading = /*#__PURE__*/React.forwardRef(function (_ref, ref)
     role: "main"
   }, getDevtoolsProps(componentName)), ' ', /*#__PURE__*/React.createElement("button", {
     type: "button",
+    "aria-controls": contentId,
     "aria-expanded": isOpen,
     className: cx("".concat(blockClass, "__keyword"), [isOpen ? ["".concat(blockClass, "__keyword-open")] : ["".concat(blockClass, "__keyword-closed")]]),
     onClick: handleToggle
-  }, children, /*#__PURE__*/React.createElement(ChevronDown16, null)), ' ', isOpen && /*#__PURE__*/React.createElement("span", {
-    className: "".concat(blockClass, "__body")
-  }, definition), ' ');
+  }, children, /*#__PURE__*/React.createElement(ChevronDown16, null)), ' ', /*#__PURE__*/React.createElement("span", {
+    id: contentId,
+    className: "".concat(blockClass, "__body"),
+    hidden: !isOpen
+  }, isOpen && definition), ' ');
 });
 
 // Return a placeholder if not released and not enabled by feature flag

package/es/components/index.js

@@ -53,4 +53,5 @@ export { CoachmarkButton } from './CoachmarkButton';
 export { CoachmarkOverlayElements } from './CoachmarkOverlayElements';
 export { CoachmarkOverlayElement } from './CoachmarkOverlayElement';
 export { CoachmarkStack } from './CoachmarkStack';
-export { InlineTip } from './InlineTip';
+export { InlineTip } from './InlineTip';
+export { Checklist } from './Checklist';

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

@@ -75,6 +75,7 @@ var defaults = {
     InlineTip: false,
     Guidebanner: false,
     NonLinearReading: false,
+    Checklist: false,
     Coachmark: false,
     CoachmarkBeacon: false,
     CoachmarkButton: false,