asab_webui_shell 27.8.0 → 27.8.1

package/dist/containers/Navigation/index.js

@@ -19,7 +19,21 @@ class Navigation extends _react.Component {
     		path: '/some/path',	// Url path
     		end: true,		// Whether path must be matched exactly
     		name: 'Some Name',	// Route name
-    		component: ReactComponent // Component to be rendered
+    		openFor: ['/some/path/*'], // Optional array of routes to keep the item open
+    		icon: 'bi bi-folder', // Icon
+    		resource: 'some:resource:access', // Resource to check access for
+    		order: 100, // Order of the item
+    		children: [ // Optional array of children
+    			{
+    				path: '/some/path/child',
+    				end: true,
+    				name: 'Child Name',
+    				openFor: ['/some/path/child'], // Optional array of routes to keep the child highlighted
+    				icon: 'bi bi-file', // Icon
+    				resource: 'some:resource:access', // Resource to check access for
+    				order: 100, // Order of the child
+    			}
+    		],
     	}
     */
 

package/dist/containers/Sidebar/SidebarItem.js

@@ -21,7 +21,8 @@ var SidebarItem = _ref => {
     setOpen = _ref.setOpen,
     isSmallResolution = _ref.isSmallResolution,
     _ref$beacon = _ref.beacon,
-    beacon = _ref$beacon === void 0 ? undefined : _ref$beacon;
+    beacon = _ref$beacon === void 0 ? undefined : _ref$beacon,
+    openFor = _ref.openFor;
   var location = (0, _reactRouter.useLocation)();
   var _useTranslation = (0, _reactI18next.useTranslation)(),
     t = _useTranslation.t;
@@ -38,10 +39,10 @@ var SidebarItem = _ref => {
   var itemBeacon = beacon === null || beacon === void 0 ? void 0 : beacon["beacon.".concat(lowercasedItemName)];
   (0, _react.useEffect)(() => {
     // TODO: refactor the handling of active and open states, since it does not behave as expected in some cases
-    if (isOpen && !isActive) {
+    if (isOpen && !isActive && !matchesOpenFor(location.pathname, openFor)) {
       setOpen(false);
     }
-    setActive(item.url && (location.pathname === item.url || location.pathname.startsWith(item.url + '/')) ? true : false);
+    setActive(Boolean(item.url && (location.pathname === item.url || location.pathname.startsWith(item.url + '/'))) || matchesOpenFor(location.pathname, item.openFor));
   }, [location]);
   return /*#__PURE__*/_react.default.createElement("div", {
     className: "nav-item"
@@ -103,6 +104,10 @@ var SidebarCollapsibleItem = _ref2 => {
   // Should collapsed item uncollapse
   (0, _react.useEffect)(() => {
     if (item.children && !isOpen) {
+      if (matchesOpenFor(location.pathname, item.openFor)) {
+        setOpen(true);
+        return;
+      }
       for (var child of item.children) {
         if (location.pathname.includes(child.url)) {
           setOpen(true);
@@ -164,6 +169,7 @@ var SidebarCollapsibleItem = _ref2 => {
       isOpen: isOpen,
       setOpen: setOpen,
       isSmallResolution: isSmallResolution,
+      openFor: item.openFor,
       beacon: itemsBeacon["beacon.".concat(child === null || child === void 0 || (_child$name = child.name) === null || _child$name === void 0 ? void 0 : _child$name.toLowerCase())] && childBeacon(itemsBeacon, "beacon.".concat(child.name.toLowerCase()))
     });
   })));
@@ -186,4 +192,16 @@ var childBeacon = (data, key) => {
   return data[key] ? {
     [key]: data[key]
   } : {};
+};
+
+// Optional item.openFor patterns, e.g. ['/route/*'] - keeps parent open on matching routes
+var matchesOpenFor = (pathname, patterns) => {
+  var _patterns$some;
+  return (_patterns$some = patterns === null || patterns === void 0 ? void 0 : patterns.some(p => {
+    if (p.endsWith('*')) {
+      var prefix = p.slice(0, -1);
+      return pathname.startsWith(prefix) || pathname === prefix.slice(0, -1);
+    }
+    return pathname === p || pathname.startsWith(p + '/');
+  })) !== null && _patterns$some !== void 0 ? _patterns$some : false;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "asab_webui_shell",
-	"version": "27.8.0",
+	"version": "27.8.1",
 	"license": "BSD-3-Clause",
 	"description": "TeskaLabs ASAB WebUI Shell Application",
 	"contributors": [