Universal Dashboard is now a part of PowerShell Universal. This documentation is for reference to the v2 version of Universal Dashboard and is no longer maintained. PowerShell Universal Documentation can be found here.
Modals are popup windows that appear above the website. You can show a modal from an endpoint using Show-UDModal
.
In the below example, when you click the button a modal will be shown that contains the text specified. You can place any UD controls within the header and content script blocks.
New-UDButton -Text "Show Modal" -OnClick {Show-UDModal -Content {New-UDHeading -Text "Hello, Modal"}}
Clicking the button will bring up a modal that looks like this.
You can also hide modals using the Hide-UDModal
cmdlet. This cmdlet takes no arguments and simply hides the modal. This could be done after showing progress. In this example, we create a persistent modal that cannot be hidden by the user. Once the Start-Sleep
cmdlet timer elapses, the modal will close with Hide-UDModal
.
New-UDButton -Text "Show Modal" -OnClick {Show-UDModal -Content {New-UDHeading -Text "Loading some stuff..."} -PersistentStart-Sleep -Seconds 4Hide-UDModal}
You can adjust the height and width of a modal using the -Height
and -Width
parameters of Show-UDModal
. These parameters accept any valid HTML\CSS sizing such as px or em.
Here is an example of setting a modal to a certain pixel size.
New-UDButton -Text "Show Modal" -OnClick {Show-UDModal -Content {New-UDHeading -Text "Hello, Modal"} -Height '500px' -Width '1500px'}
You can change the color of a modal using the -BackgroundColor
and -FontColor
parameters of Show-UDModal
.
New-UDButton -Text "Show Modal" -OnClick {Show-UDModal -Content {New-UDHeading -Text "Hello, Modal" -Color 'white'} -BackgroundColor green}