Just to make this piece a bit more easy, as I was looking for icons and couldn't find the name of it.

`
New-UDDashboard -Title "Hello, World!" -Content {
New-UDTextbox -Id 'txtIconSearch' -Label 'Search'
New-UDButton -Text 'Search' -OnClick {
Sync-UDElement -Id 'icons'
}

New-UDElement -tag 'p' -Content {}

New-UDDynamic -Id 'icons' -Content {
        $Icons = [Enum]::GetNames([UniversalDashboard.Models.FontAwesomeIcons])
        $IconSearch = (Get-UDElement -Id 'txtIconSearch').value
        if ($null -ne $IconSearch -and $IconSearch -ne '')
        {
        $Icons = $Icons.where({ $_ -match $IconSearch})
    }

    foreach($icon in $icons) {
        New-UDChip -Label $icon -Icon (New-UDIcon -Icon $icon)
    }
}

}
`

Changed is the following line:

New-UDChip -Label $icon -Icon (New-UDIcon -Icon $icon)

It would be nice if the documentation would support dark/light theme as well!
At night, when I open the help link via the admin console I always briefly see stars xD I know you can also solve this via browser(AddIns) but would still be nice if it was integrated by default - of course only if not too complicated to implement and with no high priority!

Kind regards

At https://docs.powershelluniversal.com/userinterfaces/dashboards/building-dashboards#components there is a link which references itself.

In this article, the following line should probably begin with 'These'
https://docs.powershelluniversal.com/config/repository

'This entities are stored within the PowerShell Universal database.'

https://github.com/ironmansoftware/universal-docs/blob/master/cmdlets/New-UDListItem.txt

where is the -switch stuff?

The attached file is found inside a New-UDPage -Content block.
accountsSnippet.ps1.txt

ironmansoftware/issues#1680

Problem

The v4 documentation at https://docs.powershelluniversal.com/config/hosting/hosting-iis links directly to the ASP .NET 7.0.5 download but the current version has since surpassed 7.0.5.

Recommendation

The link could point to the generic landing page at https://dotnet.microsoft.com/en-us/download/dotnet/7.0

Visuals

Version: 1.5.9
Expected: Returns stream output for a job. This includes error, warning, information, debug and verbose. Use Get-UAJobPipelineOutput to receive pipeline output.

Results: Only showing [ERR] messages under job output and skipping over [INF]

`New-PSUEndpoint -Url "/offboard/:account" -Method "Get" -Endpoint {
$Server = "redacted"
$AuthUser = Get-UAVariable -Name 'redacted'
$AppToken = 'redacted'

Connect-UAServer -ComputerName $Server -AppToken $AppToken

if (Get-aduser $Account) {
    try {
		Invoke-UAScript -Script $ScriptName -Account $Account -Credential $AuthUser -AppToken $AppToken | Tee-Object -Variable job | Wait-UAJob
        $CurrentJob = Get-UAJob -Id $Job.Id 
        Write-Output "User: $($CurrentJob.Identity.Name)"  

        if ($CurrentJob.Status -eq 'Completed') {
            Write-Output "Job #$($CurrentJob.id) Completed."

            $Pipeline = Get-UAJobPipelineOutput -Job $CurrentJob
            Write-Output "PipelineOutput: $Pipeline"
            $UAJobOutput = Get-UAJobOutput -Job $CurrentJob | Select-Object -Expand Message
            "UAJobOutput: $UAJobOutput"
        } 
        else {
            $Output = Get-UAJobOutput -Job $CurrentJob | Select-Object -Expand Message
            New-PSUApiResponse -StatusCode 400 -Body "Failed: $Output [ERROR: $_]"
        } 
    }
    catch {
        New-PSUApiResponse -StatusCode 400 -Body "Failed! [ERROR: $_]"
    }
}
else {
    New-PSUApiResponse -StatusCode 400 -Body "User: $Account not found"
}

} -Authentication -Role "Administrator"`

when creating a menu with ANT design, it seems that some of the styling is missing for example:
ant-menu-root
ant-menu-inline
ant-menu-light

please implement missing styling as per admin portal.

https://github.com/ironmansoftware/universal-docs/blob/master/platform/variables.md#creating-a-secret-variable

Values for secrets are stored within the current user's Windows Credential Manager instance. If you change users (such as running as a service account), the account will not have access to the previous user's secrets and you will need to add those secrets again.

This is a little bit ambiguous, what is the 'current user' in this context? The security principal of the Universal Windows Service? The security principal of the runspace (Eg: The Credential of a Automation Script, 'Run As' of a Dashboard, and the Windows Service for API Endpoints).

Given the Web UI does not prompt for credentials when adding a Secret Variable, one assumes it's the former of the above and then the secret is transferred into the runspace? I think these issues could be clarified.

@adamdriscoll

PSScriptAnalyzerSettings.psd1

@{
ExcludeRules=@('PSAvoidUsingWriteHost')
}

The documentation states here that

PSCustomObjects, objects or hashtables [...] in order to display a chart [...]

