New-UDAlert

Synopsis

An alert displays a short, important message in a way that attracts the user's attention without interrupting the user's task.

Syntax

New-UDAlert [-Id <String>] [-Severity <String>] [-Text <String>] [-Title <String>] [-ClassName <String>] [-Style <Hashtable>] [-Dense] [<CommonParameters>]

New-UDAlert [-Id <String>] [-Severity <String>] [-Children <ScriptBlock>] [-Title <String>] [-ClassName <String>] [-Style <Hashtable>] [-Dense] [<CommonParameters>]

Description

An alert displays a short, important message in a way that attracts the user's attention without interrupting the user's task.

Parameters

-Id

The ID of this component.

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

-Severity

The severity of this alert. Valid values are: "success", "error", "warning", "info"

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

-Children

Content of the alert.

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

-Text

Text for the body of the alert.

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

-Title

A title for this alert.

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

-ClassName

A CSS class to apply to the alert.

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

-Style

An hashtable of styles to apply to this component.

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

-Dense

Reduces the vertical padding of the alert.

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

Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters.

Outputs

Examples

Example 1: Basic alert

New-UDStack -Content {
   New-UDAlert -Severity 'error'  -Title "Error" -Id 'alert1'
   New-UDAlert -Severity 'warning' -Title "Warning" -Id 'alert2'
   New-UDAlert -Severity 'info'  -Title "Info" -Id 'alert3'
   New-UDAlert -Severity 'success' -Title "Success" -Id 'alert4'
} -Direction 'column'

The alert offers four severity levels that set a distinctive icon and color.

Example 2: Text and Title

New-UDStack -Content {
   New-UDAlert -Severity 'error' -Title 'Error' -Text 'This is an error alert' -Id 'alert5'
   New-UDAlert -Severity 'warning'  -Title 'Warning' -Text 'This is an warning alert' -Id 'alert6'
   New-UDAlert -Severity 'info' -Title 'Info' -Text 'This is an error info' -Id 'alert7'
   New-UDAlert -Severity 'success' -Title 'Success' -Text 'This is an success alert' -Id 'alert8'
} -Direction 'column'

You can use the -Title parameter to display a formatted title above the content.

Example 3: Dense

New-UDStack -Content {
   New-UDAlert -Severity 'error'  -Title "Error" -Id 'alert9' -Dense
   New-UDAlert -Severity 'warning' -Title "Warning" -Id 'alert10' -Dense
   New-UDAlert -Severity 'info'  -Title "Info" -Id 'alert11' -Dense
   New-UDAlert -Severity 'success' -Title "Success" -Id 'alert12' -Dense
} -Direction 'column'

You can use the -Dense parameter to reduce the vertical padding of the alert.