Add support for top-level submenu icons

Author: tylerjmchugh

docs/manual/docs/customizing-application/adding-static-pages.md

@@ -68,10 +68,13 @@ Insert a page as a simple menu using the page identifier or as a submenu using a
 ["gn-site-name-menu",
  "gn-portal-switcher",
  "gn-search-menu",
- {"quickSearch": [
-   "searchForAfrica",
-   "forReview"
- ]},
+ {"quickSearch": {
+   "icon": "fa-search",
+   "items": [
+     "searchForAfrica",
+     "forReview"
+   ]
+ }},
  "gn-map-menu",
  "gn-contribute-menu",
  "gn-admin-menu",
@@ -100,10 +103,13 @@ As with the top toolbar, insert a page as a simple menu using the page identifie
 
 ``` json
 ["gn-recordview-edit-menu",
- {"quickSearch": [
-   "documentation",
-   "forReview"
- ]},
+ {"quickSearch": {
+   "icon": "fa-search",
+   "items": [
+     "documentation",
+     "forReview"
+   ]
+ }},
  "gn-recordview-delete-menu",
  "gn-recordview-manage-menu",
  "gn-recordview-download-menu",

web-ui/src/main/resources/catalog/components/pages/GnStaticPagesService.js

@@ -52,13 +52,39 @@
               );
             }
           } else if (angular.isObject(menu)) {
-            var key = Object.keys(menu)[0],
-              submenu = {
-                label: key,
-                type: "submenu",
-                pages: []
-              };
-            buildMenu(submenu.pages, staticPages, menu[key]);
+            var key = Object.keys(menu)[0];
+            var value = menu[key];
+
+            var submenu = {
+              label: key,
+              icon: undefined,
+              type: "submenu",
+              pages: []
+            };
+
+            var menuItems;
+
+            // If the submenu is using the legacy array format
+            if (angular.isArray(value)) {
+              menuItems = value;
+              // If the submenu is using the new object format with an items array and optional icon
+            } else if (angular.isObject(value)) {
+              if (angular.isArray(value.items)) {
+                menuItems = value.items;
+              }
+              if (angular.isDefined(value.icon)) {
+                submenu.icon = value.icon;
+              }
+            } else {
+              console.warn(
+                "Invalid menu configuration for " +
+                  key +
+                  ". Expected an array of page identifiers or an object with an items array."
+              );
+              return;
+            }
+
+            buildMenu(submenu.pages, staticPages, menuItems);
             pagesMenu.push(submenu);
           }
         });

web-ui/src/main/resources/catalog/locales/en-admin.json

@@ -1574,9 +1574,9 @@
     "staticPageRemoved": "Static page removed",
     "chooseStaticPageFile": "Choose or drop static page file here",
     "ui-topCustomMenu": "Header custom menu items",
-    "ui-topCustomMenu-help": "List of static page IDs associated with the header section to display: <ul><li>When a list is provided, the links are displayed in the order provided and only for the pages listed.</li><li>When a list is not provided, all static pages configured for the header section are displayed, with no guaranteed order.</li><li>Pages can be inserted in between catalogue default menu which are: <pre>[\"gn-site-name-menu\",\n    \"gn-portal-switcher\",\n    \"gn-search-menu\",\n    \"gn-map-menu\",\n    \"gn-contribute-menu\",\n    \"gn-admin-menu\"]</pre></li><li>Insert a page as a simple menu using its id eg. \"documentation\" or as a submenu using an object: <pre>{\"quickSearch\": [\n  \"searchForAfrica\", \n  \"forReview\"\n]}</pre></li><li>The submenu object key defines the top-level label and can be a translation key, or literal text if the text is not defined in the translations.</li><li>If a translation is defined for \"quickSearch\", the submenu label is translated automatically for each language.</li></ul>",
+    "ui-topCustomMenu-help": "List of static page IDs associated with the header section to display: <ul><li>When a list is provided, the links are displayed in the order provided and only for the pages listed.</li><li>When a list is not provided, all static pages configured for the header section are displayed, with no guaranteed order.</li><li>Pages can be inserted in between catalogue default menus which are: <pre>[\"gn-site-name-menu\",\n    \"gn-portal-switcher\",\n    \"gn-search-menu\",\n    \"gn-map-menu\",\n    \"gn-contribute-menu\",\n    \"gn-admin-menu\"]</pre></li><li>Insert a page as a simple menu using its id eg. \"documentation\" or as a submenu using an object: <pre>{\"quickSearch\": {\n  \"icon\": \"fa-search\",\n  \"items\": [\n    \"searchForAfrica\",\n    \"forReview\"\n  ]\n}}</pre></li><li>The submenu object key defines the top-level label and can be a translation key, or literal text if the text is not defined in the translations.</li><li>If a translation is defined for \"quickSearch\", the submenu label is translated automatically for each language.</li></ul>",
     "ui-recordviewCustomMenu": "Record View custom menu items",
-    "ui-recordviewCustomMenu-help": "List of static page IDs associated with the record view section to display: <ul><li>When a list is provided, the links are displayed in the order provided and only for the pages listed.</li><li>When a list is not provided, all static pages configured for the record view section are displayed, with no guaranteed order.</li><li>Pages can be inserted in between catalogue default menus which are: <pre>[\"gn-recordview-edit-menu\",\n    \"gn-recordview-delete-menu\",\n    \"gn-recordview-manage-menu\",\n    \"gn-recordview-download-menu\",\n    \"gn-recordview-display-menu\"]</pre></li><li>Insert a page as a simple menu using its id eg. \"documentation\" or as a submenu using an object: <pre>{\"quickSearch\": [\n  \"searchForAfrica\", \n  \"forReview\"\n]}</pre></li><li>The submenu object key defines the top-level label and can be a translation key, or literal text if the text is not defined in the translations.</li><li>If a translation is defined for \"quickSearch\", the submenu label is translated automatically for each language.</li></ul>",
+    "ui-recordviewCustomMenu-help": "List of static page IDs associated with the record view section to display: <ul><li>When a list is provided, the links are displayed in the order provided and only for the pages listed.</li><li>When a list is not provided, all static pages configured for the record view section are displayed, with no guaranteed order.</li><li>Pages can be inserted in between catalogue default menus which are: <pre>[\"gn-recordview-edit-menu\",\n    \"gn-recordview-delete-menu\",\n    \"gn-recordview-manage-menu\",\n    \"gn-recordview-download-menu\",\n    \"gn-recordview-display-menu\"]</pre></li><li>Insert a page as a simple menu using its id eg. \"documentation\" or as a submenu using an object: <pre>{\"quickSearch\": {\n  \"icon\": \"fa-search\",\n  \"items\": [\n    \"searchForAfrica\",\n    \"forReview\"\n  ]\n}}</pre></li><li>The submenu object key defines the top-level label and can be a translation key, or literal text if the text is not defined in the translations.</li><li>If a translation is defined for \"quickSearch\", the submenu label is translated automatically for each language.</li></ul>",
     "ui-footerCustomMenu": "Footer custom menu items",
     "ui-footerCustomMenu-help": "List of static page IDs associated with the footer section to display: <ul><li>When a list is provided, the links are displayed in the order provided and only for the pages listed.</li><li>When a list is not provided, all static pages configured for the footer section are displayed, with no guaranteed order.</li>",
     "es.url": "Elasticsearch server",