API Reference
Function
New-HTMLToast
Creates a new HTML toast notification with customizable text, icons, and colors.
Remarks
This function generates an HTML toast notification with options to set the text, text colors, icons, icon size, and various color settings for different elements of the notification.
Examples
EXAMPLE 1
New-HTMLToast -TextHeader "Notification" -Text "This is a sample notification" -IconBrands "fa-github" -BarColorRight "Red"
Creates a new HTML toast notification with a header "Notification", main text "This is a sample notification", GitHub icon, and a red color for the right bar.
EXAMPLE 2
New-HTMLToast -TextHeader "Alert" -Text "Alert message here" -IconBrands "fa-exclamation-triangle" -IconColor "Orange" -BarColorLeft "Yellow" -BarColorRight "Red"
Creates a new HTML toast notification with a header "Alert", main text "Alert message here", warning triangle icon in orange color, yellow left bar, and red right bar.
Common Parameters
This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.
For more information, see about_CommonParameters.
Syntax
New-HTMLToast [-BarColorLeft <String>] [-BarColorRight <String>] [-IconColor <String>] [-IconSize <Int32>] [-IconSolid <String>] [-Text <String>] [-TextColor <String>] [-TextHeader <String>] [-TextHeaderColor <String>] [<CommonParameters>]Parameter set:
FontAwesomeSolidParameters
- BarColorLeft String
- Specifies the color of the left bar in the notification.
- BarColorRight String
- Specifies the color of the right bar in the notification.
- IconColor String
- Specifies the color of the icon.
- IconSize Int32
- Specifies the size of the icon in pixels.
- IconSolid String
- ICON SOLID
- Text String
- Specifies the main text content of the notification.
- TextColor String
- Specifies the color of the main text.
- TextHeader String
- Specifies the header text of the notification.
- TextHeaderColor String
- Specifies the color of the header text.
New-HTMLToast [-BarColorLeft <String>] [-BarColorRight <String>] [-IconColor <String>] [-IconRegular <String>] [-IconSize <Int32>] [-Text <String>] [-TextColor <String>] [-TextHeader <String>] [-TextHeaderColor <String>] [<CommonParameters>]Parameter set:
FontAwesomeRegularParameters
- BarColorLeft String
- Specifies the color of the left bar in the notification.
- BarColorRight String
- Specifies the color of the right bar in the notification.
- IconColor String
- Specifies the color of the icon.
- IconRegular String
- ICON REGULAR
- IconSize Int32
- Specifies the size of the icon in pixels.
- Text String
- Specifies the main text content of the notification.
- TextColor String
- Specifies the color of the main text.
- TextHeader String
- Specifies the header text of the notification.
- TextHeaderColor String
- Specifies the color of the header text.
New-HTMLToast [-BarColorLeft <String>] [-BarColorRight <String>] [-IconBrands <String>] [-IconColor <String>] [-IconSize <Int32>] [-Text <String>] [-TextColor <String>] [-TextHeader <String>] [-TextHeaderColor <String>] [<CommonParameters>]Parameter set:
FontAwesomeBrandsParameters
- BarColorLeft String
- Specifies the color of the left bar in the notification.
- BarColorRight String
- Specifies the color of the right bar in the notification.
- IconBrands String
- Specifies the icon to be used from the Font Awesome Brands collection.
- IconColor String
- Specifies the color of the icon.
- IconSize Int32
- Specifies the size of the icon in pixels.
- Text String
- Specifies the main text content of the notification.
- TextColor String
- Specifies the color of the main text.
- TextHeader String
- Specifies the header text of the notification.
- TextHeaderColor String
- Specifies the color of the header text.