Skip to content

Module for creating and displaying Toast Notifications on Microsoft Windows 10.

License

Notifications You must be signed in to change notification settings

qaswani/BurntToast

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

BurntToast

Codacy Badge codecov Build Status PowerShell Gallery Version PowerShell Gallery Downloads Open Issues

BurntToast Logo Banner

PowerShell Module for displaying Windows 10 Toast Notifications

Install

PowerShell Gallery Install (Requires PowerShell v5)

    Install-Module -Name BurntToast

See the PowerShell Gallery for the complete details and instructions.

Manual Install

Download BurntToast.zip and extract the contents into $env:userprofile\Documents\WindowsPowerShell\modules\BurntToast (you may have to create these directories if they don't exist.)

if you using Powershell 6 or later, extract into $env:userprofile\Documents\PowerShell\Modules\BurntToast

Please remember to "unblock" the zip file before extracting the contents. Not doing so will result in the module not working correctly. This can be done via the file properties or with Unblock-File.

Examples

    New-BurntToastNotification

BurntToast Notification Example Default

    New-BurntToastNotification -AppLogo C:\smile.jpg -Text "Don't forget to smile!",
                                                           'Your script ran successfully, celebrate!'

BurntToast Notification Example Custom

    New-BurntToastNotification -Text 'WAKE UP!' -Sound 'Alarm2' -SnoozeAndDismiss

BurntToast Notification Example Alarm

Releases

Please note: as of v0.5.0, BurntToast no longer works on Windows 8.

  • Bleeding Edge (Development/Raw Repo)

  • v0.7.2

    • Fix: Curly Braces when "Reminder" pops up (#72)

    • Fix: Caching remote gifs are saved based on their remote filename and not overwritten (#105)

    • Fix: BurntToast and .NET 5 (#101)

  • v0.7.1

    • Update: Microsoft Community Toolkit to 6.0.0

    • New: Support relative paths on images

    • New: "ScheduledToast" switch added to Get-BTHistory which returns scheduled or snoozed toast notifications

    • Enhancement: Libraries only loaded on module import if libraries not already loaded

    • Enhancement: Validate that image paths exist

    • Fix: Reverted to XML clean up to remove curly braces if databindings are not being used (Issue #72)

    • Known Issues:

      • Regardless of what snooze option is chosen, a snoozed toast will re-appear after 9 minutes
      • Cause is unknown and isn''t unique to v0.7.1, will be investigated while working on v0.7.2
  • see more in the Full Change Log

Contributors

License

Image Credit

The default image for BurntToast Notifications is a photo taken by Craig Sunter

Contact

About

Module for creating and displaying Toast Notifications on Microsoft Windows 10.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PowerShell 100.0%