@carbon/ibm-products 2.15.2 → 2.16.0

package/lib/components/InlineTip/utils.js

@@ -0,0 +1,43 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getComponentText = void 0;
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+/**
+ * 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.
+ */
+
+var getComponentText = exports.getComponentText = function getComponentText(reactNode) {
+  var _reactNode$props;
+  var tmpChildren = (reactNode === null || reactNode === void 0 || (_reactNode$props = reactNode.props) === null || _reactNode$props === void 0 ? void 0 : _reactNode$props.children) || undefined;
+  if (Array.isArray(reactNode)) {
+    var joinedNodes = [];
+    reactNode.forEach(function (node) {
+      if ((0, _typeof2.default)(node) === 'object') {
+        joinedNodes.push(getComponentText(node));
+      } else if (typeof node === 'string') {
+        joinedNodes.push(node);
+      }
+    });
+    return joinedNodes.join(' ');
+  }
+  if (tmpChildren === undefined) {
+    if (typeof reactNode === 'string') {
+      return reactNode;
+    } else {
+      return ' ';
+    }
+  }
+  if ((0, _typeof2.default)(tmpChildren) === 'object') {
+    return getComponentText(reactNode.props.children);
+  }
+  if (typeof tmpChildren === 'string') {
+    return reactNode.props.children;
+  }
+};

package/lib/components/SteppedAnimatedMedia/SteppedAnimatedMedia.docs-page.js

@@ -0,0 +1,21 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _react = _interopRequireDefault(require("react"));
+var _StoryDocsPage = require("../../global/js/utils/StoryDocsPage");
+var stories = _interopRequireWildcard(require("./SteppedAnimatedMedia.stories"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+var DocsPage = function DocsPage() {
+  return /*#__PURE__*/_react.default.createElement(_StoryDocsPage.StoryDocsPage, {
+    blocks: [{
+      story: stories.steppedAnimatedMedia
+    }]
+  });
+};
+var _default = exports.default = DocsPage;

package/lib/components/SteppedAnimatedMedia/SteppedAnimatedMedia.js

@@ -0,0 +1,148 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SteppedAnimatedMedia = void 0;
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireWildcard(require("react"));
+var _lottieWeb = _interopRequireDefault(require("lottie-web"));
+var _clamp = _interopRequireDefault(require("lodash/clamp"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["className", "playStep", "filePaths"];
+/**
+ * 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.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--stepped-animated-media");
+var componentName = 'SteppedAnimatedMedia';
+
+// NOTE: the component SCSS is not imported here: it is rolled up separately.
+
+// Default values for props
+var defaults = {
+  playStep: 0
+};
+
+/**
+ * The SteppedAnimatedMedia is a Novice to Pro internal component and is not intended for general use.
+ */
+var SteppedAnimatedMedia = exports.SteppedAnimatedMedia = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    _ref$playStep = _ref.playStep,
+    playStep = _ref$playStep === void 0 ? defaults.playStep : _ref$playStep,
+    filePaths = _ref.filePaths,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var _useState = (0, _react.useState)([]),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    jsonData = _useState2[0],
+    setJsonData = _useState2[1];
+  var animRef = (0, _react.useRef)();
+  var backupRef = (0, _react.useRef)();
+  var localRef = ref !== null && ref !== void 0 ? ref : backupRef;
+  // load animation source
+  (0, _react.useEffect)(function () {
+    var isJsonFile = function isJsonFile(filePath) {
+      return filePath.includes('.json');
+    };
+    function loadArtifact() {
+      return _loadArtifact.apply(this, arguments);
+    }
+    function _loadArtifact() {
+      _loadArtifact = (0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee() {
+        var allJsonArtifacts, rawResponse, jsonResponse, fileData;
+        return _regenerator.default.wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              if (!(filePaths && filePaths.every(isJsonFile))) {
+                _context.next = 10;
+                break;
+              }
+              allJsonArtifacts = filePaths.map(function (el) {
+                return fetch(el);
+              });
+              _context.next = 4;
+              return Promise.all(allJsonArtifacts);
+            case 4:
+              rawResponse = _context.sent;
+              jsonResponse = rawResponse.map(function (el) {
+                return el.json();
+              });
+              _context.next = 8;
+              return Promise.all(jsonResponse);
+            case 8:
+              fileData = _context.sent;
+              setJsonData(fileData);
+            case 10:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee);
+      }));
+      return _loadArtifact.apply(this, arguments);
+    }
+    loadArtifact();
+  }, [filePaths]);
+  (0, _react.useEffect)(function () {
+    var _window;
+    var prefersReducedMotion = (_window = window) !== null && _window !== void 0 && _window.matchMedia ? window.matchMedia('(prefers-reduced-motion: reduce)').matches : true;
+    if (localRef.current) {
+      var _animRef$current, _animRef$current2, _animRef$current3;
+      (_animRef$current = animRef.current) === null || _animRef$current === void 0 || _animRef$current.destroy();
+      animRef.current = _lottieWeb.default.loadAnimation({
+        container: localRef.current,
+        renderer: 'svg',
+        animationData: jsonData[(0, _clamp.default)(playStep, 0, jsonData.length - 1)],
+        loop: false,
+        autoplay: false,
+        rendererSettings: {
+          preserveAspectRatio: 'xMidYMid slice'
+        }
+      });
+      prefersReducedMotion ? (_animRef$current2 = animRef.current) === null || _animRef$current2 === void 0 ? void 0 : _animRef$current2.goToAndStop(0) : (_animRef$current3 = animRef.current) === null || _animRef$current3 === void 0 ? void 0 : _animRef$current3.goToAndPlay(0);
+    }
+    return function () {
+      var _animRef$current4;
+      return (_animRef$current4 = animRef.current) === null || _animRef$current4 === void 0 ? void 0 : _animRef$current4.destroy();
+    };
+  }, [jsonData, localRef, playStep]);
+  if (!jsonData) {
+    return null;
+  }
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, className),
+    role: "img",
+    ref: localRef
+  }, (0, _devtools.getDevtoolsProps)(componentName)));
+});
+SteppedAnimatedMedia.displayName = componentName;
+SteppedAnimatedMedia.propTypes = {
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The file path(s) to json formatted Lottie animation files.
+   */
+  filePaths: _propTypes.default.arrayOf(_propTypes.default.string).isRequired,
+  /**
+   * Which animation step from the filePaths array to play.
+   */
+  playStep: _propTypes.default.number
+};

