Merge pull request #1009 from sbwalker/dev

allow developers to use custom icon libraries (Open Iconic is the default)
oqtane · Dec 22, 2020 · 8ab0122 · 8ab0122
2 parents 3f8b9ef + df382ce
commit 8ab0122
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 20 deletions.
diff --git a/Oqtane.Client/Modules/Admin/Dashboard/Index.razor b/Oqtane.Client/Modules/Admin/Dashboard/Index.razor
@@ -1,4 +1,4 @@
-@namespace Oqtane.Modules.Admin.Dashboard
+@namespace Oqtane.Modules.Admin.Dashboard
 @inherits ModuleBase
 @inject IPageService PageService
 @inject IUserService UserService
@@ -11,7 +11,7 @@
             string url = NavigateUrl(p.Path);
             <div class="col-md-2 mx-auto text-center">
                 <NavLink class="nav-link" href="@url" Match="NavLinkMatch.All">
-                    <h2><span class="oi oi-@p.Icon" aria-hidden="true"></span></h2>@p.Name
+                    <h2><span class="@p.Icon" aria-hidden="true"></span></h2>@p.Name
                 </NavLink>
             </div>
         }

diff --git a/Oqtane.Client/Modules/Admin/Pages/Add.razor b/Oqtane.Client/Modules/Admin/Pages/Add.razor
@@ -157,7 +157,7 @@
                     </tr>
                     <tr>
                         <td>
-                            <Label For="Icon" HelpText="Optionally provide an icon for this page which will be displayed in the site navigation" ResourceKey="Icon">Icon: </Label>
+                            <Label For="Icon" HelpText="Optionally provide an icon class name for this page which will be displayed in the site navigation" ResourceKey="Icon">Icon: </Label>
                         </td>
                         <td>
                             <input id="Icon" class="form-control" @bind="@_icon" />

diff --git a/Oqtane.Client/Modules/Admin/Pages/Edit.razor b/Oqtane.Client/Modules/Admin/Pages/Edit.razor
@@ -168,7 +168,7 @@
                     </tr>
                     <tr>
                         <td>
-                            <Label For="Icon" HelpText="Optionally provide an icon for this page which will be displayed in the site navigation" ResourceKey="Icon">Icon: </Label>
+                            <Label For="Icon" HelpText="Optionally provide an icon class name for this page which will be displayed in the site navigation" ResourceKey="Icon">Icon: </Label>
                         </td>
                         <td>
                             <input id="Icon" class="form-control" @bind="@_icon" />

diff --git a/Oqtane.Client/Modules/Controls/ActionDialog.razor b/Oqtane.Client/Modules/Controls/ActionDialog.razor
@@ -94,7 +94,11 @@
 
         if (!string.IsNullOrEmpty(IconName))
         {
-            _iconSpan = $"<span class=\"oi oi-{IconName}\"></span>&nbsp;";
+            if (!IconName.Contains(" "))
+            {
+                IconName = "oi oi-" + IconName;
+            }
+            _iconSpan = $"<span class=\"{IconName}\"></span>&nbsp;";
         }
 
         Text = Localize(nameof(Text), Text);

diff --git a/Oqtane.Client/Modules/Controls/ActionLink.razor b/Oqtane.Client/Modules/Controls/ActionLink.razor
@@ -91,7 +91,11 @@
 
         if (!string.IsNullOrEmpty(IconName))
         {
-            _iconSpan = $"<span class=\"oi oi-{IconName}\"></span>{(IconOnly ? "" : "&nbsp")}";
+            if (!IconName.Contains(" "))
+            {
+                IconName = "oi oi-" + IconName;
+            }
+            _iconSpan = $"<span class=\"{IconName}\"></span>{(IconOnly ? "" : "&nbsp")}";
 
         }
 

diff --git a/Oqtane.Client/Themes/Controls/MenuHorizontal.razor b/Oqtane.Client/Themes/Controls/MenuHorizontal.razor
@@ -1,4 +1,4 @@
-@namespace Oqtane.Themes.Controls
+@namespace Oqtane.Themes.Controls
 @inherits MenuBase
 
 @if (MenuPages.Any())
@@ -19,7 +19,7 @@
                             <a class="nav-link" href="@GetUrl(p)" target="@GetTarget(p)" >
                                 @if (p.Icon != string.Empty)
                                 {
-                                    <span class="oi oi-@p.Icon" aria-hidden="true"></span>
+                                    <span class="@p.Icon" aria-hidden="true"></span>
                                 }
                                 @p.Name<span class="sr-only">(current)</span>
                             </a>
@@ -31,7 +31,7 @@
                             <a class="nav-link" href="@GetUrl(p)"  target="@GetTarget(p)" >
                                 @if (p.Icon != string.Empty)
                                 {
-                                    <span class="oi oi-@p.Icon" aria-hidden="true"></span>
+                                    <span class="@p.Icon" aria-hidden="true"></span>
                                 }
                                 @p.Name
                             </a>

diff --git a/Oqtane.Client/Themes/Controls/MenuVertical.razor b/Oqtane.Client/Themes/Controls/MenuVertical.razor
@@ -1,4 +1,4 @@
-@namespace Oqtane.Themes.Controls
+@namespace Oqtane.Themes.Controls
 @inherits MenuBase
 
 @if (MenuPages.Any())
@@ -22,7 +22,7 @@
                             }
                             @if (p.Icon != string.Empty)
                             {
-                                <span class="oi oi-@p.Icon" aria-hidden="true"></span>
+                                <span class="@p.Icon" aria-hidden="true"></span>
                             }
                             @p.Name
                         </a>

