Show-UDSnackbar

Shows a snackbar popup.

Synopsis

Shows a snackbar popup.

Syntax

Show-UDSnackbar [-Message] <String> [[-Id] <String>] [[-AutoHideDuration] <Int32>] [-Persist] [[-Variant] <String>] [[-AnchorVertical] <String>] [[-AnchorHorizontal] <String>] [[-ClassName] <String>] [<CommonParameters>]

Description

Shows a snackbar popup.

Parameters

-Message

The message to display.

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

-Id

The id of the snackbar. If not specified, a new guid will be generated.

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

-AutoHideDuration

The number of milliseconds to display the snackbar for. Defaults to 5000.

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

    -Persist [<SwitchParameter>]
        Whether the snackbar is persistent.

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

-Variant

The variant of the snackbar. Can be default, error, success, warning or info.

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

-AnchorVertical

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

-AnchorHorizontal

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

-ClassName

Required?                    false
Position?                    7
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-UDButton -Text 'Say Hello' -OnClick {
PS >   Show-UDSnackbar -Message 'Hello, World'
PS > }

Basic Snackbar|Shows a basic snackbar with the message 'Hello World'.




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

PS >New-UDButton -Text 'Say Hello' -OnClick {
PS >   Show-UDSnackbar -Message 'Goodbye, World' -Variant 'error'
PS > }

Error Snackbar|Shows an error snackbar with the message 'Hello World'.




-------------------------- EXAMPLE 3 --------------------------

PS >New-UDButton -Text 'Say Hello' -OnClick {
PS >   Show-UDSnackbar -Message 'Hello, World' -AnchorVertical 'bottom' -AnchorHorizontal 'right'
PS > }

Position|Shows a snackbar in the bottom right corner of the screen.