@splunk/react-page 6.1.1 → 6.3.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 Change Log
 ============
 
+6.3.0 - August 1, 2023
+----------
+New Features:
+* `options.onLayoutComplete` parameter supports a callback function which executes after layout API is fetched and compiled.
+
+6.2.0 - July 27, 2023
+----------
+New Features:
+* `options.lazyLoadLayout` parameter has been added to `layout` to allow lazy loading of layout (SPL-241546).
+* `options.splunkBarFallback` and `options.appBarFallback` parameters have been added to `layout` to allow customization of fallback components for the layout (SPL-241546).
+
+Notes:
+* An container element has been added to the DOM for the app content to support `lazyLoadLayout`
+
 6.1.1 - June 6, 2023
 ----------
 API Changes:
@@ -9,7 +23,7 @@ API Changes:
 6.1.0 - May 2, 2023
 ----------
 New Features:
-* a new `options.loader` parameter has been added to `layout` to allow `requirejs` to be used instead of `scriptjs` (SUI-5341).
+* A new `options.loader` parameter has been added to `layout` to allow `requirejs` to be used instead of `scriptjs` (SUI-5341).
 
 Bug Fixes:
 * `layout` will no longer automatically fall back to `requirejs` if `scriptjs` fails to load, reversing the behavior introduced in 6.0.4 (SUI-5341).

package/cypress.config.js

@@ -0,0 +1,21 @@
+/* eslint-env node */
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+    env: {},
+    defaultCommandTimeout: 1000,
+    fixturesFolder: false,
+    video: false,
+    videoUploadOnPasses: false,
+    e2e: {
+        setupNodeEvents(on) {
+            on('before:browser:launch', (browser = {}, launchOptions) => {
+                if (browser.name === 'chrome') {
+                    launchOptions.args.push('--disable-gpu');
+                }
+            });
+        },
+        baseUrl: 'http://localhost:8000',
+        specPattern: 'src/tests/**.spec.js',
+    },
+});

package/lib/index.js

@@ -107,7 +107,7 @@ module.exports = require("styled-components");
 /* 3 */
 /***/ (function(module, exports) {
 
-module.exports = require("react-dom");
+module.exports = require("prop-types");
 
 /***/ }),
 /* 4 */
@@ -119,7 +119,7 @@ module.exports = require("@splunk/themes/SplunkThemeProvider");
 /* 5 */
 /***/ (function(module, exports) {
 
-module.exports = require("prop-types");
+module.exports = require("react-dom");
 
 /***/ }),
 /* 6 */
@@ -159,13 +159,13 @@ module.exports = require("@splunk/ui-utils/i18n");
 // ESM COMPAT FLAG
 __webpack_require__.r(__webpack_exports__);
 
+// EXTERNAL MODULE: external "react-dom"
+var external_react_dom_ = __webpack_require__(5);
+
 // EXTERNAL MODULE: external "react"
 var external_react_ = __webpack_require__(0);
 var external_react_default = /*#__PURE__*/__webpack_require__.n(external_react_);
 
-// EXTERNAL MODULE: external "react-dom"
-var external_react_dom_ = __webpack_require__(3);
-
 // EXTERNAL MODULE: external "scriptjs"
 var external_scriptjs_ = __webpack_require__(6);
 var external_scriptjs_default = /*#__PURE__*/__webpack_require__.n(external_scriptjs_);
@@ -180,17 +180,6 @@ var url_ = __webpack_require__(8);
 var SplunkThemeProvider_ = __webpack_require__(4);
 var SplunkThemeProvider_default = /*#__PURE__*/__webpack_require__.n(SplunkThemeProvider_);
 
