Merge pull request #7178 from microting/copilot/add-mat-icon-to-menu-items

Add optional Material Design icons to navigation menu items

Author: renemadsen

eFormAPI/eFormAPI.Web/Abstractions/IMenuService.cs

@@ -22,10 +22,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 */
 using System.Threading.Tasks;
-using Microting.eFormApi.BasePn.Infrastructure.Models.Application;
 using Microting.eFormApi.BasePn.Infrastructure.Models.API;
 using eFormAPI.Web.Services.NavigationMenu;
 using System.Collections.Generic;
+using MenuModel = eFormAPI.Web.Infrastructure.Models.Menu.MenuModel;
 
 namespace eFormAPI.Web.Abstractions;
 

eFormAPI/eFormAPI.Web/Controllers/MenuController.cs

@@ -25,10 +25,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 using eFormAPI.Web.Abstractions;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
-using Microting.eFormApi.BasePn.Infrastructure.Models.Application;
 using Microting.eFormApi.BasePn.Infrastructure.Models.API;
 using eFormAPI.Web.Services.NavigationMenu;
 using System.Collections.Generic;
+using MenuModel = eFormAPI.Web.Infrastructure.Models.Menu.MenuModel;
 
 namespace eFormAPI.Web.Controllers;
 

eFormAPI/eFormAPI.Web/Infrastructure/Models/Menu/MenuItemModel.cs

@@ -0,0 +1,40 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2007 - 2021 Microting A/S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+namespace eFormAPI.Web.Infrastructure.Models.Menu;
+
+using System.Collections.Generic;
+
+public class MenuItemModel
+{
+    public string Name { get; set; }
+    public string LocaleName { get; set; }
+    public string E2EId { get; set; }
+    public string Link { get; set; }
+    public string Icon { get; set; }
+    public int Position { get; set; }
+    public bool IsInternalLink { get; set; }
+    public List<string> Guards { get; set; } = new List<string>();
+    public List<MenuItemModel> MenuItems { get; set; } = new List<MenuItemModel>();
+}

eFormAPI/eFormAPI.Web/Infrastructure/Models/Menu/MenuModel.cs

