#361: changed from Title, and added DisplayName for Pages instead

Author: Badgerati

docs/release-notes.md

@@ -5,7 +5,7 @@
 ```plain
 ### Enhancements
 * #340: Add new `-MaxLength` for textboxes (thanks @thekamilpro!)
-* #361: Add DisplayName for Tables/Charts, and use the Title in the sidebar for Pages
+* #361: Add DisplayName for Tables/Charts, and also for Pages for their name in the sidebar
 
 ### Bugs
 * #255: Fixes page group names not allowing spaces

examples/language.ps1

@@ -52,7 +52,7 @@ Start-PodeServer -StatusPageExceptions Show {
         )
     )
 
-    Set-PodeWebHomePage -Layouts $grid1 -Title '家'
+    Set-PodeWebHomePage -Layouts $grid1 -DisplayName '家'
 
 
     # add a page to search and filter services (output in a new table element) [note: requires auth]
@@ -113,7 +113,7 @@ Start-PodeServer -StatusPageExceptions Show {
         }
     }
 
-    Add-PodeWebPage -Name Services -Title 'サービス' -Icon 'cogs' -Group Tools -Layouts $editModal, $helpModal, $table -ScriptBlock {
+    Add-PodeWebPage -Name Services -DisplayName 'サービス' -Icon 'cogs' -Group Tools -Layouts $editModal, $helpModal, $table -ScriptBlock {
         $name = $WebEvent.Query['value']
         if ([string]::IsNullOrWhiteSpace($name)) {
             return
@@ -131,7 +131,7 @@ Start-PodeServer -StatusPageExceptions Show {
 
 
     # open twitter
-    Add-PodeWebPageLink -Name Twitter -Title 'Tweet' -Icon Twitter -Group Social -ScriptBlock {
+    Add-PodeWebPageLink -Name Twitter -DisplayName 'Tweet' -Icon Twitter -Group Social -ScriptBlock {
         Move-PodeWebUrl -Url 'https://twitter.com' -NewTab
     }
 }

src/Private/Helpers.ps1

@@ -304,7 +304,7 @@ function Get-PodeWebState
 
 function Get-PodeWebHomeName
 {
-    $name = (Get-PodeWebState -Name 'pages')['/'].Title
+    $name = (Get-PodeWebState -Name 'pages')['/'].DisplayName
     if ([string]::IsNullOrWhiteSpace($name)) {
         return 'Home'
     }

src/Public/Pages.ps1

@@ -174,6 +174,7 @@ function Set-PodeWebLoginPage
             Page = @{
                 Name = 'Home'
                 Title = 'Home'
+                DisplayName = 'Home'
                 Path = '/'
                 IsSystem = $true
             }
@@ -203,6 +204,10 @@ function Set-PodeWebHomePage
         [hashtable[]]
         $Layouts,
 
+        [Parameter()]
+        [string]
+        $DisplayName,
+
         [Parameter()]
         [string]
         $Title,
@@ -229,8 +234,12 @@ function Set-PodeWebHomePage
     }
 
     # set page title
+    if ([string]::IsNullOrWhiteSpace($DisplayName)) {
+        $DisplayName = 'Home'
+    }
+
     if ([string]::IsNullOrWhiteSpace($Title)) {
-        $Title = 'Home'
+        $Title = $DisplayName
     }
 
     # route path
@@ -242,7 +251,8 @@ function Set-PodeWebHomePage
         ObjectType = 'Page'
         Path = $routePath
         Name = 'Home'
-        Title = $Title
+        Title = [System.Net.WebUtility]::HtmlEncode($Title)
+        DisplayName = [System.Net.WebUtility]::HtmlEncode($DisplayName)
         NoTitle = $NoTitle.IsPresent
         Navigation = $Navigation
         Layouts = $Layouts
@@ -317,6 +327,10 @@ function Add-PodeWebPage
         [string]
         $Name,
 
+        [Parameter()]
+        [string]
+        $DisplayName,
+
         [Parameter()]
         [string]
         $Title,
@@ -400,8 +414,12 @@ function Add-PodeWebPage
     }
 
     # set page title
+    if ([string]::IsNullOrWhiteSpace($DisplayName)) {
+        $DisplayName = $Name
+    }
+
     if ([string]::IsNullOrWhiteSpace($Title)) {
-        $Title = $Name
+        $Title = $DisplayName
     }
 
     # build the route path
@@ -414,6 +432,7 @@ function Add-PodeWebPage
         Path = $routePath
         Name = $Name
         Title = [System.Net.WebUtility]::HtmlEncode($Title)
+        DisplayName = [System.Net.WebUtility]::HtmlEncode($DisplayName)
         NoTitle = $NoTitle.IsPresent
         NoBackArrow = $NoBackArrow.IsPresent
         NoBreadcrumb = $NoBreadcrumb.IsPresent
@@ -515,6 +534,7 @@ function Add-PodeWebPage
             Write-PodeWebViewResponse -Path 'index' -Data @{
                 Page = $global:PageData
                 Title = $global:PageData.Title
+                DisplayName = $global:PageData.DisplayName
                 Theme = $theme
                 Navigation = $navigation
                 Breadcrumb = $breadcrumb
@@ -579,7 +599,7 @@ function Add-PodeWebPageLink
 
         [Parameter()]
         [string]
-        $Title,
+        $DisplayName,
 
         [Parameter()]
         [string]
@@ -633,16 +653,16 @@ function Add-PodeWebPageLink
     }
 
     # set page title
-    if ([string]::IsNullOrWhiteSpace($Title)) {
-        $Title = $Name
+    if ([string]::IsNullOrWhiteSpace($DisplayName)) {
+        $DisplayName = $Name
     }
 
     # setup page meta
     $pageMeta = @{
         ComponentType = 'Page'
         ObjectType = 'Link'
         Name = $Name
-        Title = [System.Net.WebUtility]::HtmlEncode($Title)
+        DisplayName = [System.Net.WebUtility]::HtmlEncode($DisplayName)
         NewTab = $NewTab.IsPresent
         Icon = $Icon
         Group = $Group

src/Public/Utilities.ps1

@@ -84,6 +84,7 @@ function Use-PodeWebTemplates
                 Name = 'Home'
                 Path = '/'
                 TItle = 'Home'
+                DisplayName = 'Home'
                 IsSystem = $true
             }
         }

src/Templates/Views/index.pode

@@ -1,6 +1,6 @@
 <html>
     $(Use-PodeWebPartialView -Path 'shared/head' -Data @{
-        Title = $data.Page.Title
+        Title = $data.Page.DisplayName
         Theme = $data.Theme
         AppPath = $data.AppPath
     })
@@ -182,7 +182,7 @@
                                             <a class='nav-link $($activePage)' name='$($page.Name)' pode-page-group='$($pageGroup.Name)' pode-page-type='$($page.ObjectType)' pode-dynamic='$($page.IsDynamic)' $($href)>
                                                 <div>
                                                     <span class='mdi mdi-$($page.Icon.ToLowerInvariant()) mdi-size-22 mRight02'></span>
-                                                    $([System.Net.WebUtility]::HtmlEncode($page.Title))
+                                                    $([System.Net.WebUtility]::HtmlEncode($page.DisplayName))
                                                 </div>
                                             </a>
                                         </li>"