blue-react 9.12.0 → 10.0.0-rc1

package/README.md

@@ -9,11 +9,40 @@
 [Checkout the docs](https://bruegmann.github.io/blue-react) to find out how to
 use Blue React.
 
-## Breaking changes between v8 and v9
+## Breaking changes between v9 and v10
 
--   Renamed `.caret` ➡️ `.blue-caret`
--   Removed `.switch` CSS
--   Removed deprecated DocumentView
+### Removed hash router from Layout
+
+The new `Layout` no longer has a hash router. So there is no `pages` prop anymore. The router moved to its own component `HashRouter` for legacy reasons. But it's recommended to use other solutions like [React Router](https://reactrouter.com/) or [TanStack Router](https://tanstack.com/router/latest).
+
+### Move side content to `side` prop
+
+It should look like this:
+
+```tsx
+<Layout
+    side={
+        <SidebarMenu>
+            <MenuItem href="." label="Home" />
+        </SidebarMenu>
+    }
+>
+    Your page content
+</Layout>
+```
+
+### Removed HTML elements for status
+
+If you use util functions for status like `showSuccess()` or `setAlertMessage()` you need to embed the `Status` React component like this:
+
+```tsx
+<Status
+    dangerIcon={<XCircleFill />}
+    infoIcon={<InfoCircleFill />}
+    successIcon={<CheckCircleFill />}
+    warningIcon={<ExclamationCircleFill />}
+/>
+```
 
 ## Developing
 

package/dist/components/Chevron.js

@@ -23,6 +23,7 @@ function Chevron(_ref) {
       mirrored = _ref.mirrored,
       className = _ref.className,
       style = _ref.style;
+  var prefersReducedMotion = window.matchMedia("(prefers-reduced-motion)").matches;
   return /*#__PURE__*/_react.default.createElement("svg", {
     xmlns: "http://www.w3.org/2000/svg",
     width: "1em",
@@ -33,7 +34,7 @@ function Chevron(_ref) {
       display: "inline-block",
       verticalAlign: "-0.125em",
       transform: "rotate(".concat(open && mirrored ? -90 : open ? 90 : 0, "deg)"),
-      transition: "transform 0.2s"
+      transition: prefersReducedMotion ? "none" : "transform 0.2s"
     }),
     viewBox: "0 0 16 16"
   }, mirrored ? /*#__PURE__*/_react.default.createElement("path", {

package/dist/components/HashRouter.js

@@ -0,0 +1,219 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireWildcard(require("react"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }
+
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+
+function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
+
+function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
+
+function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
+
+function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
+
+function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
+
+function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
+
+function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
+
+window.toggleSidebarEvent = new CustomEvent("toggleSidebar");
+
+/**
+ * Component for simple hash routing. It's recommended to use solutions like `react-router-dom` for more complex routing.
+ *
+ * As soon this component is mounted, it is globally available under `window.blueHashRouterRef`.
+ * You can also append your own event listeners.
+ *
+ * Allowed events:
+ *
+ * * **componentDidUpdate** - Component was updated.
+ *   Example: `window.blueHashRouterRef.addEventListener("componentDidUpdate", (prevProps, prevState) => { })`
+ * * **pageDidShowAgain** - Page appeared again with the same old state. In the callback function you can reinitialize things.
+ *   Example: `window.blueHashRouterRef.addEventListener("pageDidShowAgain", "home", (prevProps, prevState) => { })`
+ * * **pageDidHide** - This page disappeared and another page appears instead.
+ *   Example: `window.blueHashRouterRef.addEventListener("pageDidHide", "home", (prevProps, prevState) => { })`
+ *
+ * Method to add event listeners:
+ * * `window.blueHashRouterRef.`**addEventListener**`(eventName: string, param2: any, param3: any, listenerId?: string)`
+ *
+ * Methods to remove event listeners:
+ * * `window.blueHashRouterRef.`**removeEventListener**`(eventName: string, listenerId: string)`
+ * * `window.blueHashRouterRef.`**removeDuplicatedEventListeners**`()` - Will automatically be called when running `addEventListener`
+ */
+var HashRouter = /*#__PURE__*/function (_Component) {
+  _inherits(HashRouter, _Component);
+
+  var _super = _createSuper(HashRouter);
+
+  function HashRouter(props) {
+    var _this;
+
+    _classCallCheck(this, HashRouter);
+
+    _this = _super.call(this, props);
+    window.blueHashRouterRef = _assertThisInitialized(_this);
+    _this.defaultMatch = ["home"];
+    _this.state = {
+      match: null,
+      history: [],
+      hash: window.location.hash,
+      hashHistory: [],
+      blockRouting: props.blockRouting || undefined
+    };
+    _this.eventListeners = [];
+    return _this;
+  }
+
+  _createClass(HashRouter, [{
+    key: "onHashChange",
+    value: function onHashChange() {
+      window.blueHashRouterRef.initMatch();
+    }
+  }, {
+    key: "componentDidMount",
+    value: function componentDidMount() {
+      this.initMatch();
+      window.addEventListener("hashchange", this.onHashChange);
+    }
+  }, {
+    key: "componentWillUnmount",
+    value: function componentWillUnmount() {
+      window.removeEventListener("hashchange", this.onHashChange);
+    }
+  }, {
+    key: "componentDidUpdate",
+    value: function componentDidUpdate(prevProps, prevState) {
+      var _this2 = this;
+
+      if (prevProps.blockRouting !== this.props.blockRouting && this.props.blockRouting !== this.state.blockRouting) {
+        this.setState({
+          blockRouting: this.props.blockRouting
+        });
+      }
+
+      this.eventListeners.forEach(function (eventListener) {
+        if (eventListener[0] === "componentDidUpdate") {
+          eventListener[1](prevProps, prevState);
+        }
+
+        if (eventListener[0] === "pageDidShowAgain") {
+          var pageId = eventListener[1];
+          var callback = eventListener[2];
+
+          if (prevState.hash !== _this2.state.hash && _this2.state.match[0] === pageId) {
+            callback(prevProps, prevState);
+          }
+        }
+
+        if (eventListener[0] === "pageDidHide") {
+          var _pageId = eventListener[1];
+          var _callback = eventListener[2];
+
+          if (prevState.hash !== _this2.state.hash && prevState.match[0] === _pageId) {
+            _callback(prevProps, prevState);
+          }
+        }
+      });
+    }
+  }, {
+    key: "initMatch",
+    value: function initMatch() {
+      var newMatch;
+
+      if (window.location.hash && window.location.hash !== "" && window.location.hash !== "#/") {
+        newMatch = window.location.hash.replace("#", "").split("/").filter(function (n) {
+          return n !== "";
+        });
+      } else {
+        newMatch = this.defaultMatch;
+      }
+
+      if (this.props.unrouteable) {
+        newMatch = this.defaultMatch;
+      }
+
+      if (this.state.blockRouting && this.state.blockRouting(newMatch, this.state.match) === true) {
+        window.location.hash = this.state.hash;
+      } else {
+        if (!(this.state.history.indexOf(newMatch[0]) > -1)) {
+          this.state.history.push(newMatch[0]);
+        }
+
+        this.setState({
+          match: newMatch,
+          history: this.state.history,
+          hash: window.location.hash,
+          hashHistory: this.state.hashHistory.concat([window.location.hash])
+        });
+      }
+    }
+  }, {
+    key: "addEventListener",
+    value: function addEventListener(param1, param2, param3, listenerId) {
+      this.eventListeners.push([param1, param2, param3, listenerId]);
+      this.removeDuplicatedEventListeners();
+    }
+  }, {
+    key: "removeEventListener",
+    value: function removeEventListener(type, listenerId) {
+      this.eventListeners = this.eventListeners.filter(function (param) {
+        if (param[0] !== type) {
+          return param;
+        } else if (param[0] === type && param[3] !== listenerId) {
+          return param;
+        }
+      });
+    }
+  }, {
+    key: "removeDuplicatedEventListeners",
+    value: function removeDuplicatedEventListeners() {
+      this.eventListeners = this.eventListeners.filter(function (value, index, self) {
+        return index === self.findIndex(function (t) {
+          return t[3] === value[3] && t[0] === value[0];
+        });
+      });
+    }
+  }, {
+    key: "render",
+    value: function render() {
+      var _this$props$pages,
+          _this3 = this;
+
+      return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, (_this$props$pages = this.props.pages) === null || _this$props$pages === void 0 ? void 0 : _this$props$pages.map(function (page) {
+        return _this3.state.history.indexOf(page.name) > -1 && /*#__PURE__*/_react.default.createElement("div", {
+          key: page.name,
+          className: "router-page " + (_this3.state.match[0] === page.name ? "active" : "d-none")
+        }, page.component);
+      }));
+    }
+  }], [{
+    key: "defaultProps",
+    get: function get() {
+      return {
+        unrouteable: false,
+        disableTitleSet: false
+      };
+    }
+  }]);
+
+  return HashRouter;
+}(_react.Component);
+
+exports.default = HashRouter;

package/dist/components/HeaderTitle.js

@@ -36,7 +36,7 @@ function HeaderTitle(_ref) {
   var uniqueId = "HeaderTitle-" + (0, _utils.guid)();
 
   var setDocumentTitle = function setDocumentTitle() {
-    if (window.blueLayoutRef && window.blueLayoutRef.props && window.blueLayoutRef.props.disableTitleSet === false) {
+    if (window.blueHashRouterRef && window.blueHashRouterRef.props && window.blueHashRouterRef.props.disableTitleSet === false) {
       var element = document.querySelector("#".concat(uniqueId, " .blue-header-title-labels"));
       var titleElement = document.querySelector("title");