@carbon/ibm-products 2.22.0 → 2.24.0

package/lib/components/InterstitialScreen/InterstitialScreen.js

@@ -0,0 +1,434 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InterstitialScreen = void 0;
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+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 _devtools = require("../../global/js/utils/devtools");
+var _settings = require("../../settings");
+var _lodash = require("lodash");
+var _iconsReact = require("@carbon/icons-react");
+var _react2 = require("@carbon/react");
+var _Carousel = require("../Carousel");
+var _SteppedAnimatedMedia = require("../SteppedAnimatedMedia");
+var _excluded = ["children", "className", "closeIconDescription", "domainName", "hideProgressIndicator", "interstitialAriaLabel", "isFullScreen", "isOpen", "media", "nextButtonLabel", "onClose", "previousButtonLabel", "productName", "headerClassName", "headerTitle", "startButtonLabel", "skipButtonLabel"];
+/**
+ * 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.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+// Other standard imports.
+//Close16
+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, "--interstitial-screen");
+var headerBlockClass = "".concat(blockClass, "--internal-header");
+var bodyBlockClass = "".concat(blockClass, "--internal-body");
+var componentName = 'InterstitialScreen';
+
+// 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 = {
+  closeIconDescription: 'Close',
+  domainName: '',
+  hideProgressIndicator: false,
+  interstitialAriaLabel: 'Interstitial screen',
+  isFullScreen: false,
+  isOpen: false,
+  nextButtonLabel: 'Next',
+  onClose: function onClose() {},
+  previousButtonLabel: 'Back',
+  productName: '',
+  skipButtonLabel: '',
+  startButtonLabel: 'Get started'
+};
+
+/**
+ * InterstitialScreen can be a full page or an overlay, and are
+ * shown on the first time a user accesses a new experience
+ * (e.g. upon first login or first time opening a page where a
+ * newly purchased capability is presented).
+ */
+var InterstitialScreen = exports.InterstitialScreen = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var _media$breakpoints, _media$breakpoints2;
+  var children = _ref.children,
+    className = _ref.className,
+    _ref$closeIconDescrip = _ref.closeIconDescription,
+    closeIconDescription = _ref$closeIconDescrip === void 0 ? defaults.closeIconDescription : _ref$closeIconDescrip,
+    _ref$domainName = _ref.domainName,
+    domainName = _ref$domainName === void 0 ? defaults.domainName : _ref$domainName,
+    _ref$hideProgressIndi = _ref.hideProgressIndicator,
+    hideProgressIndicator = _ref$hideProgressIndi === void 0 ? defaults.hideProgressIndicator : _ref$hideProgressIndi,
+    _ref$interstitialAria = _ref.interstitialAriaLabel,
+    interstitialAriaLabel = _ref$interstitialAria === void 0 ? defaults.interstitialAriaLabel : _ref$interstitialAria,
+    _ref$isFullScreen = _ref.isFullScreen,
+    isFullScreen = _ref$isFullScreen === void 0 ? defaults.isFullScreen : _ref$isFullScreen,
+    _ref$isOpen = _ref.isOpen,
+    isOpen = _ref$isOpen === void 0 ? defaults.isOpen : _ref$isOpen,
+    media = _ref.media,
+    _ref$nextButtonLabel = _ref.nextButtonLabel,
+    nextButtonLabel = _ref$nextButtonLabel === void 0 ? defaults.nextButtonLabel : _ref$nextButtonLabel,
+    _ref$onClose = _ref.onClose,
+    onClose = _ref$onClose === void 0 ? defaults.onClose : _ref$onClose,
+    _ref$previousButtonLa = _ref.previousButtonLabel,
+    previousButtonLabel = _ref$previousButtonLa === void 0 ? defaults.previousButtonLabel : _ref$previousButtonLa,
+    _ref$productName = _ref.productName,
+    productName = _ref$productName === void 0 ? defaults.productName : _ref$productName,
+    headerClassName = _ref.headerClassName,
+    headerTitle = _ref.headerTitle,
+    _ref$startButtonLabel = _ref.startButtonLabel,
+    startButtonLabel = _ref$startButtonLabel === void 0 ? defaults.startButtonLabel : _ref$startButtonLabel,
+    _ref$skipButtonLabel = _ref.skipButtonLabel,
+    skipButtonLabel = _ref$skipButtonLabel === void 0 ? defaults.skipButtonLabel : _ref$skipButtonLabel,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  var backupRef = (0, _react.useRef)();
+  var _forwardedRef = ref || backupRef;
+  var scrollRef = (0, _react.useRef)();
+  var startButtonRef = (0, _react.useRef)();
+  var nextButtonRef = (0, _react.useRef)();
+  var _useState = (0, _react.useState)(null),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    isVisibleClass = _useState2[0],
+    setIsVisibleClass = _useState2[1];
+  var _useState3 = (0, _react.useState)(0),
+    _useState4 = (0, _slicedToArray2.default)(_useState3, 2),
+    progStep = _useState4[0],
+    setProgStep = _useState4[1];
+  var childArray = _react.Children.toArray(children);
+  var isMultiStep = childArray.length > 1;
+  var mediaIsDefined = (media === null || media === void 0 ? void 0 : media.render) || (media === null || media === void 0 ? void 0 : media.filePaths);
+  var bodyScrollRef = (0, _react.useRef)();
+  var mediaBreakpoints = {
+    xlg: (media === null || media === void 0 || (_media$breakpoints = media.breakpoints) === null || _media$breakpoints === void 0 ? void 0 : _media$breakpoints.xlg) || 0,
+    lg: (media === null || media === void 0 || (_media$breakpoints2 = media.breakpoints) === null || _media$breakpoints2 === void 0 ? void 0 : _media$breakpoints2.lg) || 0,
+    md: 0,
+    sm: 0
+  };
+  var contentBreakpoints = {
+    xlg: 16 - mediaBreakpoints.xlg,
+    lg: 16 - mediaBreakpoints.lg,
+    md: 8,
+    sm: 4
+  };
+  var variantClass = isFullScreen ? "".concat(blockClass, "--full-screen") : "".concat(blockClass, "--modal");
+  var progStepFloor = 0;
+  var progStepCeil = childArray.length - 1;
+  var handleClose = (0, _react.useCallback)(function () {
+    setProgStep(0);
+    onClose();
+  }, [onClose]);
+  var scrollBodyToTop = function scrollBodyToTop() {
+    bodyScrollRef.current.scroll({
+      top: 0,
+      behavior: 'smooth'
+    });
+  };
+  var handleClickPrev = function handleClickPrev() {
+    var targetStep = (0, _lodash.clamp)(progStep - 1, progStepFloor, progStepCeil);
+    scrollRef.current.scrollPrev();
+    scrollBodyToTop();
+    setProgStep(targetStep);
+  };
+  var handleClickNext = function handleClickNext() {
+    var targetStep = (0, _lodash.clamp)(progStep + 1, progStepFloor, progStepCeil);
+    scrollRef.current.scrollNext();
+    scrollBodyToTop();
+    setProgStep(targetStep);
+  };
+  (0, _react.useEffect)(function () {
+    var _startButtonRef$curre;
+    if (!isOpen) {
+      setProgStep(0);
+    }
+    (_startButtonRef$curre = startButtonRef.current) === null || _startButtonRef$curre === void 0 || _startButtonRef$curre.focus();
+  }, [isOpen, progStep, onClose]);
+  (0, _react.useEffect)(function () {
+    var _nextButtonRef$curren;
+    // for modal only, "is-visible" triggers animation
+    setIsVisibleClass(!isFullScreen && isOpen ? 'is-visible' : null);
+    nextButtonRef === null || nextButtonRef === void 0 || (_nextButtonRef$curren = nextButtonRef.current) === null || _nextButtonRef$curren === void 0 || _nextButtonRef$curren.focus();
+  }, [isFullScreen, isOpen]);
+
+  // hitting escape key also closes this component
+  (0, _react.useEffect)(function () {
+    var close = function close(e) {
+      var key = e.key;
+      if (key === 'Escape') {
+        handleClose();
+      }
+    };
+    window.addEventListener('keydown', close);
+    return function () {
+      return window.removeEventListener('keydown', close);
+    };
+  }, [handleClose]);
+  if (!isOpen) {
+    return null;
+  }
+  var domainProductDelimiter = domainName !== '' && productName !== '' ? ' | ' : '';
+  var renderModal = function renderModal(childElements) {
+    return /*#__PURE__*/_react.default.createElement(_react2.ComposedModal, (0, _extends2.default)({}, rest, {
+      preventCloseOnClickOutside: true,
+      className: (0, _classnames.default)(blockClass,
+      // Apply the block class to the main HTML element
+      className // Apply any supplied class names to the main HTML element.
+      ),
+
+      size: "lg",
+      onClose: onClose,
+      open: isOpen,
+      ref: _forwardedRef,
+      "aria-label": interstitialAriaLabel
+    }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement(_react2.ModalHeader, {
+      className: (0, _classnames.default)(headerBlockClass, headerTitle && "".concat(headerBlockClass, "--has-title"), headerClassName),
+      iconDescription: closeIconDescription,
+      buttonOnClick: handleClose
+    }, headerTitle && /*#__PURE__*/_react.default.createElement("h2", null, headerTitle), !hideProgressIndicator && /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "--progress")
+    }, /*#__PURE__*/_react.default.createElement(_react2.ProgressIndicator, {
+      vertical: false,
+      currentIndex: progStep
+    }, childArray.map(function (child, idx) {
+      return /*#__PURE__*/_react.default.createElement(_react2.ProgressStep, {
+        key: idx,
+        label: child.props.stepTitle
+      });
+    })))), /*#__PURE__*/_react.default.createElement(_react2.ModalBody, {
+      className: bodyBlockClass
+    }, childElements), /*#__PURE__*/_react.default.createElement(_react2.ModalFooter, null, renderFooter()));
+  };
+  var renderFullScreen = function renderFullScreen(childElements) {
+    return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({}, rest, {
+      className: (0, _classnames.default)(blockClass,
+      // Apply the block class to the main HTML element
+      className,
+      // Apply any supplied class names to the main HTML element.
+      variantClass, isVisibleClass),
+      "aria-label": interstitialAriaLabel,
+      ref: ref
+    }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("div", {
+      className: (0, _classnames.default)([(0, _defineProperty2.default)({}, "".concat(blockClass, "--container"), isFullScreen)])
+    }, /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "--header")
+    }, domainName, domainProductDelimiter, /*#__PURE__*/_react.default.createElement("strong", null, productName)), /*#__PURE__*/_react.default.createElement("header", {
+      className: (0, _classnames.default)(headerBlockClass, headerTitle && "".concat(headerBlockClass, "--has-title"), headerClassName)
+    }, headerTitle && /*#__PURE__*/_react.default.createElement("h2", null, headerTitle), !hideProgressIndicator && /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "--progress")
+    }, /*#__PURE__*/_react.default.createElement(_react2.ProgressIndicator, {
+      vertical: false,
+      currentIndex: progStep
+    }, childArray.map(function (child, idx) {
+      return /*#__PURE__*/_react.default.createElement(_react2.ProgressStep, {
+        key: idx,
+        label: child.props.stepTitle
+      });
+    })))), childElements, renderFooter()));
+  };
+  var renderBody = function renderBody() {
+    return /*#__PURE__*/_react.default.createElement("div", {
+      className: (0, _classnames.default)("".concat(blockClass, "--body")),
+      ref: bodyScrollRef
+    }, mediaIsDefined ? /*#__PURE__*/_react.default.createElement(_react2.FlexGrid, {
+      fullWidth: true,
+      className: (0, _classnames.default)("".concat(blockClass, "--body-grid"))
+    }, /*#__PURE__*/_react.default.createElement(_react2.Row, {
+      className: (0, _classnames.default)("".concat(blockClass, "--body-row"))
+    }, /*#__PURE__*/_react.default.createElement(_react2.Column, {
+      xlg: contentBreakpoints.xlg,
+      lg: contentBreakpoints.lg,
+      md: contentBreakpoints.md,
+      sm: contentBreakpoints.sm
+    }, /*#__PURE__*/_react.default.createElement("div", {
+      className: (0, _classnames.default)("".concat(blockClass, "--content"))
+    }, isMultiStep ? /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "__carousel")
+    }, /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
+      disableArrowScroll: true,
+      ref: scrollRef
+    }, children)) : childArray[0])), mediaIsDefined && /*#__PURE__*/_react.default.createElement(_react2.Column, {
+      xlg: mediaBreakpoints.xlg,
+      lg: mediaBreakpoints.lg,
+      md: mediaBreakpoints.md,
+      sm: mediaBreakpoints.sm,
+      className: (0, _classnames.default)("".concat(blockClass, "--media-container"))
+    }, /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "--media")
+    }, media.render ? media.render() : /*#__PURE__*/_react.default.createElement(_SteppedAnimatedMedia.SteppedAnimatedMedia, {
+      className: "".concat(blockClass, "--stepped-animated-media"),
+      filePaths: media.filePaths,
+      playStep: progStep
+    }))))) : /*#__PURE__*/_react.default.createElement("div", {
+      className: (0, _classnames.default)("".concat(blockClass, "--content"))
+    }, isMultiStep ? /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "__carousel")
+    }, /*#__PURE__*/_react.default.createElement(_Carousel.Carousel, {
+      disableArrowScroll: true,
+      ref: scrollRef
+    }, children)) : /*#__PURE__*/_react.default.createElement("div", null, childArray[0])));
+  };
+  var renderFooter = function renderFooter() {
+    return /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "--footer")
+    }, isMultiStep && skipButtonLabel !== '' && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+      className: "".concat(blockClass, "--skip-btn"),
+      kind: "ghost",
+      size: "lg",
+      title: skipButtonLabel,
+      onClick: handleClose
+    }, skipButtonLabel), /*#__PURE__*/_react.default.createElement("div", {
+      className: "".concat(blockClass, "--footer-controls")
+    }, isMultiStep && progStep > 0 && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+      className: "".concat(blockClass, "--prev-btn"),
+      kind: "secondary",
+      size: "lg",
+      title: previousButtonLabel,
+      onClick: handleClickPrev
+    }, previousButtonLabel), isMultiStep && progStep < progStepCeil && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+      className: "".concat(blockClass, "--next-btn"),
+      renderIcon: _iconsReact.ArrowRight,
+      ref: nextButtonRef,
+      size: "lg",
+      title: nextButtonLabel,
+      onClick: handleClickNext
+    }, nextButtonLabel), isMultiStep && progStep === progStepCeil && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+      className: "".concat(blockClass, "--start-btn"),
+      ref: startButtonRef,
+      renderIcon: _iconsReact.ArrowRight,
+      size: "lg",
+      title: startButtonLabel,
+      onClick: handleClose
+    }, startButtonLabel), !isMultiStep && /*#__PURE__*/_react.default.createElement(_react2.Button, {
+      className: "".concat(blockClass, "--start-btn"),
+      ref: startButtonRef,
+      size: "lg",
+      title: startButtonLabel,
+      onClick: handleClose
+    }, startButtonLabel)));
+  };
+  return isFullScreen ? renderFullScreen(renderBody()) : renderModal(renderBody());
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.InterstitialScreen = InterstitialScreen = _settings.pkg.checkComponentEnabled(InterstitialScreen, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+InterstitialScreen.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.
+InterstitialScreen.propTypes = {
+  /**
+   * Provide the contents of the InterstitialScreen.
+   */
+  children: _propTypes.default.node.isRequired,
+  /**
+   * 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,
+  /**
+   * The domain this app belongs to, e.g. "IBM Cloud Pak".
+   */
+  domainName: _propTypes.default.string,
+  /**
+   * Provide an optional class to be applied to the <header> element >.
+   */
+  headerClassName: _propTypes.default.string,
+  /**
+   * Provide an optional class to be applied to the <header> element >.
+   */
+  headerTitle: _propTypes.default.string,
+  /**
+   * Optional parameter to hide the progress indicator when multiple steps are used.
+   */
+  hideProgressIndicator: _propTypes.default.bool,
+  /**
+   * The aria label applied to the Interstitial Screen component
+   */
+  interstitialAriaLabel: _propTypes.default.string,
+  /**
+   * Specifies whether the component is shown as a full-screen
+   * experience, else it is shown as a modal by default.
+   */
+  isFullScreen: _propTypes.default.bool,
+  /**
+   * Specifies whether the component is currently open.
+   */
+  isOpen: _propTypes.default.bool,
+  /**
+   * The object describing an image in one of two shapes.
+   *
+   * If a single media element is required, use `{render}`.
+   *
+   * If a stepped animation is required, use `{filePaths}`.
+   *
+   * Breakpoints are used to set the media content column size as well as the remainder for the main content areas column size.
+   * Medium and small breakpoints will be set to 0 internally to focus on the main content area.
+   * @see {@link MEDIA_PROP_TYPE}.
+   */
+  media: _propTypes.default.oneOfType([_propTypes.default.shape({
+    render: _propTypes.default.func,
+    breakpoints: _propTypes.default.shape({
+      xlg: _propTypes.default.number,
+      lg: _propTypes.default.number
+    })
+  }), _propTypes.default.shape({
+    filePaths: _propTypes.default.arrayOf(_propTypes.default.string),
+    breakpoints: _propTypes.default.shape({
+      xlg: _propTypes.default.number,
+      lg: _propTypes.default.number
+    })
+  })]),
+  /**
+   * The label for the Next button.
+   */
+  nextButtonLabel: _propTypes.default.string,
+  /**
+   * Function to call when the close button is clicked.
+   */
+  onClose: _propTypes.default.func,
+  /**
+   * The label for the Previous button.
+   */
+  previousButtonLabel: _propTypes.default.string,
+  /**
+   * The name of this app, e.g. "QRadar".
+   */
+  productName: _propTypes.default.string,
+  /**
+   * The label for the skip button.
+   */
+  skipButtonLabel: _propTypes.default.string,
+  /**
+   * The label for the start button.
+   */
+  startButtonLabel: _propTypes.default.string
+};

package/lib/components/InterstitialScreen/index.js

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

package/lib/components/InterstitialScreenView/InterstitialScreenView.js

@@ -0,0 +1,77 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InterstitialScreenView = 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 = ["children", "className", "stepTitle"];
+/**
+ * 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.
+// 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(_settings.pkg.prefix, "--interstitial-screen-view");
+var componentName = 'InterstitialScreenView';
+
+/**
+ * A Novice to Pro component intended to be used as the child elements of the InterstitialScreen component.
+ */
+var InterstitialScreenView = exports.InterstitialScreenView = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var children = _ref.children,
+    className = _ref.className,
+    stepTitle = _ref.stepTitle,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("div", (0, _extends2.default)({
+    role: "complementary",
+    "aria-label": stepTitle
+  }, rest, {
+    className: (0, _classnames.default)(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}`,
+    {
+      // switched classes dependant on props or state
+      // example: [`${blockClass}__here-if-small`]: size === 'sm',
+    }),
+    ref: ref
+  }, (0, _devtools.getDevtoolsProps)(componentName)), children);
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.InterstitialScreenView = InterstitialScreenView = _settings.pkg.checkComponentEnabled(InterstitialScreenView, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+InterstitialScreenView.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.
+InterstitialScreenView.propTypes = {
+  /**
+   * Provide the contents of the InterstitialScreenView.
+   */
+  children: _propTypes.default.node,
+  /**
+   * Optional class name for this component.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The label to pass to the ProgressStep component.
+   */
+  stepTitle: _propTypes.default.string.isRequired
+};

package/lib/components/InterstitialScreenView/index.js

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

package/lib/components/InterstitialScreenViewModule/InterstitialScreenViewModule.js

@@ -0,0 +1,85 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.InterstitialScreenViewModule = 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 = ["className", "title", "description"];
+/**
+ * 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.
+ */
+// Import portions of React that are needed.
+// Other standard imports.
+// 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(_settings.pkg.prefix, "--interstitial-screen-view-module");
+var componentName = 'InterstitialScreenViewModule';
+
+// 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.
+
+/**
+ * View module to help in building interstitial screen views.
+ */
+var InterstitialScreenViewModule = exports.InterstitialScreenViewModule = /*#__PURE__*/_react.default.forwardRef(function (_ref, ref) {
+  var className = _ref.className,
+    title = _ref.title,
+    description = _ref.description,
+    rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
+  return /*#__PURE__*/_react.default.createElement("section", (0, _extends2.default)({}, rest, {
+    className: (0, _classnames.default)(blockClass,
+    // Apply the block class to the main HTML element
+    className // Apply any supplied class names to the main HTML element.
+    ),
+
+    ref: ref
+  }, (0, _devtools.getDevtoolsProps)(componentName)), /*#__PURE__*/_react.default.createElement("h1", {
+    className: "".concat(blockClass, "--heading")
+  }, title), /*#__PURE__*/_react.default.createElement("p", {
+    className: "".concat(blockClass, "--body")
+  }, description));
+});
+
+// Return a placeholder if not released and not enabled by feature flag
+exports.InterstitialScreenViewModule = InterstitialScreenViewModule = _settings.pkg.checkComponentEnabled(InterstitialScreenViewModule, componentName);
+
+// The display name of the component, used by React. Note that displayName
+// is used in preference to relying on function.name.
+InterstitialScreenViewModule.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.
+InterstitialScreenViewModule.propTypes = {
+  /**
+   * Provide an optional class to be applied to the containing node.
+   */
+  className: _propTypes.default.string,
+  /**
+   * The description of this component.
+   */
+  description: _propTypes.default.string.isRequired,
+  /**
+   * The title of this component.
+   */
+  title: _propTypes.default.string.isRequired
+};

package/lib/components/InterstitialScreenViewModule/index.js

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

package/lib/components/PageHeader/PageHeaderUtils.js

@@ -76,8 +76,8 @@ var utilCheckUpdateVerticalSpace = exports.utilCheckUpdateVerticalSpace = functi
     var offsetMeasuringTop = offsetTopMeasuringRef.current ? offsetTopMeasuringRef.current.getBoundingClientRect().top : 0;
 
     // The header offset calculation is either going to work out at 0 if we have no gap between scrolling container
-    // top and the measuring ref top, or the difference between. It does not change on scroll or resize.
-    update.headerOffset = offsetMeasuringTop - scrollableContainerTop;
+    // top and the measuring ref top, or the difference between.
+    update.headerOffset = offsetMeasuringTop === 0 ? offsetMeasuringTop - scrollableContainerTop : 0;
 
     /* istanbul ignore next */
     update.breadcrumbRowHeight = breadcrumbRowEl ? breadcrumbRowEl.clientHeight : 0;