@@ -0,0 +1,33 @@
+/*
+The MIT License (MIT)
+
+Copyright (c) 2007 - 2021 Microting A/S
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+namespace eFormAPI.Web.Infrastructure.Models.Menu;
+
+using System.Collections.Generic;
+
+public class MenuModel
+{
+    public List<MenuItemModel> LeftMenu { get; set; } = new List<MenuItemModel>();
+    public List<MenuItemModel> RightMenu { get; set; } = new List<MenuItemModel>();
+}

eFormAPI/eFormAPI.Web/Services/MenuService.cs

@@ -37,7 +37,6 @@ namespace eFormAPI.Web.Services;
 using Microsoft.Extensions.Logging;
 using Microting.eFormApi.BasePn.Infrastructure.Database.Entities;
 using Microting.eFormApi.BasePn.Infrastructure.Models.API;
-using Microting.eFormApi.BasePn.Infrastructure.Models.Application;
 using System;
 using System.Collections.Generic;
 using System.Linq;
@@ -46,6 +45,8 @@ namespace eFormAPI.Web.Services;
 using Microting.EformAngularFrontendBase.Infrastructure.Const;
 using Microting.EformAngularFrontendBase.Infrastructure.Data;
 using Microting.EformAngularFrontendBase.Infrastructure.Data.Entities.Menu;
+using MenuItemModel = eFormAPI.Web.Infrastructure.Models.Menu.MenuItemModel;
+using MenuModel = eFormAPI.Web.Infrastructure.Models.Menu.MenuModel;
 
 public class MenuService(
     ILogger<MenuService> logger,
@@ -177,6 +178,7 @@ public async Task<OperationDataResult<NavigationMenuModel>> GetCurrentNavigation
                     ParentId = x.ParentId,
                     Position = x.Position,
                     IsInternalLink = x.IsInternalLink,
+                    Icon = x.IconName,
                     Translations = dbContext.MenuItemTranslations
                         .Where(p => p.MenuItemId == x.Id)
                         .Select(p => new NavigationMenuTranslationModel
@@ -202,6 +204,7 @@ public async Task<OperationDataResult<NavigationMenuModel>> GetCurrentNavigation
                             RelatedTemplateItemId = p.MenuTemplateId,
                             ParentId = p.ParentId,
                             Position = p.Position,
+                            Icon = p.IconName,
                             Translations = dbContext.MenuItemTranslations
                                 .Where(k => k.MenuItemId == p.Id)
                                 .Select(k => new NavigationMenuTranslationModel
@@ -278,6 +281,7 @@ public async Task<OperationDataResult<MenuModel>> GetCurrentUserMenu()
                     LocaleName = currentLocale,
                     E2EId = x.E2EId,
                     Link = x.Link,
+                    Icon = x.IconName,
                     Guards = dbContext.MenuTemplatePermissions
                         .Include(y => y.Permission)
                         .Where(d => d.MenuTemplateId == x.MenuTemplateId)
@@ -308,6 +312,7 @@ public async Task<OperationDataResult<MenuModel>> GetCurrentUserMenu()
                             LocaleName = currentLocale,
                             E2EId = p.E2EId,
                             Link = p.Link,
+                            Icon = p.IconName,
                             Guards = dbContext.MenuTemplatePermissions
                                 .Include(y => y.Permission)
                                 .Where(d => d.MenuTemplateId == p.MenuTemplateId)
@@ -372,7 +377,7 @@ public async Task<OperationDataResult<MenuModel>> GetCurrentUserMenu()
             foreach (var pluginMenu in Program.EnabledPlugins.Select(plugin => plugin.HeaderMenu(serviceProvider)))
             {
                 //result.LeftMenu.AddRange(pluginMenu.LeftMenu);
-                result.RightMenu.AddRange(pluginMenu.RightMenu);
+                result.RightMenu.AddRange(ConvertToLocalMenuItemModel(pluginMenu.RightMenu));
             }
 
             return new OperationDataResult<MenuModel>(true, result);
@@ -387,6 +392,21 @@ public async Task<OperationDataResult<MenuModel>> GetCurrentUserMenu()
         }
     }
 
+    private List<MenuItemModel> ConvertToLocalMenuItemModel(List<Microting.eFormApi.BasePn.Infrastructure.Models.Application.MenuItemModel> externalModels)
+    {
+        return externalModels.Select(x => new MenuItemModel
+        {
+            Name = x.Name,
+            LocaleName = x.LocaleName,
+            E2EId = x.E2EId,
+            Link = x.Link,
+            Position = x.Position,
+            IsInternalLink = x.IsInternalLink,
+            Guards = x.Guards,
+            MenuItems = ConvertToLocalMenuItemModel(x.MenuItems)
+        }).ToList();
+    }
+
     public async Task<OperationResult> ResetCurrentUserMenu()
     {
         // Step 1. Firstly remove all menu items from database

eFormAPI/eFormAPI.Web/Services/NavigationMenu/Builder/MenuItemBuilder.cs

@@ -59,7 +59,8 @@ public MenuItem Build()
             Type = MenuItemModel.Type,
             Link = MenuItemModel.Link,
             E2EId = MenuItemModel.E2EId,
-            IsInternalLink = MenuItemModel.IsInternalLink
+            IsInternalLink = MenuItemModel.IsInternalLink,
+            IconName = MenuItemModel.Icon
         };
 
         foreach (var behavior in _behaviors.Where(behavior => behavior.IsExecute()))

eFormAPI/eFormAPI.Web/Services/NavigationMenu/NavigationMenuItemModel.cs

@@ -47,4 +47,5 @@ public class NavigationMenuItemModel
         = new List<NavigationMenuTranslationModel>();
 
     public bool IsInternalLink { get; set; }
+    public string Icon { get; set; }
 }

eFormAPI/eFormAPI.Web/Services/NavigationMenu/NavigationMenuTemplateItemModel.cs

@@ -35,4 +35,5 @@ public class NavigationMenuTemplateItemModel
     public int? RelatedTemplateItemId { get; set; }
     public List<NavigationMenuTranslationModel> Translations { get; set; }
         = new List<NavigationMenuTranslationModel>();
+    public string Icon { get; set; }
 }

eform-client/src/app/common/models/navigation-menu/navigation-menu.model.ts

@@ -18,6 +18,7 @@ export class NavigationMenuTemplateItemModel {
   link: string;
   collapsed: boolean;
   translations: NavigationMenuTranslationModel[];
+  icon?: string;
 }
 
 export class NavigationMenuItemModel {
@@ -34,6 +35,7 @@ export class NavigationMenuItemModel {
   securityGroupsIds: number[];
   translations: NavigationMenuTranslationModel[];
   isInternalLink: boolean = true;
+  icon?: string;
 }
 
 export class NavigationMenuTranslationModel {

eform-client/src/app/common/models/user/user-menu.model.ts

@@ -11,4 +11,5 @@ export class MenuItemModel {
   isInternalLink: boolean;
   menuItems: Array<MenuItemModel> = [];
   guards: Array<string> = [];
+  icon?: string;
 }