package/lib/components/SteppedAnimatedMedia/assets/index.js

@@ -0,0 +1,9 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.HowACaseIsCreated3 = exports.HowACaseIsCreated2 = exports.HowACaseIsCreated1 = void 0;
+var HowACaseIsCreated1 = exports.HowACaseIsCreated1 = new URL('./illustrations/how-a-case-is-created-1', import.meta.url).pathname;
+var HowACaseIsCreated2 = exports.HowACaseIsCreated2 = new URL('./illustrations/how-a-case-is-created-2', import.meta.url).pathname;
+var HowACaseIsCreated3 = exports.HowACaseIsCreated3 = new URL('./illustrations/how-a-case-is-created-3', import.meta.url).pathname;

package/lib/components/SteppedAnimatedMedia/index.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "SteppedAnimatedMedia", {
+  enumerable: true,
+  get: function get() {
+    return _SteppedAnimatedMedia.SteppedAnimatedMedia;
+  }
+});
+var _SteppedAnimatedMedia = require("./SteppedAnimatedMedia");

package/lib/global/js/package-settings.js

@@ -77,7 +77,8 @@ var defaults = {
     /* new component flags here - comment used by generate CLI */
 
     // Novice to pro components not yet reviewed and released:
-    Checklist: false
+    Checklist: false,
+    InlineTip: false
   },
   // feature level flags
   feature: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/ibm-products",
   "description": "Carbon for IBM Products",
-  "version": "2.15.2",
+  "version": "2.16.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -96,5 +96,5 @@
     "react": "^16.8.6 || ^17.0.1 || ^18.2.0",
     "react-dom": "^16.8.6 || ^17.0.1 || ^18.2.0"
   },
-  "gitHead": "61217220d3b66f869e36c29d8263b1b56c756475"
+  "gitHead": "ed97e8fd254f759b49c99165ded03c0105389b99"
 }

package/scss/components/Datagrid/styles/_datagrid.scss

@@ -321,6 +321,11 @@
   background-color: $background-selected-hover;
 }
 
+.#{$block-class}__grid-container
+  table.#{$block-class}__table-simple.#{c4p-settings.$carbon-prefix}--data-table.#{$block-class}__table-is-resizing {
+  overflow-y: hidden;
+}
+
 .#{$block-class}__resizableColumn {
   &.#{$block-class}__isResizing {
     .#{$block-class}__resizer {

package/scss/components/InlineTip/_index.scss

@@ -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.
+//
+
+@use './inline-tip';

