Dynamic Regions

New-UDDynamic allows you to define a dynamic region. Pages themselves are dynamic in nature. This means that every time a page is loaded, it runs the PowerShell for that page. Sometimes, you may want to reload a section of a page rather than the whole page itself. This is when you will want to use dynamic regions.
Basic Dynamic Region
This dynamic region reloads when the button is clicked.
1
New-UDDashboard -Title "Hello, World!" -Content {
2
    New-UDDynamic -Id 'date' -Content {
3
        New-UDTypography -Text "$(Get-Date)"
4
    }
5
​
6
    New-UDButton -Text 'Reload Date' -OnClick { Sync-UDElement -Id 'date' }
7
}
Copied!
Reload on button click
Auto Refresh
Dynamic regions enable the ability to auto refresh components after a certain amount of time. The entire region's script block will be run when autorefreshing.
If you have multiple related components that use the same data, consider putting them in the same dynamic region to improve performance.
1
    New-UDDynamic -Id 'date' -Content {
2
        New-UDTypography -Text "$(Get-Date)" -Variant h3
3
        New-UDTypography -Text "$(Get-Random)" -Variant h3
4
    } -AutoRefresh -AutoRefreshInterval 1
Copied!
Auto refresh dynamic region
Loading Component
Sometimes refreshing a dynamic component may take some time. For example, if you are querying another service's REST API or a data. Dynamic regions support configuration of the component that shows when the region is reloading. By default, nothing is shown. This can be any Universal Dashboard component.
1
    New-UDDynamic -Content {
2
        Start-Sleep -Seconds 3
3
        New-UDTypography -Text "Done!"
4
    } -LoadingComponent {
5
        New-UDProgress -Circular
6
    }
Copied!
Loading component for dynamic region
API
New-UDDynamic 
Defines a dynamic region on a page. 
Name
Type
Description
Required
Id
string
Unique identifier for this region
false
ArgumentList
object[]
Arguments to pass to the region. Available within the -Content by using $ArgumentList
false
Content
ScriptBlock
The content to load within the dynamic region
true
AutoRefresh
Switch
Whether this dynamic region will refresh on an interval
false
AutoRefreshInterval
int
The number of seconds between auto refreshes.
false
LoadingComponent
ScriptBlock
A component to display when the dynamic is loading
false

Pages

Element

Last modified 4mo ago

Copy link

Contents