Consider specifying if an array of these objects must always be passed even if the object count is 1.
Consider specifically providing the names of all datatypes accepted. For example, [PSCustomObject], [Hashtable], [?]

https://docs.powershelluniversal.com/userinterfaces/dashboards/components/inputs/select

maybe change the toast to $eventdata[0]

We were running into a problem using a where statement and getting nothing back, spent an hour on this because we didn't think to look at the cmdlet help for onchange /facepalm

https://forums.ironmansoftware.com/t/new-udicon-onclick/8219/4?u=omzig

Can cause some issues trying to validate.

for instance...this won't work:

if($eventdata -eq ''){
New-UDValidationResult -ValidationError "Can't be blank"
}

I was messing around with showing a Toast message today, trying to get the -MessageSize parameter to work. The docs just state it is a string parameter, with no indication of what that string should be. I tried "small", "large", "XL", "48px", etc. but no joy. Then, just for grins I added a Title to the toast message, and tried the -TitleSize parameter. That one worked when I use "large". See below:

if (!$boolAuth) {Show-UDToast -Duration 2000 -Title "Oops" -TitleSize "large" -Message "You must login first!"; Invoke-UDRedirect "/login"}

After setting this, I noticed that -MessageSize now works:

if (!$boolAuth) {Show-UDToast -Duration 2000 -Title "Oops" -TitleSize "large" -Message "You must login first!" -MessageSize "large"; Invoke-UDRedirect "/login"}

Out-UDTableColumn is listed under the API, but the linked command goes here; to Out-UDTableData

Re: https://github.com/ironmansoftware/universal-docs/blob/master/config/hosting/azure.md#manually-creating-a-web-app

It appears that .NET 5 is no longer a thing in Azure App Services. I tested it on two tenants -- both have only 6, 7, Core 3.1, 4.8 and 3.5. Same with "az webapp list-runtimes". Version 3 is updated to .NET 6, so it's not big deal -- just outdated documentation.

https://docs.powershelluniversal.com/userinterfaces/dashboards/components/inputs/textbox#onblur

