@carbon/ibm-products 2.17.2 → 2.18.1

package/lib/components/Datagrid/Datagrid/addons/Filtering/hooks/useFilters.js

@@ -86,7 +86,7 @@ var useFilters = function useFilters(_ref2) {
   /** Methods */
   // If the user decides to cancel or click outside the flyout, it reverts back to the filters that were
   // there when they opened the flyout
-  var revertToPreviousFilters = function revertToPreviousFilters() {
+  var revertToPreviousFilters = (0, _react2.useCallback)(function () {
     setFiltersState(JSON.parse(prevFiltersRef.current));
     setFiltersObjectArray(JSON.parse(prevFiltersObjectArrayRef.current));
     setAllFilters(JSON.parse(lastAppliedFilters.current));
@@ -96,7 +96,7 @@ var useFilters = function useFilters(_ref2) {
     holdingPrevFiltersRef.current = JSON.parse(prevFiltersRef.current);
     holdingLastAppliedFiltersRef.current = JSON.parse(prevFiltersObjectArrayRef.current);
     holdingPrevFiltersObjectArrayRef.current = JSON.parse(lastAppliedFilters.current);
-  };
+  }, [setAllFilters]);
   var reset = (0, _react2.useCallback)(function () {
     // When we reset we want the "initialFilters" to be an empty array
     var resetFiltersArray = [];
@@ -360,6 +360,7 @@ var useFilters = function useFilters(_ref2) {
    */
   (0, _react2.useEffect)(function () {
     if (!panelOpen && previousState !== null && previousState !== void 0 && previousState.panelOpen) {
+      revertToPreviousFilters();
       setAllFilters(holdingLastAppliedFiltersRef.current);
     }
     if (panelOpen && !(previousState !== null && previousState !== void 0 && previousState.panelOpen)) {
@@ -369,7 +370,7 @@ var useFilters = function useFilters(_ref2) {
         setAllFilters(JSON.parse(prevFiltersObjectArrayRef.current));
       }
     }
-  }, [panelOpen, previousState, previousState === null || previousState === void 0 ? void 0 : previousState.panelOpen, reset, setAllFilters]);
+  }, [panelOpen, previousState, previousState === null || previousState === void 0 ? void 0 : previousState.panelOpen, reset, setAllFilters, revertToPreviousFilters]);
   var cancel = function cancel() {
     // Reverting to previous filters only applies when using batch actions
     if (updateMethod === _constants.BATCH) {

package/lib/components/Datagrid/Extensions/Filtering/Filtering.docs-page.js

@@ -48,6 +48,12 @@ var DocsPage = exports.DocsPage = function DocsPage() {
     }, {
       subTitle: 'Create your filters for panel variant',
       description: 'Filter panel coming soon.'
+    }, {
+      subTitle: 'Customizing the filter tag labels',
+      description: 'You can customize the rendering of the filter tag labels by supplying the `renderLabel` property to your `filterProps` as seen below. Otherwise it will default to `key: value`.',
+      source: {
+        code: "\nfilterProps: {\n  ...otherFilterProps,\n  renderLabel: (key, value) => myCustomTagLabelFormatter(key, value),\n},\n          "
+      }
     }, {
       subTitle: 'Putting it all together',
       source: {
@@ -57,7 +63,7 @@ var DocsPage = exports.DocsPage = function DocsPage() {
       subTitle: "`filterProps` types",
       source: {
         language: 'json',
-        code: "\nfilterProps: {\n  /** The variation of filtering */\n  variation: 'flyout'|'panel',\n  /** The update method in which to filter, instant automatically\n      applies the filters, batch the user has to click apply */\n  updateMethod: 'batch'|'instant',\n  /** Text for primary action button, default is 'Apply' */\n  primaryActionLabel: string,\n  /** Text for secondary action button, default is 'Cancel' */\n  secondaryActionLabel: string,\n  /** Text for flyout icon description */\n  flyoutIconDescription: string,\n  /** Array of objects to render filters in flyout */\n  filters: object[]\n}\n          "
+        code: "\nfilterProps: {\n  /** The variation of filtering */\n  variation: 'flyout'|'panel',\n  /** The update method in which to filter, instant automatically\n      applies the filters, batch the user has to click apply */\n  updateMethod: 'batch'|'instant',\n  /** Text for primary action button, default is 'Apply' */\n  primaryActionLabel: string,\n  /** Text for secondary action button, default is 'Cancel' */\n  secondaryActionLabel: string,\n  /** Text for flyout icon description */\n  flyoutIconDescription: string,\n  /** Array of objects to render filters in flyout */\n  filters: object[]\n  /** Applies custom formatting to filter tags */\n  renderLabel: Function\n}\n          "
       }
     }]
   });

package/lib/components/Datagrid/utils/handleFilterTagLabelText.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.handleFilterTagLabelText = void 0;
+/**
+ * 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.
+ */
+
+// Example usage for custom filter tag labels, in practice this
+// is where a translation service would be utilized. This
+// utility is for storybook demonstration purposes only.
+var handleFilterTagLabelText = exports.handleFilterTagLabelText = function handleFilterTagLabelText(key, value) {
+  switch (key) {
+    case 'role':
+      return "Role: ".concat(value);
+    case 'joined':
+      return "Joined: ".concat(value);
+    case 'visits':
+      return "Visits: ".concat(value);
+    case 'passwordStrength':
+      return "Password strength: ".concat(value);
+    case 'status':
+      return "Status: ".concat(value);
+    default:
+      return "".concat(key, ": ").concat(value);
+  }
+};

package/lib/components/FilterSummary/FilterSummary.js

@@ -1,6 +1,7 @@
 "use strict";
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -8,22 +9,26 @@ exports.default = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
 var _react = require("@carbon/react");
-var _react2 = _interopRequireDefault(require("react"));
+var _react2 = _interopRequireWildcard(require("react"));
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _classnames = _interopRequireDefault(require("classnames"));
 var _TagSet = require("../TagSet");
 var _settings = require("../../settings");
+var _uuidv = _interopRequireDefault(require("../../global/js/utils/uuidv4"));
 var _excluded = ["key", "value"];
 /**
- * Copyright IBM Corp. 2022, 2022
+ * Copyright IBM Corp. 2022, 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.
  */
+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; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 var blockClass = "".concat(_settings.pkg.prefix, "--filter-summary");
 var FilterSummary = /*#__PURE__*/_react2.default.forwardRef(function (_ref, ref) {
+  var _filterSummaryClearBu;
   var _ref$className = _ref.className,
     className = _ref$className === void 0 ? '' : _ref$className,
     _ref$clearFiltersText = _ref.clearFiltersText,
@@ -35,7 +40,10 @@ var FilterSummary = /*#__PURE__*/_react2.default.forwardRef(function (_ref, ref)
     _ref$renderLabel = _ref.renderLabel,
     renderLabel = _ref$renderLabel === void 0 ? null : _ref$renderLabel,
     _ref$overflowType = _ref.overflowType,
-    overflowType = _ref$overflowType === void 0 ? 'default' : _ref$overflowType;
+    overflowType = _ref$overflowType === void 0 ? 'default' : _ref$overflowType,
+    _ref$clearButtonInlin = _ref.clearButtonInline,
+    clearButtonInline = _ref$clearButtonInlin === void 0 ? true : _ref$clearButtonInlin;
+  var filterSummaryId = "".concat(blockClass, "__").concat((0, _uuidv.default)());
   var tagFilters = filters.map(function (_ref2) {
     var _renderLabel;
     var key = _ref2.key,
@@ -46,26 +54,35 @@ var FilterSummary = /*#__PURE__*/_react2.default.forwardRef(function (_ref, ref)
       label: (_renderLabel = renderLabel === null || renderLabel === void 0 ? void 0 : renderLabel(key, value)) !== null && _renderLabel !== void 0 ? _renderLabel : "".concat(key, ": ").concat(value)
     });
   });
+  var filterSummaryClearButton = (0, _react2.useRef)();
+  var filterSummaryRef = (0, _react2.useRef)();
+  var localRef = filterSummaryRef || ref;
   return /*#__PURE__*/_react2.default.createElement("div", {
-    ref: ref,
-    className: (0, _classnames.default)([blockClass, className])
+    ref: localRef,
+    className: (0, _classnames.default)([blockClass, className]),
+    id: filterSummaryId
   }, /*#__PURE__*/_react2.default.createElement(_TagSet.TagSet, {
     allTagsModalSearchLabel: "Search all tags",
     allTagsModalSearchPlaceholderText: "Search all tags",
     allTagsModalTitle: "All tags",
     showAllTagsLabel: "View all tags",
     tags: tagFilters,
-    overflowType: overflowType
+    overflowType: overflowType,
+    className: (0, _classnames.default)((0, _defineProperty2.default)({}, "".concat(blockClass, "__clear-button-inline"), clearButtonInline)),
+    containingElementRef: localRef,
+    measurementOffset: filterSummaryClearButton === null || filterSummaryClearButton === void 0 || (_filterSummaryClearBu = filterSummaryClearButton.current) === null || _filterSummaryClearBu === void 0 ? void 0 : _filterSummaryClearBu.offsetWidth
   }), /*#__PURE__*/_react2.default.createElement(_react.Button, {
     kind: "ghost",
     size: "sm",
-    onClick: clearFilters
+    onClick: clearFilters,
+    ref: filterSummaryClearButton
   }, clearFiltersText));
 });
 var componentName = 'FilterSummary';
 FilterSummary.displayName = componentName;
 FilterSummary.propTypes = {
   className: _propTypes.default.string,
+  clearButtonInline: _propTypes.default.bool,
   clearFilters: _propTypes.default.func.isRequired,
   clearFiltersText: _propTypes.default.string,
   filters: _propTypes.default.arrayOf(_propTypes.default.object).isRequired,

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

@@ -0,0 +1,25 @@
+"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("./Guidebanner.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.collapsible
+    }, {
+      story: stories.manyInsights
+    }, {
+      story: stories.fewInsights
+    }]
+  });
+};
+var _default = exports.default = DocsPage;