package/scss/components/InlineTip/_inline-tip.scss

@@ -0,0 +1,229 @@
+//
+// 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.
+//
+
+/**
+ * The InlineTip specifically is theme-agnostic, and so we have to 
+ * use color tokens to keep the colors static instead of theme tokens 
+ * that will change depending on the selected theme.
+ * 
+ * We are triggering a *large* amount of linting errors.
+ * So, we're using the following "disable" rules for the entire file 
+ * instead of many individual rules.
+ */
+
+/* stylelint-disable carbon/layout-token-use */
+/* stylelint-disable carbon/theme-token-use */
+/* stylelint-disable declaration-no-important */
+/* stylelint-disable function-no-unknown */
+/* stylelint-disable max-nesting-depth */
+
+// Standard imports.
+@use '../../global/styles/project-settings' as c4p-settings;
+@use '@carbon/react/scss/colors' as *;
+@use '@carbon/layout/scss/convert' as *;
+@use '@carbon/styles/scss/spacing' as *;
+@use '@carbon/styles/scss/theme' as *;
+@use '@carbon/styles/scss/type' as *;
+
+$block-class: #{c4p-settings.$pkg-prefix}--inline-tip;
+// Images and animation are the same fixed size
+$media-height: to-rem(118px);
+$media-width: calc(#{$media-height} * 2);
+$purple: #7f3ae7;
+
+.#{$block-class} {
+  position: relative;
+  display: flex;
+  background: linear-gradient(90deg, $blue-90 0%, $purple-70 100%);
+}
+// layout only: wide
+.#{$block-class}__wide {
+  padding: $spacing-05 $spacing-10 $spacing-05 $spacing-09;
+}
+// layout: wide, with image
+.#{$block-class}__wide.#{$block-class}__has-media {
+  padding-right: $spacing-09;
+}
+
+.#{$block-class}__wide.#{$block-class}__has-media .#{$block-class}__media {
+  padding-left: $spacing-10;
+}
+
+.#{$block-class}__wide.#{$block-class}__has-media .#{$block-class}__media img {
+  display: block;
+  height: $media-height;
+}
+
+.#{$block-class}__wide.#{$block-class}__has-media .#{$block-class}__media svg {
+  // Overrides the inline CSS of "100%".
+  width: $media-width !important;
+  height: $media-height !important;
+}
+
+// layout only: narrow
+.#{$block-class}__narrow {
+  flex-direction: column-reverse;
+  padding: to-rem(52px) $spacing-07 $spacing-05 $spacing-05;
+}
+// layout: narrow, with image
+.#{$block-class}__narrow.#{$block-class}__has-media {
+  padding-top: $spacing-07;
+  padding-right: $spacing-05;
+}
+
+.#{$block-class}__narrow.#{$block-class}__has-media .#{$block-class}__media {
+  padding-bottom: $spacing-05;
+
+  img {
+    width: 100%;
+  }
+}
+
+.#{$block-class}__narrow.#{$block-class}__has-media .#{$block-class}__content {
+  padding-right: $spacing-05;
+}
+
+.#{$block-class}__narrow.#{$block-class}__has-media .#{$block-class}__footer {
+  justify-content: space-between;
+}
+.#{$block-class}__narrow.#{$block-class}__has-media
+  .#{$block-class}__footer
+  .#{$block-class}__close-btn {
+  margin-right: calc(-1 * $spacing-05);
+}
+
+// All links in use by this component and provided by the user must reflect the 'dark' theme.
+.#{$block-class} a {
+  color: $blue-30;
+
+  &:visited,
+  &:hover,
+  &:visited:hover {
+    color: $blue-30;
+  }
+}
+
+.#{$block-class}__title {
+  @include type-style('productive-heading-01');
+
+  color: $white-0;
+}
+
+.#{$block-class}__body {
+  @include type-style('body-short-01');
+
+  color: $gray-10;
+}
+.#{$block-class}__body p {
+  @include type-style('body-short-01');
+
+  margin-bottom: $spacing-03;
+  font-size: inherit;
+  line-height: inherit;
+
+  &:last-of-type {
+    margin-bottom: 0;
+  }
+}
+
+.#{$block-class}__body .#{$block-class}__secondary-btn {
+  margin-top: $spacing-03;
+}
+.#{$block-class}__body
+  .#{$block-class}__secondary-btn
+  .#{$block-class}__button {
+  margin-left: calc(-1 * $spacing-05);
+  color: $blue-30;
+
+  &:active,
+  &:hover {
+    background-color: $purple;
+    color: $gray-10;
+  }
+}
+
+.#{$block-class}__footer {
+  display: flex;
+  padding-top: $spacing-05;
+
+  &:empty {
+    display: none;
+  }
+}
+
+// When 'collapsed', a text-only preview with ellipsis is shown.
+.#{$block-class}__preview-text {
+  display: -webkit-box;
+  overflow: hidden;
+  -webkit-box-orient: vertical;
+  -webkit-line-clamp: 1;
+}
+
+.#{$block-class}__icon-idea {
+  position: absolute;
+  width: to-rem(20px);
+  color: $white-0;
+  inset: $spacing-05 0 0 $spacing-05;
+}
+
+.#{$block-class}__close-icon-wrapper {
+  position: absolute;
+  top: 0;
+  right: 0;
+}
+
+.#{$block-class} .#{$block-class}__close-icon {
+  padding: to-rem(6px) 0 0 0;
+  block-size: $spacing-07;
+  color: $white-0;
+  inline-size: $spacing-07;
+  min-block-size: $spacing-07;
+
+  &:active,
+  &:hover {
+    background-color: $purple;
+    color: $text-primary;
+  }
+
+  path {
+    margin: 0;
+    fill: $white-0;
+  }
+}
+
+.#{$block-class} .#{$block-class}__toggle-btn {
+  border: none;
+  margin: 0 $spacing-05 0 calc(-1 * $spacing-05);
+  color: $blue-30;
+
+  &:hover {
+    background-color: $purple-70-hover;
+    color: $gray-10;
+  }
+}
+
+.#{$block-class} .#{$block-class}__close-btn {
+  border: to-rem(1px) solid $white-0;
+  color: $white-0;
+
+  &:active,
+  &:hover {
+    background-color: $gray-10;
+    color: $gray-100;
+  }
+
+  // The "render icon" CSS seems to be missing in the latest Carbon button.
+  // Specifically, getting the icon to move to right-hand side of the content area.
+  // Repeating here.
+  svg {
+    position: absolute;
+    right: 1rem;
+    width: 1rem;
+    height: 1rem;
+    flex-shrink: 0;
+  }
+}