-// EXTERNAL MODULE: external "prop-types"
-var external_prop_types_ = __webpack_require__(5);
-var external_prop_types_default = /*#__PURE__*/__webpack_require__.n(external_prop_types_);
-
-// EXTERNAL MODULE: external "@splunk/react-ui/ScreenReaderContent"
-var ScreenReaderContent_ = __webpack_require__(9);
-var ScreenReaderContent_default = /*#__PURE__*/__webpack_require__.n(ScreenReaderContent_);
-
-// EXTERNAL MODULE: external "@splunk/ui-utils/i18n"
-var i18n_ = __webpack_require__(10);
-
 // EXTERNAL MODULE: external "styled-components"
 var external_styled_components_ = __webpack_require__(2);
 var external_styled_components_default = /*#__PURE__*/__webpack_require__.n(external_styled_components_);
@@ -220,7 +209,7 @@ function _templateObject5() {
 }
 
 function _templateObject4() {
-  var data = _taggedTemplateLiteral(["\n    background-color: ", ";\n    min-height: 44px;\n"]);
+  var data = _taggedTemplateLiteral(["\n    background-color: ", ";\n    min-height: ", "px;\n"]);
 
   _templateObject4 = function _templateObject4() {
     return data;
@@ -230,7 +219,7 @@ function _templateObject4() {
 }
 
 function _templateObject3() {
-  var data = _taggedTemplateLiteral(["\n    padding: 0;\n    background-color: ", ";\n    height: 34px;\n"]);
+  var data = _taggedTemplateLiteral(["\n    padding: 0;\n    background-color: ", ";\n    height: ", "px;\n"]);
 
   _templateObject3 = function _templateObject3() {
     return data;
@@ -263,22 +252,35 @@ function _taggedTemplateLiteral(strings, raw) { if (!raw) { raw = strings.slice(
 
 
 
+var APPBAR_HEIGHT = 45;
+var SPLUNKBAR_HEIGHT = 34;
 var blink = Object(external_styled_components_["keyframes"])(_templateObject());
 var Main = external_styled_components_default.a.div(_templateObject2(), themes_["variables"].backgroundColorPage);
 var SplunkBar = external_styled_components_default.a.div(_templateObject3(), Object(themes_["pick"])({
   prisma: themes_["variables"].backgroundColorSection,
   enterprise: themes_["variables"].gray20
-}));
+}), SPLUNKBAR_HEIGHT);
 var AppBar = external_styled_components_default.a.div(_templateObject4(), Object(themes_["pick"])({
   prisma: themes_["variables"].backgroundColorPopup,
   enterprise: themes_["variables"].gray30
-}));
+}), APPBAR_HEIGHT);
 var AppBody = external_styled_components_default.a.div(_templateObject5(), themes_["variables"].contentColorInverted);
 var Dot = external_styled_components_default.a.div(_templateObject6(), blink, themes_["variables"].neutral500, Object(themes_["pick"])({
   prisma: themes_["variables"].spacingMedium,
   enterprise: themes_["variables"].spacingHalf
 }));
 
+// EXTERNAL MODULE: external "prop-types"
+var external_prop_types_ = __webpack_require__(3);
+var external_prop_types_default = /*#__PURE__*/__webpack_require__.n(external_prop_types_);
+
+// EXTERNAL MODULE: external "@splunk/react-ui/ScreenReaderContent"
+var ScreenReaderContent_ = __webpack_require__(9);
+var ScreenReaderContent_default = /*#__PURE__*/__webpack_require__.n(ScreenReaderContent_);
+
+// EXTERNAL MODULE: external "@splunk/ui-utils/i18n"
+var i18n_ = __webpack_require__(10);
+
 // CONCATENATED MODULE: ./src/Loading.jsx
 
 
@@ -288,25 +290,31 @@ var Dot = external_styled_components_default.a.div(_templateObject6(), blink, th
 var propTypes = {
   hideAppBar: external_prop_types_default.a.bool,
   hideChrome: external_prop_types_default.a.bool,
-  hideSplunkBar: external_prop_types_default.a.bool
+  hideSplunkBar: external_prop_types_default.a.bool,
+  AppBarFallback: external_prop_types_default.a.elementType,
+  SplunkBarFallback: external_prop_types_default.a.elementType
 };
 var defaultProps = {
   hideAppBar: false,
   hideChrome: false,
-  hideSplunkBar: false
+  hideSplunkBar: false,
+  AppBarFallback: AppBar,
+  SplunkBarFallback: SplunkBar
 };
 
 function Loading(_ref) {
   var hideAppBar = _ref.hideAppBar,
       hideChrome = _ref.hideChrome,
-      hideSplunkBar = _ref.hideSplunkBar;
-  return /*#__PURE__*/external_react_default.a.createElement(Main, null, !hideChrome && !hideSplunkBar && /*#__PURE__*/external_react_default.a.createElement(SplunkBar, null), !hideChrome && !hideAppBar && /*#__PURE__*/external_react_default.a.createElement(AppBar, null), /*#__PURE__*/external_react_default.a.createElement(AppBody, null, /*#__PURE__*/external_react_default.a.createElement(Dot, null), /*#__PURE__*/external_react_default.a.createElement(Dot, null), /*#__PURE__*/external_react_default.a.createElement(Dot, null), /*#__PURE__*/external_react_default.a.createElement(ScreenReaderContent_default.a, null, Object(i18n_["_"])('Loading'))));
+      hideSplunkBar = _ref.hideSplunkBar,
+      SplunkBarFallback = _ref.SplunkBarFallback,
+      AppBarFallback = _ref.AppBarFallback;
+  return /*#__PURE__*/external_react_default.a.createElement(Main, null, !hideChrome && !hideSplunkBar && /*#__PURE__*/external_react_default.a.createElement(SplunkBarFallback, null), !hideChrome && !hideAppBar && /*#__PURE__*/external_react_default.a.createElement(AppBarFallback, null), /*#__PURE__*/external_react_default.a.createElement(AppBody, null, /*#__PURE__*/external_react_default.a.createElement(Dot, null), /*#__PURE__*/external_react_default.a.createElement(Dot, null), /*#__PURE__*/external_react_default.a.createElement(Dot, null), /*#__PURE__*/external_react_default.a.createElement(ScreenReaderContent_default.a, null, Object(i18n_["_"])('Loading'))));
 }
 
 Loading.propTypes = propTypes;
 Loading.defaultProps = defaultProps;
 /* harmony default export */ var src_Loading = (Loading);
-// CONCATENATED MODULE: ./src/index.jsx
+// CONCATENATED MODULE: ./src/baseLayout.jsx
 function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
 
 function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
@@ -320,6 +328,7 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
 
 var LIGHT_LAYOUT = 'build/api/layout.js';
 var DARK_LAYOUT = 'build/api/layout-dark.js';
+var HEADER_SELECTOR = 'header[data-view="splunkjs/mvc/headerview"]';
 /**
  * Loads the layout from the server, using requirejs if available on the window and scriptjs if not.
  *
@@ -352,10 +361,29 @@ function getLayoutApi(theme, callback) {
     throw new Error('Invalid options.loader configuration: must be "scriptjs" or "requirejs".');
   }
 }
+/**
+ * renders body element and attaches it to container node in DOM
+ *
+ * @param {element} element
+ * @param {element} render - A render function that returns an unmount() function.
+ * @param {HTMLDivElement} container
+ * @param {boolean} useGlobalLayerStack
+ * @param {object} splunkTheme
+ * @private
+ */
+
+
+function renderBody(element, render, container) {
+  var useGlobalLayerStack = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+  var splunkTheme = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+  var wrappedElement = useGlobalLayerStack ? /*#__PURE__*/external_react_default.a.createElement(Layer_["LayerStackGlobalProvider"], null, /*#__PURE__*/external_react_default.a.createElement(SplunkThemeProvider_default.a, splunkTheme, element)) : /*#__PURE__*/external_react_default.a.createElement(SplunkThemeProvider_default.a, splunkTheme, element);
+  return render(wrappedElement, container);
+}
 /**
  * Renders a React element into the Layout API.
  * @public
  * @param {element} element - A React element.
+ * @param {element} render - A render function that returns an unmount() function.
  * @param {object} [options]
  * @param {string} [options.pageTitle] - Changes the page title.
  * @param {Boolean} [options.hideAppBar = false] - Hides the app bar.
@@ -371,11 +399,15 @@ function getLayoutApi(theme, callback) {
  * @param {String} [options.theme = 'light'] - Used to theme UI elements. Ex. "light" or "dark".
  * @param {String} [options.loader = 'scriptjs'] - Configures the loader used for the loading the layout - available loaders are "scriptjs" and "requirejs".
  * Change this only if the default loader does not work for your application.
+ * @param {Boolean} [options.lazyLoadLayout = false] - Prioritizes loading the React element and lazily fetches and compiles the layout API (navigation bar).
+ * @param {element} [options.SplunkBarFallback = SplunkBar] - A React element used as a placeholder for the splunk bar while the navigation bar is loading.
+ * @param {element} [options.AppBarFallback = AppBar] - A React element used as a placeholder for the app bar while the navigation bar is loading.
+ * @param {function} [options.onLayoutComplete] - A callback function which executes after layout API is fetched and compiled.
  */
 
 
-function layout(element) {
-  var _ref2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+function layout(element, render) {
+  var _ref2 = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
 
   var _ref2$useGlobalLayerS = _ref2.useGlobalLayerStack,
       useGlobalLayerStack = _ref2$useGlobalLayerS === void 0 ? true : _ref2$useGlobalLayerS,
@@ -390,7 +422,18 @@ function layout(element) {
     document.title = pageTitle;
   }
 
-  var loadingContainer = document.createElement('div'); // The "theme" in enterprise used to be "enterprise" instead of "light"...
+  var hideChrome = layoutAPIOptions.hideChrome,
+      hideAppBar = layoutAPIOptions.hideAppBar,
+      hideSplunkBar = layoutAPIOptions.hideSplunkBar,
+      _layoutAPIOptions$Spl = layoutAPIOptions.SplunkBarFallback,
+      SplunkBarFallback = _layoutAPIOptions$Spl === void 0 ? SplunkBar : _layoutAPIOptions$Spl,
+      _layoutAPIOptions$App = layoutAPIOptions.AppBarFallback,
+      AppBarFallback = _layoutAPIOptions$App === void 0 ? AppBar : _layoutAPIOptions$App,
+      _layoutAPIOptions$laz = layoutAPIOptions.lazyLoadLayout,
+      lazyLoadLayout = _layoutAPIOptions$laz === void 0 ? false : _layoutAPIOptions$laz,
+      onLayoutComplete = layoutAPIOptions.onLayoutComplete;
+  var bodyContainer = document.createElement('div');
+  var headerContainer = document.createElement('div'); // The "theme" in enterprise used to be "enterprise" instead of "light"...
 
   var colorScheme = theme === 'light' || theme === 'enterprise' ? 'light' : 'dark';
   var splunkTheme = {
@@ -398,8 +441,23 @@ function layout(element) {
     colorScheme: colorScheme,
     density: 'comfortable'
   };
-  document.body.appendChild(loadingContainer);
-  Object(external_react_dom_["render"])( /*#__PURE__*/external_react_default.a.createElement(SplunkThemeProvider_default.a, splunkTheme, /*#__PURE__*/external_react_default.a.createElement(src_Loading, layoutAPIOptions)), loadingContainer);
+  var bodyRoot;
+  var headerRoot;
+
+  if (lazyLoadLayout) {
+    // render the React app immediately without waiting for layout API
+    document.body.appendChild(headerContainer);
+    headerRoot = render( /*#__PURE__*/external_react_default.a.createElement(external_react_default.a.Fragment, null, !hideChrome && !hideSplunkBar && /*#__PURE__*/external_react_default.a.createElement(SplunkBarFallback, null), !hideChrome && !hideAppBar && /*#__PURE__*/external_react_default.a.createElement(AppBarFallback, null)), headerContainer); // explicitly set height of header container to avoid layout shift when fallback gets replaced
+
+    var headerHeight = headerContainer.offsetHeight;
+    headerContainer.style.cssText = "height: ".concat(headerHeight, "px");
+    document.body.appendChild(bodyContainer);
+    bodyRoot = renderBody(element, render, bodyContainer, useGlobalLayerStack, splunkTheme);
+  } else {
+    document.body.appendChild(bodyContainer);
+    bodyRoot = render( /*#__PURE__*/external_react_default.a.createElement(SplunkThemeProvider_default.a, splunkTheme, /*#__PURE__*/external_react_default.a.createElement(src_Loading, layoutAPIOptions)), bodyContainer);
+  }
+
   getLayoutApi(theme, function (layoutApi) {
     var containerEl;
 
@@ -433,18 +491,72 @@ function layout(element) {
       document.body.appendChild(containerEl);
     }
 
-    setTimeout(function () {
-      Object(external_react_dom_["unmountComponentAtNode"])(loadingContainer);
-      loadingContainer.parentNode.removeChild(loadingContainer);
-      var wrappedElement = useGlobalLayerStack ? /*#__PURE__*/external_react_default.a.createElement(Layer_["LayerStackGlobalProvider"], null, /*#__PURE__*/external_react_default.a.createElement(SplunkThemeProvider_default.a, splunkTheme, element)) : /*#__PURE__*/external_react_default.a.createElement(SplunkThemeProvider_default.a, splunkTheme, element);
-      Object(external_react_dom_["render"])(wrappedElement, containerEl);
-    }, 30);
+    if (lazyLoadLayout) {
+      // replace placeholder nav bar with real nav bar
+      headerRoot.unmount(headerContainer);
+      var header = document.querySelector(HEADER_SELECTOR);
+      var containerHeight = (!hideChrome && !hideSplunkBar ? SPLUNKBAR_HEIGHT : 0) + (!hideChrome && !hideAppBar ? APPBAR_HEIGHT : 0);
+      headerContainer.style.cssText = "height: ".concat(containerHeight, "px");
+      headerContainer.appendChild(header);
+      containerEl.appendChild(bodyContainer);
+      onLayoutComplete === null || onLayoutComplete === void 0 ? void 0 : onLayoutComplete();
+    } else {
+      setTimeout(function () {
+        bodyRoot.unmount(bodyContainer);
+        bodyRoot = renderBody(element, render, bodyContainer, useGlobalLayerStack, splunkTheme);
+        containerEl.appendChild(bodyContainer);
+        onLayoutComplete === null || onLayoutComplete === void 0 ? void 0 : onLayoutComplete();
+      }, 30);
+    }
   }, {
     loader: loader
   });
 }
 
-/* harmony default export */ var src = __webpack_exports__["default"] = (layout);
+/* harmony default export */ var baseLayout = (layout);
+// CONCATENATED MODULE: ./src/index.jsx
+
+
+
+var src_renderShim = function renderShim(elementToRender, container) {
+  Object(external_react_dom_["render"])(elementToRender, container);
+  return {
+    unmount: function unmount() {
+      return Object(external_react_dom_["unmountComponentAtNode"])(container);
+    }
+  };
+};
+/**
+ * Renders a React element into the Layout API.
+ * @public
+ * @param {element} element - A React element.
+ * @param {object} [options]
+ * @param {string} [options.pageTitle] - Changes the page title.
+ * @param {Boolean} [options.hideAppBar = false] - Hides the app bar.
+ * @param {Boolean} [options.hideAppsList = false] - Hides the app list in
+ * the Splunk bar.
+ * @param {Boolean} [options.hideChrome = false] - Renders only the main content, hiding
+ * the Splunk bar, app bar, and footer.
+ * @param {Boolean} [options.hideFooter = false] - Hides the footer.
+ * @param {Boolean} [options.hideSplunkBar = false] - Hides the Splunk bar.
+ * @param {string} [options.layout = 'scrolling'] - Set to `fixed` to fix all navigation bars
+ * to the edge of the page.
+ * @param {Boolean} [options.useGlobalLayerStack = true] - Wraps elements in @splunk/react-ui's LayerStackGlobalProvider.
+ * @param {String} [options.theme = 'light'] - Used to theme UI elements. Ex. "light" or "dark".
+ * @param {String} [options.loader = 'scriptjs'] - Configures the loader used for the loading the layout - available loaders are "scriptjs" and "requirejs".
+ * Change this only if the default loader does not work for your application.
+ * @param {Boolean} [options.lazyLoadLayout = false] - Prioritizes loading the React element and lazily fetches and compiles the layout API (navigation bar).
+ * @param {element} [options.SplunkBarFallback = SplunkBar] - A React element used as a placeholder for the splunk bar while the navigation bar is loading.
+ * @param {element} [options.AppBarFallback = AppBar] - A React element used as a placeholder for the app bar while the navigation bar is loading.
+ * @param {function} [options.onLayoutComplete] - A callback function which executes after layout API is fetched and compiled.
+ */
+
+
+function src_layout(element, options) {
+  baseLayout(element, src_renderShim, options);
+}
+
+/* harmony default export */ var src = __webpack_exports__["default"] = (src_layout);
 
 /***/ })
 /******/ ]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splunk/react-page",
-  "version": "6.1.1",
+  "version": "6.3.0",
   "description": "Load React components into the latest layout from Splunk Enterprise",
   "main": "lib/index.js",
   "license": "Apache-2.0",
@@ -22,7 +22,7 @@
     "test:cypress:ci": "node src/tests/run-cypress-tests.js"
   },
   "dependencies": {
-    "@splunk/react-ui": "^4.17.1",
+    "@splunk/react-ui": "^4.19.0",
     "@splunk/splunk-utils": "^2.3.4",
     "@splunk/themes": "^0.16.1",
     "@splunk/ui-utils": "^1.6.0",
@@ -31,7 +31,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.2.0",
-    "@splunk/babel-preset": "^3.0.0",
+    "@splunk/babel-preset": "^4.0.0",
     "@splunk/cicd-tools": "^0.5.0",
     "@splunk/eslint-config": "^4.0.0",
     "@splunk/stylelint-config": "^4.0.0",
@@ -40,6 +40,7 @@
     "babel-loader": "^8.0.4",
     "babel-plugin-transform-imports": "^2.0.0",
     "cross-env": "^6.0.3",
+    "cypress": "^12.17.1",
     "eslint": "^7.14.0",
     "eslint-config-airbnb": "^18.2.1",
     "eslint-config-prettier": "^6.15.0",

package/cypress/plugins/index.js

@@ -1,11 +0,0 @@
-/* eslint-env node */
-
-module.exports = (on, config) => {
-    on('before:browser:launch', (browser = {}, launchOptions) => {
-        if (browser.name === 'chrome') {
-            launchOptions.args.push('--disable-gpu');
-        }
-    });
-
-    return config;
-};

package/cypress.json

@@ -1,10 +0,0 @@
-{
-  "baseUrl": "http://localhost:8000",
-  "env": {},
-  "defaultCommandTimeout": 1000,
-  "fixturesFolder": false,
-  "integrationFolder": "src/tests",
-  "testFiles": "**.spec.js",
-  "video": false,
-  "videoUploadOnPasses": false
-}