Building Dashboards
When building dashboards, you will pick one of the two built in dashboard frameworks. The components that are available for that framework will different. You can find examples of each of the frameworks at the below links.
All the documentation on this page will be referencing the v3 framework.
Dashboards can contain one or more pages. The simplest dashboard will contain a single page with some content. You can call any PowerShell cmdlet that is available on your machine to populate your dashboard.
Here's an example of simple dashboard that displays some text.
1
New-UDDashboard -Title 'My New Dashboard' -Content {
2
New-UDTypography -Text 'Hello!'
3
}
Copied!

New-UDDashboard

The top level cmdlet for dashboards is New-UDDashboard. You need to call it when returning a dashboard. You can use it with or without pages.

Content

The content of the dashboard is a series of components to display on the page. It's a script block that will return all the components in the order they will be rendered on the page. You can use the Grid component to layout items and display things like text with typography.
1
New-UDDashboard -Title 'My New Dashboard' -Content {
2
New-UDTypography -Text 'Hello!'
3
}
Copied!

Header Customization

Available in PowerShell Universal 2.5 or later.
You can customize the header of the dashboard using several parameters.
To change the navigation layout, use the -Navigation and -NavigationLayout parameters.
1
New-UDDashboard -Content {
2
} -Navigation {
3
New-UDList -Children {
4
New-UDListItem -Label "Home"
5
New-UDListItem -Label "Getting Started" -Children {
6
New-UDListItem -Label "Installation" -OnClick {}
7
New-UDListItem -Label "Usage" -OnClick {}
8
New-UDListItem -Label "FAQs" -OnClick {}
9
New-UDListItem -Label "System Requirements" -OnClick {}
10
New-UDListItem -Label "Purchasing" -OnClick {}
11
}
12
}
13
} -NavigationLayout permanent
Copied!

Components

Components are the individual widgets that you can place on you dashboard. There are components for displaying data, taking user input, adding text and images and more. Components can be downloaded as PowerShell modules and added to your dashboard.
Components are be caused using the standard verb-name syntax for any PowerShell cmdlet.
1
New-UDPage -Content {
2
New-UDTextbox
3
}
Copied!
Learn more about components here.

Pages

You can specify multiple pages within a dashboard. Each page defines a route. As for v3, all pages are dynamic. PowerShell will execute on each page load to render the new page. Since UD is a single page application, the web browser does not need to refresh the entire web page when navigating between the different dashboard pages.
1
$Pages = @()
2
$Pages += New-UDPage -Name 'My Home Page' -Content {}
3
$Pages += New-UDPage -Name 'Diagnostics' -Content {}
4
New-UDDashboard -Pages $Pages -Title 'Dashboard'
Copied!
Learn more about Pages here.

Built-in Variables

Built-in variables can be found on the variables page.

Debugging

When building a dashboard you will likely run into issues with cmdlet calls or syntax. Dashboards will auto reload as you make changes to the dashboard files. If a dashboard fails to start, you can navigate to the admin page, click Dashboards and click the Info button next to your dashboard.
The Log tab will show all the logging coming from the PowerShell execution from within in your dashboard. This should allow you to easily see errors and warnings coming from your dashboard.
You can use Write-Debug to add additional log messages to your dashboard. To enable debug logging, you will have to set the $DebugPreference variable at the top of your dashboard script.
1
$DebugPreference = 'Continue'
Copied!
Last modified 1mo ago