BurntToast PowerShell Module

You can choose between two modes for the progress bar:

1. Determinate (Percentage-based): Use the -Value parameter with a Double between 0 and 1. You can optionally use -ValueDisplay to show custom text instead of the percentage.

   New-BTProgressBar -Status 'Copying files' -Value 0.2 -ValueDisplay '4/20 files complete'

2. Indeterminate (Animation-based): Use the -Indeterminate switch. This is useful when the exact completion time or percentage is unknown.

   New-BTProgressBar -Status 'Copying files' -Indeterminate

If you use the Chocolatey package manager, you can install the BurntToast PowerShell module using the choco install command.

choco install burnttoast-psmodule

To install the BurntToast module directly from the PowerShell Gallery, use the Install-Module command.

Install-Module -Name BurntToast

To ensure toast notifications display your custom app name and icon (registered via New-BTAppId), you must launch PowerShell or a compatible host from a shortcut that has the AppUserModelID property set. New-BTShortcut automates the creation of this shortcut.

Important: After creating the shortcut, you must launch PowerShell exclusively via this shortcut to guarantee Windows uses your custom branding for actionable toast notifications.

New-BTShortcut -AppId "Acme.MyApp" -DisplayName "My App PowerShell" -IconPath "C:\Path\To\MyIcon.ico"

To add interactive buttons to a notification, create a button object using New-BTButton and pass it to the -Button parameter of New-BurntToastNotification.

$btn = New-BTButton -Content 'Google' -Arguments 'https://google.com'
New-BurntToastNotification -Text 'New Blog!' -Button $btn

You can include a progress bar in your notification by creating a progress bar object with New-BTProgressBar and passing it to the -Children parameter of New-BTBinding.

$progress = New-BTProgressBar -Title 'Updating' -Status 'Running' -Value 0.4
$binding = New-BTBinding -Children $progress

To categorize or group notifications, create a header object using New-BTHeader and pass it to the -Header parameter of New-BurntToastNotification.

$header = New-BTHeader -Id '001' -Title 'Updates'
New-BurntToastNotification -Text 'Major Update Available!' -Header $header

On modern versions of Windows, you can add attribution text to the bottom of a notification using the -Attribution parameter.

New-BurntToastNotification -Text 'Integration Complete' -Attribution 'Powered by BurntToast'

You can use New-BTColumn to wrap individual elements for structured layouts. This is useful when passing a column to New-BTBinding.

# Example 2: Wrapping a single text element in a column
$label = New-BTText -Text 'Now Playing'
$col = New-BTColumn -Children $label
New-BTBinding -Children $label -Column $col

You can display an image icon next to the button label by providing a path or URI to the -ImageUri parameter.

$pic = 'C:\temp\example.png'
New-BTButton -Content 'View Picture' -Arguments $pic -ImageUri $pic

To add standard system-handled Snooze and Dismiss buttons to a notification, use the -SnoozeAndDismiss switch. Note that this parameter set is mutually exclusive with custom actions like buttons or inputs.

New-BTAction -SnoozeAndDismiss