after 30min of working and debugging this, i found out that it is an array :(

https://docs.ironmansoftware.com/config/running-as-a-service-account

This page says what to configure for permissions of the service account.
But the page lacks HOW to set Universal Dashboard to use the service account.

For example, by default the dashboard seems to use NT AUTHORITY\SYSTEM as the account to run as (determined via whoami or ([System.Security.Principal.WindowsIdentity]::GetCurrent()).Name.

Again, this page doesn't tell me HOW to tell the UD to NOT run as NT AUTHORITY\SYSTEM and to instead run as a specified Service Account.

https://github.com/ironmansoftware/universal-docs/blob/master/api/endpoints.md#query-string-parameters should come with a warning regarding CWE-914: Improper Control of Dynamically-Identified Variables in order to promote good security practice:

Example of CWE-914:

New-PSUEndpoint -Url "/api/v1.0/CWE914Test" -Description "Vulnerable to CWE-914" -Endpoint {
	if($ChallengeInputData -eq "AcceptableInput") {
		$IsChallengePassed = $true
	}
	if($IsChallengePassed) {
		"Challenge passed. Here is Sensitive Information"
	} else {
		"Challenge not passed"
	}
}

Challenge is bypassed by http://localhost:5000/api/v1.0/CWE914Test?IsChallengePassed=1

Remediation by using https://github.com/ironmansoftware/universal-docs/blob/master/api/endpoints.md#param-block :

New-PSUEndpoint -Url "/api/v1.0/CWE914Test" -Description "Not Vulnerable to CWE-914" -Endpoint {
	Param(
		$ChallengeInputData
	)
	if($ChallengeInputData -eq "AcceptableInput") {
		$IsChallengePassed = $true
	}
	if($IsChallengePassed) {
		"Challenge passed. Here is Sensitive Information"
	} else {
		"Challenge not passed"
	}
}

@adamdriscoll

commit 6b9685b overwrote updates from f9bbd5b -> Reverting documentation updates 😅 (mostly syntax stuff)

I have seen a lot of questions on the forum that boil down to folks having a hard time telling what they should use for certain parameters on different elements. The documentation seems to be very high level in some cases, and leads to confusion. As just one example of this, parameters such as TitleSize and MessageSize for Show-UDToast simply say they are a String with no information on what would be an acceptable string to use ('48px', 'small', 'xl', etc.). Also, the example shown is very basic, using only 1 of the 26 different parameters. The online doc shows a few more examples, but still does not document complete use.

If I may suggest, something like this formatting for the github docs might lead to fewer forum requests:

Show-UDToast:

-MessageColor <DashboardColor>
    The text color of the message.
    
    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    **Acceptable Input      "white", "brown", "pink", "#fff", "#0000ff", "#ff0066"**

-TitleColor <DashboardColor>
    The text color of the title.
    
    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    **Acceptable Input      "white", "brown", "pink", "#fff", "#0000ff", "#ff0066"**
    
-TitleSize <String>
    The size of the title.
    
    Required?                    false
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    **Acceptable Input      Standard Sizes: "small", "medium", "large", or Pixel Size: "12", "48", "96"**
    
-Position <String>
    Where to display the toast.
    
    Required?                    false
    Position?                    named
    Default value                topRight
    Accept pipeline input?       false
    Accept wildcard characters?  false
    **Auto-Suggest?            true**
    **Acceptable Input      bottomCenter, bottomLeft, bottomRight, center, topCenter, topLeft, topRight**
         
-Overlay [<SwitchParameter>]
    Displays an overlay behind the toast.
    
    Required?                    false
    Position?                    named
    Default value                False
    Accept pipeline input?       false
    Accept wildcard characters?  false
    **-OverlayColor required when using this parameter**
          
-OverlayColor <DashboardColor>
    The color of the overlay.
    
    Required?                    **true if using -Overlay parameter**
    Position?                    named
    Default value                
    Accept pipeline input?       false
    Accept wildcard characters?  false
    **Acceptable Input      "white", "brown", "pink", "#fff", "#0000ff", "#ff0066"**

-------------------------- EXAMPLES --------------------------
#Simple Example
PS > Show-UDToast -Message 'Hello, World!'

#Comprehensive Example (formatting sucks when using backtick for line separation)
Show-UDToast -Position center
-Balloon -Broadcast
-ReplaceToast -RightToLeft
-Title "Oops" -TitleColor "brown" <# or "#0000ff" #>
-TitleSize "large" <# or "24px" #> -TransitionIn bounceInRight
-TransitionOut fadeInDown -Overlay
-OverlayColor "#0000ff" <# or "brown" #> -OverlayClose
-HideCloseButton -CloseOnClick
-CloseOnEscape -Message "!You must login first"
-MessageColor "#0000ff" <# or "brown" #> -MessageSize "24px" <# or "large" #>
-Duration 3000 -Icon "Ad"
-IconColor "#ff0066" <# or "pink" #> -Id "myToast"
-Persistent

There doesn't appear to be documentation explaining how the added support for client certificate authentication in PSU 2.3.0 operates and is configured.

Documentation here state to use Admin as username & any password.
I am unable to login following this method (I am brought back to the login page) debug tools states 401 unauthorized error.

https://github.com/ironmansoftware/universal-docs/blob/master/getting-started.md

Either the documentation is incorrect and an actual password is needed (which is my assumption and why I opened the issue here) or something else is going on.

Startup: Cannot bind argument to parameter 'Schedule' because it is null.
This error comes up when starting UD with the following code pasted from the documentation:
$EndpointSchedule = New-UDEndpointSchedule -Every 10 -Minute $Endpoint = New-UDEndpoint -Schedule $Schedule -Endpoint {}

I think the -Schedule should be set to: $EndpointSchedule, not $Schedule which is not defined.

Update the documentation here to correct a syntax issue. Reference.

Thank you jello for reporting this 👍

Current documentation

New-UDDashboard -Content {
} -Navigation {
    New-UDList -Children {
        New-UDListItem -Label "Home"
        New-UDListItem -Label "Getting Started" -Children {
            New-UDListItem -Label "Installation" -OnClick {}
            New-UDListItem -Label "Usage" -OnClick {}
            New-UDListItem -Label "FAQs" -OnClick {}
            New-UDListItem -Label "System Requirements" -OnClick {}
            New-UDListItem -Label "Purchasing" -OnClick {}
        }
    }
} -NavigationLayout permanent

Suggested Update

New-UDDashboard -Content {
} -Navigation (
    New-UDList -Children {
        New-UDListItem -Label "Home"
        New-UDListItem -Label "Getting Started" -Children {
            New-UDListItem -Label "Installation" -OnClick {}
            New-UDListItem -Label "Usage" -OnClick {}
            New-UDListItem -Label "FAQs" -OnClick {}
            New-UDListItem -Label "System Requirements" -OnClick {}
            New-UDListItem -Label "Purchasing" -OnClick {}
        }
    }
) -NavigationLayout permanent

• ironmansoftware/issues#1983

Install-Module PSScriptAnalyzer 

https://docs.powershelluniversal.com/development/editor#formatting

Please include examples in docs on how to use the following Cmdlets:

• New-UDCardToolbar
• New-UDCardMedia

I think explaining the differences (limitations etc.) between connecting with a Local or Remote Universal Instance with the VS Code Extension should be done. The experience doesn't seem to be the same (Eg: debugging). These differences should be documented.

https://docs.powershelluniversal.com/get-started/visual-studio-code-extension

@adamdriscoll

Even though migrating PowerShell Universal from one server to another should be relatively easily, it would be useful to have a doc page to inform users of what needs to be moved, if only to help with building a checklist for change management.

https://docs.powershelluniversal.com/userinterfaces/components/dynamic-regions#arguments-list

ArgumentList is now available in Sync-UDElement from Issue: ironmansoftware/issues#1815

The argumentlist section has a note that says that the arguments are static and don't update. Not true anymore.