package/scss/components/InlineTip/_storybook-styles.scss

@@ -0,0 +1,20 @@
+//
+// 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.
+//
+
+@use '@carbon/styles/scss/spacing' as *;
+@use '../../global/styles/project-settings';
+
+.storybook--inline-tip-wide {
+  max-width: 784px;
+  // Allow enough space above the component to show the "X" tooltip.
+  margin-top: $spacing-07;
+}
+
+.storybook--inline-tip-narrow {
+  max-width: 348px;
+  margin-top: $spacing-07;
+}

package/scss/components/SidePanel/_side-panel.scss

@@ -110,10 +110,6 @@ $action-set-block-class: #{c4p-settings.$pkg-prefix}--action-set;
     position: sticky;
     z-index: 4;
     top: 0;
-    height: calc(
-      var(--#{$block-class}--title-container-height) -
-        var(--#{$block-class}--label-text-height)
-    );
     padding: $spacing-05 $spacing-05 $spacing-03 $spacing-05;
     background-color: $layer-01;
 
@@ -169,6 +165,7 @@ $action-set-block-class: #{c4p-settings.$pkg-prefix}--action-set;
 
     position: inherit;
     z-index: 4;
+    margin-bottom: calc(-1 * var(--#{$block-class}--label-text-height));
     background-color: $layer-01;
     opacity: var(--#{$block-class}--subtitle-opacity);
     transform: translateY(var(--#{$block-class}--title-y-position));

package/scss/components/SteppedAnimatedMedia/_index.scss

@@ -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.
+//
+
+@import './stepped-animated-media';

package/scss/components/SteppedAnimatedMedia/_stepped-animated-media.scss

@@ -0,0 +1,6 @@
+//
+// 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.
+//

package/scss/components/SteppedAnimatedMedia/_storybook-styles.scss

@@ -0,0 +1,13 @@
+//
+// 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.
+//
+
+@use '@carbon/layout/scss/convert' as *;
+
+.stepped-animated-media-stories__viewport {
+  /* stylelint-disable-next-line function-no-unknown */
+  width: to-rem(50px);
+}

package/scss/components/_index.scss

@@ -51,3 +51,4 @@
 @use './EditFullPage';
 @use './EditUpdateCards';
 @use './Checklist';
+@use './InlineTip';