package/lib/components/Guidebanner/Guidebanner.js

@@ -0,0 +1,229 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Guidebanner = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireWildcard(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _colors = require("@carbon/colors");
+var _icons = require("@carbon/react/icons");
+var _react2 = require("@carbon/react");
+var _Carousel = require("../Carousel");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["children", "className", "collapsible", "onClose", "closeIconDescription", "collapseButtonLabel", "expandButtonLabel", "nextIconDescription", "previousIconDescription", "title"];
+/**
+ * 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.
+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, "--guidebanner");
+var componentName = 'Guidebanner';
+var defaults = {
+  collapsible: false,
+  // Labels
+  closeIconDescription: 'Close',
+  collapseButtonLabel: 'Read less',
+  expandButtonLabel: 'Read more',
+  nextIconDescription: 'Next',
+  previousIconDescription: 'Back'
+};
+
+/**
+ * The guide banner sits at the top of a page, or page-level tab,
+ * to introduce foundational concepts related to the page's content.
+ */
+var Guidebanner = exports.Guidebanner = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$collapsible = _ref.collapsible,
+    collapsible = _ref$collapsible === void 0 ? defaults.collapsible : _ref$collapsible,
+    onClose = _ref.onClose,
+    _ref$closeIconDescrip = _ref.closeIconDescription,
+    closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
+    _ref$collapseButtonLa = _ref.collapseButtonLabel,
+    collapseButtonLabel = _ref$collapseButtonLa === void 0 ? defaults.collapseButtonLabel : _ref$collapseButtonLa,
+    _ref$expandButtonLabe = _ref.expandButtonLabel,
+    expandButtonLabel = _ref$expandButtonLabe === void 0 ? defaults.expandButtonLabel : _ref$expandButtonLabe,
+    _ref$nextIconDescript = _ref.nextIconDescription,
+    nextIconDescription = _ref$nextIconDescript === void 0 ? defaults.nextIconDescription : _ref$nextIconDescript,
+    _ref$previousIconDesc = _ref.previousIconDescription,
+    previousIconDescription = _ref$previousIconDesc === void 0 ? defaults.previousIconDescription : _ref$previousIconDesc,
+    title = _ref.title,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var scrollRef = (0, _react.useRef)();
+  var toggleRef = (0, _react.useRef)();
+  var _useState = (0, _react.useState)(0),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    scrollPosition = _useState2[0],
+    setScrollPosition = _useState2[1];
+  var _useState3 = (0, _react.useState)(false),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    showNavigation = _useState4[0],
+    setShowNavigation = _useState4[1];
+  var _useState5 = (0, _react.useState)(collapsible ? true : false),
+    _useState6 = (0, _slicedToArray2.default)(_useState5, 2),
+    isCollapsed = _useState6[0],
+    setIsCollapsed = _useState6[1];
+  var handleClickToggle = function handleClickToggle() {
+    setIsCollapsed(function (prevState) {
+      return !prevState;
+    });
+  };
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    "aria-expanded": !isCollapsed,
+    className: (0, _classnames.default)(blockClass, className, [collapsible ? "".concat(blockClass, "__collapsible") : null], [isCollapsed ? "".concat(blockClass, "__collapsible-collapsed") : null]),
+    ref: ref
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement(_icons.Idea, {
+    size: 20,
+    className: "".concat(blockClass, "__icon-idea")
+  }), /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "__title")
+  }, title), /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
+    className: "".concat(blockClass, "__carousel")
+    // These colors are to match the Carousel's faded edges
+    // against the Guidebanner's gradient background.
+    ,
+    fadedEdgeColor: {
+      left: _colors.blue90,
+      right: _colors.purple70
+    },
+    ref: scrollRef,
+    onChangeIsScrollable: function onChangeIsScrollable(value) {
+      setShowNavigation(value);
+    },
+    onScroll: function onScroll(scrollPercent) {
+      setScrollPosition(scrollPercent);
+    }
+  }, children), /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _classnames.default)([collapsible || showNavigation ? "".concat(blockClass, "__navigation") : null])
+  }, collapsible && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+    kind: "ghost",
+    size: "md",
+    className: "".concat(blockClass, "__toggle-button"),
+    onClick: handleClickToggle,
+    ref: toggleRef
+  }, isCollapsed ? expandButtonLabel : collapseButtonLabel), showNavigation && /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("span", {
+    className: (0, _classnames.default)("".concat(blockClass, "__back-button"), [scrollPosition === 0 ? "".concat(blockClass, "__back-button--disabled") : null])
+  }, /*#__PURE__*/_react.default.createElement(_react2.IconButton, {
+    align: "top",
+    disabled: scrollPosition === 0,
+    kind: "ghost",
+    label: previousIconDescription,
+    onClick: function onClick() {
+      scrollRef.current.scrollPrev();
+    },
+    size: "md"
+  }, /*#__PURE__*/_react.default.createElement(_icons.CaretLeft, {
+    size: 16
+  }))), /*#__PURE__*/_react.default.createElement("span", {
+    className: (0, _classnames.default)("".concat(blockClass, "__next-button"), [scrollPosition === 1 ? "".concat(blockClass, "__next-button--disabled") : null])
+  }, /*#__PURE__*/_react.default.createElement(_react2.IconButton, {
+    align: "top-right",
+    disabled: scrollPosition === 1,
+    kind: "ghost",
+    label: nextIconDescription,
+    onClick: function onClick() {
+      scrollRef.current.scrollNext();
+    },
+    size: "md"
+  }, /*#__PURE__*/_react.default.createElement(_icons.CaretRight, {
+    size: 16
+  }))))), onClose && /*#__PURE__*/_react.default.createElement("span", {
+    className: "".concat(blockClass, "__close-button")
+  }, /*#__PURE__*/_react.default.createElement(_react2.IconButton, {
+    align: "bottom-right",
+    kind: "ghost",
+    label: closeIconDescription,
+    onClick: onClose,
+    size: "md"
+  }, /*#__PURE__*/_react.default.createElement(_icons.Close, {
+    size: 16
+  }))));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.Guidebanner = Guidebanner = _settings.pkg.checkComponentEnabled(Guidebanner, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+Guidebanner.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.
+Guidebanner.propTypes = {
+  /**
+   * Provide the contents of the Guidebanner.
+   * One or more GuidebannerElement components are required.
+   */
+  children: function children(props, propName) {
+    var error;
+    var prop = props[propName];
+    if (!prop) {
+      error = new Error('`Guidebanner` requires one or more children of type `GuidebannerElement`.');
+    }
+    _react.default.Children.forEach(prop, function (child) {
+      if (child.type.displayName !== 'GuidebannerElement') {
+        var _child$type, _child$type2;
+        // If not GuidebannerElement, then show:
+        // React component name(child.type?.name) or
+        // HTML element name(child.type).
+        error = new Error("`Guidebanner` only accepts children of type `GuidebannerElement`, found `".concat(((_child$type = child.type) === null || _child$type === void 0 ? void 0 : _child$type.displayName) || ((_child$type2 = child.type) === null || _child$type2 === void 0 ? void 0 : _child$type2.name) || child.type, "` instead."));
+      }
+    });
+    return error;
+  },
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+  /**
+   * Tooltip text and aria label for the Close button icon.
+   */
+  closeIconDescription: _propTypes.default.string,
+  /**
+   * Text label for the Collapse button.
+   */
+  collapseButtonLabel: _propTypes.default.string,
+  /**
+   * When true, the Guidebanner will initialize in a collapsed state,
+   * showing the title and the Expand button.
+   *
+   * When expanded, it will show the GuidebannerElement child components and the Collapse button.
+   */
+  collapsible: _propTypes.default.bool,
+  /**
+   * Text label for the Expand button.
+   */
+  expandButtonLabel: _propTypes.default.string,
+  /**
+   * Tooltip text and aria label for the Next button icon.
+   */
+  nextIconDescription: _propTypes.default.string,
+  /**
+   * If defined, a Close button will render in the top-right corner and a
+   * callback function will be triggered when button is clicked.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * Tooltip text and aria label for the Back button icon.
+   */
+  previousIconDescription: _propTypes.default.string,
+  /**
+   * Title text.
+   */
+  title: _propTypes.default.string.isRequired
+};

package/lib/components/Guidebanner/GuidebannerElement.js

@@ -0,0 +1,77 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GuidebannerElement = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["button", "className", "description", "title"];
+/**
+ * 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.
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--guidebanner__element");
+var componentName = 'GuidebannerElement';
+
+/**
+ * The GuidebannerElement is a required child component of the Guidebanner,
+ * and acts as a container for a CarouselItem.
+ */
+var GuidebannerElement = exports.GuidebannerElement = function GuidebannerElement(_ref) {
+  var button = _ref.button,
+    className = _ref.className,
+    description = _ref.description,
+    title = _ref.title,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, className)
+  }, (0, _devtools.getDevtoolsProps)(componentName)), title && /*#__PURE__*/_react.default.createElement("h2", {
+    className: "".concat(blockClass, "-title")
+  }, title), description && /*#__PURE__*/_react.default.createElement("p", {
+    className: "".concat(blockClass, "-content")
+  }, description), button && /*#__PURE__*/_react.default.createElement("div", {
+    className: "".concat(blockClass, "-buttons")
+  }, button));
+};
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.GuidebannerElement = GuidebannerElement = _settings.pkg.checkComponentEnabled(GuidebannerElement, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+GuidebannerElement.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.
+GuidebannerElement.propTypes = {
+  /**
+   * An optional button can be rendered below the description.
+   * This can be a link, button, Coachmark button, etc.
+   */
+  button: _propTypes.default.node,
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The description of the element.
+   */
+
+  description: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.node]).isRequired,
+  /**
+   * The title of the element.
+   */
+  title: _propTypes.default.string
+};