diff --git a/Oqtane.Client/Themes/Controls/ModuleActions.razor b/Oqtane.Client/Themes/Controls/ModuleActions.razor
@@ -1,4 +1,4 @@
-@namespace Oqtane.Themes.Controls
+@namespace Oqtane.Themes.Controls
 @inherits ModuleActionsBase 
 @attribute [OqtaneIgnore]
 
@@ -22,7 +22,7 @@
                         }
                         else
                         {
-                            <span class="oi oi-@action.Icon" aria-hidden="true"></span>
+                            <span class="@action.Icon" aria-hidden="true"></span>
                         }
                         &nbsp;
                         @action.Name

diff --git a/Oqtane.Server/Infrastructure/SiteTemplates/DefaultSiteTemplate.cs b/Oqtane.Server/Infrastructure/SiteTemplates/DefaultSiteTemplate.cs
@@ -39,7 +39,7 @@ public List<PageTemplate> CreateSite(Site site)
                 Name = "Home",
                 Parent = "",
                 Path = "",
-                Icon = "home",
+                Icon = "oi oi-home",
                 IsNavigation = true,
                 IsPersonalizable = false,
                 PagePermissions = new List<Permission> {
@@ -85,7 +85,7 @@ public List<PageTemplate> CreateSite(Site site)
                 Name = "Private",
                 Parent = "",
                 Path = "private",
-                Icon = "lock-locked",
+                Icon = "oi oi-lock-locked",
                 IsNavigation = true,
                 IsPersonalizable = false,
                 PagePermissions = new List<Permission> {
@@ -109,7 +109,7 @@ public List<PageTemplate> CreateSite(Site site)
                 Name = "My Page",
                 Parent = "",
                 Path = "mypage",
-                Icon = "target",
+                Icon = "oi oi-target",
                 IsNavigation = true,
                 IsPersonalizable = true,
                 PagePermissions = new List<Permission> {

diff --git a/Oqtane.Server/Infrastructure/SiteTemplates/EmptySiteTemplate.cs b/Oqtane.Server/Infrastructure/SiteTemplates/EmptySiteTemplate.cs
@@ -1,4 +1,4 @@
-using Oqtane.Models;
+using Oqtane.Models;
 using Oqtane.Infrastructure;
 using System.Collections.Generic;
 using Oqtane.Extensions;
@@ -27,7 +27,7 @@ public List<PageTemplate> CreateSite(Site site)
                 Name = "Home",
                 Parent = "",
                 Path = "",
-                Icon = "home",
+                Icon = "oi oi-home",
                 IsNavigation = true,
                 IsPersonalizable = false,
                 PagePermissions = new List<Permission> {

diff --git a/Oqtane.Server/Oqtane.Server.csproj b/Oqtane.Server/Oqtane.Server.csproj
@@ -26,6 +26,7 @@
     <EmbeddedResource Include="Scripts\Master.00.00.00.00.sql" />
     <EmbeddedResource Include="Scripts\Master.00.09.00.00.sql" />
     <EmbeddedResource Include="Scripts\Master.01.00.01.00.sql" />
+    <EmbeddedResource Include="Scripts\Tenant.02.00.01.01.sql" />
     <EmbeddedResource Include="Scripts\Tenant.00.00.00.00.sql" />
     <EmbeddedResource Include="Scripts\Tenant.00.09.00.00.sql" />
     <EmbeddedResource Include="Scripts\Tenant.00.09.01.00.sql" />
@@ -60,6 +61,9 @@
     <UpgradeFiles Include="$(ProjectDir)bin\Release\net5.0\Oqtane.Upgrade.runtimeconfig.json" />
     <TemplateFiles Include="$(ProjectDir)wwwroot\Modules\Templates\**\*.*" />
   </ItemGroup>
+  <ItemGroup>
+    <None Remove="Scripts\Tenant.02.00.01.01.sql" />
+  </ItemGroup>
   <Target Name="AddPayloadsFolder" AfterTargets="Publish">
     <Copy SourceFiles="@(UpgradeFiles)" DestinationFiles="@(UpgradeFiles->'$(PublishDir)%(RecursiveDir)%(Filename)%(Extension)')" SkipUnchangedFiles="false" />
     <Copy SourceFiles="@(TemplateFiles)" DestinationFiles="@(TemplateFiles->'$(PublishDir)wwwroot\Modules\Templates\%(RecursiveDir)%(Filename)%(Extension)')" SkipUnchangedFiles="false" />

diff --git a/Oqtane.Server/Scripts/Tenant.02.00.01.01.sql b/Oqtane.Server/Scripts/Tenant.02.00.01.01.sql
@@ -0,0 +1,9 @@
+/*  
+
+Version 2.0.1 Tenant migration script
+
+*/
+
+UPDATE [dbo].[Page] SET Icon = IIF(Icon <> '', 'oi oi-' + Icon, '');
+GO
+
diff --git a/Oqtane.Shared/Shared/Icons.cs b/Oqtane.Shared/Shared/Icons.cs
@@ -1,9 +1,9 @@
-namespace Oqtane.Shared
+namespace Oqtane.Shared
 {
     //Open Iconic icons set
     public static class Icons
     {
-        private const string Prefix = ""; //oi- 
+        private const string Prefix = "oi oi-";  
         public const string AccountLogin = Prefix + "account-login";
         public const string AccountLogout = Prefix + "account-logout";
         public const string ActionRedo = Prefix + "action-redo";