New-UDBackdrop

Creates an overlay over the current page.

Synopsis

Creates an overlay over the current page.

Syntax

New-UDBackdrop [[-Id] <String>] [[-Color] <DashboardColor>] [-Children] <ScriptBlock> [-Open] [[-OnClick] <Endpoint>] [[-ClassName] <String>] [<CommonParameters>]

Description

Creates an overlay over the current page.

Parameters

-Id

The ID of this component

Required?                    false
Position?                    1
Default value                ([Guid]::NewGuid()).ToString()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Color

The color of the backdrop.

Required?                    false
Position?                    2
Default value                #fff
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Children

Child components to include in the backdrop.

Required?                    true
Position?                    3
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -Open [<SwitchParameter>]
        Whether the backdrop is open.

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-OnClick

A script block to invoke when the backdrop is clicked.

Required?                    false
Position?                    4
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ClassName

A CSS class to apply to the backdrop.

Required?                    false
Position?                    5
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

Outputs

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDBackdrop -Color '#fff' -Children {
PS >    New-UDTypography -Text 'Hello World'
PS > } -Open -OnClick {
PS >    Show-UDToast -Message 'Backdrop clicked'
PS >    Set-UDElement -Id 'backdrop1' -Properties @{
PS >        open = $false
PS >    }
PS > } -Id 'backdrop1'

Basic Backdrop|Creates a basic backdrop.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDBackdrop -Children {
PS >    New-UDTypography -Text 'Hello World'
PS > }  -OnClick {
PS >    Set-UDElement -Id 'backdrop2' -Properties @{
PS >        open = $false
PS >    }
PS > } -Id 'backdrop2'
PS > New-UDButton -Text 'Open Backdrop' -OnClick {
PS >    Set-UDElement -Id 'backdrop2' -Properties @{
PS >        open = $true
PS >    }
PS > }

Dynamically Open Backdrop|Creates a backdrop that can be opened with a button.


[Component("Backdrop", "BoothCurtain", "Creates a new backdrop.")]