package/lib/components/Guidebanner/GuidebannerElementButton.js

@@ -0,0 +1,85 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GuidebannerElementButton = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _react2 = require("@carbon/react");
+var _icons = require("@carbon/react/icons");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["children", "className", "type"];
+/**
+ * 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.
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--guidebanner__element-button");
+var componentName = 'GuidebannerElementButton';
+
+/**
+ * One of two buttons styled specifically for the GuidebannerElement.
+ */
+var GuidebannerElementButton = exports.GuidebannerElementButton = function GuidebannerElementButton(_ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    type = _ref.type,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  if (type === 'primary') {
+    return /*#__PURE__*/_react.default.createElement(_react2.Button, (0, _extends2.default)({}, rest, {
+      className: (0, _classnames.default)(blockClass, className),
+      iconDescription: 'Crossroads',
+      kind: "tertiary",
+      renderIcon: function renderIcon() {
+        return /*#__PURE__*/_react.default.createElement(_icons.Crossroads, {
+          size: 16
+        });
+      },
+      role: "button",
+      size: "md"
+    }, (0, _devtools.getDevtoolsProps)(componentName)), children);
+  }
+  return /*#__PURE__*/_react.default.createElement(_react2.Button, (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, className),
+    kind: "ghost",
+    role: "button",
+    size: "md"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), children);
+};
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.GuidebannerElementButton = GuidebannerElementButton = _settings.pkg.checkComponentEnabled(GuidebannerElementButton, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+GuidebannerElementButton.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.
+GuidebannerElementButton.propTypes = {
+  /**
+   * Provide the contents of the GuidebannerElementButton.
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+  /**
+   * If type is "primary", then return a tertiary button with the "crossroads" icon,
+   * else return a ghost button.
+   */
+  type: _propTypes.default.string
+
+  /* TODO: add types and DocGen for all props. */
+};

package/lib/components/Guidebanner/GuidebannerElementLink.js

@@ -0,0 +1,62 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GuidebannerElementLink = void 0;
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
+var _react = _interopRequireDefault(require("react"));
+var _propTypes = _interopRequireDefault(require("prop-types"));
+var _classnames = _interopRequireDefault(require("classnames"));
+var _react2 = require("@carbon/react");
+var _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _excluded = ["children", "className"];
+/**
+ * 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.
+// The block part of our conventional BEM class names (blockClass__E--M).
+var blockClass = "".concat(_settings.pkg.prefix, "--guidebanner__element-link");
+var componentName = 'GuidebannerElementLink';
+
+/**
+ * A link styled specifically for the GuidebannerElement.
+ */
+var GuidebannerElementLink = exports.GuidebannerElementLink = function GuidebannerElementLink(_ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement(_react2.Link, (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass, className),
+    kind: "ghost",
+    role: "link",
+    size: "md"
+  }, (0, _devtools.getDevtoolsProps)(componentName)), children);
+};
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.GuidebannerElementLink = GuidebannerElementLink = _settings.pkg.checkComponentEnabled(GuidebannerElementLink, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+GuidebannerElementLink.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.
+GuidebannerElementLink.propTypes = {
+  /**
+   * Provide the contents of the GuidebannerElementLink.
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string
+};