(#265) Add support for setting Button colors

Author: Windos

Help/New-BTButton.md

@@ -20,6 +20,7 @@ Up to five buttons can be added to a single Toast notification. Buttons may have
 | `ActivationType`| Microsoft.Toolkit.Uwp.Notifications.ToastActivationType| Defines the activation type that triggers when the button is pressed. Defaults to Protocol.                                                                                            | No                                          |
 | `ImageUri`     | String                                                  | Path or URI of an image icon to display next to the button label.                                                                                                                      | No                                          |
 | `Id`           | String                                                  | Specifies an ID associated with another toast control (textbox or selection box). For standard buttons, this aligns the button next to a control; for snooze buttons, associates with a selection box.                      | No                                          |
+| `Color`        | String (Green/Red)                                      | If specified as `Green` or `Red`, the button will be visually styled as "Success" (green) or "Critical" (red) where supported. Use for representing positive/primary or destructive actions.                                | No                                          |
 
 ## INPUTS
 
@@ -74,6 +75,28 @@ New-BTButton -Content 'View Picture' -Arguments $pic -ImageUri $pic
 
 Button with a picture to the left, launches the image file.
 
+## NOTES
+
+To visually distinguish action buttons, you can set the `Color` parameter to `Green` or `Red`. This will render these buttons with a "Success" (green) or "Critical" (red) style in systems that support advanced toast button styling (Windows 11+). Useful for marking approve/submit (green) or destructive (red) actions.
+
+## EXAMPLES
+
+### Example 6
+
+```powershell
+New-BTButton -Content 'Approve' -Arguments 'approve' -Color Green
+```
+
+Creates a "Success" style (green) button intended for positive actions.
+
+### Example 7
+
+```powershell
+New-BTButton -Content 'Delete' -Arguments 'delete' -Color Red
+```
+
+Creates a "Critical" style (red) button for destructive actions.
+
 ## LINKS
 
 - [New-BTAction](New-BTAction.md)

Help/Submit-BTNotification.md

@@ -9,6 +9,8 @@ Submits a completed toast notification for display.
 The `Submit-BTNotification` function submits a completed toast notification to the operating system's notification manager for display.
 This function supports advanced scenarios such as event callbacks for user actions or toast dismissal, sequence numbering to ensure correct update order, unique identification for toast replacement, expiration control, direct Action Center delivery, and designating a notification as "Important" (using the `-Urgent` switch) so that it can break through Focus Assist.
 
+If a button in the toast is created using `New-BTButton` with the `-Color` parameter (`Green` or `Red`), Submit-BTNotification will ensure those buttons are visually styled as "Success" (green) or "Critical" (red) in capable environments. This allows you to clearly indicate primary/positive or destructive actions on the notification.
+
 When a script block is supplied for any of the event actions (`ActivatedAction`, `DismissedAction`, or `FailedAction`), the function ensures that only one registration for a logically identical handler is allowed per notification event type. This is accomplished by normalizing and hashing the script block; the resulting hash uniquely identifies the action for event registration purposes. Attempting to register the same handler multiple times for a given event will not create a duplicate subscription, but instead will produce an informative warning.
 
 If the `-ReturnEventData` switch is used and any event action scriptblocks are supplied (`ActivatedAction`, `DismissedAction`, `FailedAction`),

Tests/New-BTButton.Tests.ps1

@@ -88,3 +88,12 @@ Describe 'New-BTButton' {
         }
     }
 }
+
+Context 'custom button with color' {
+    It 'creates a button with green color without throwing' {
+        { New-BTButton -Content 'Approve' -Arguments 'approve' -Color Green -WhatIf } | Should -Not -Throw
+    }
+    It 'creates a button with red color without throwing' {
+        { New-BTButton -Content 'Delete' -Arguments 'delete' -Color Red -WhatIf } | Should -Not -Throw
+    }
+}

Tests/Submit-BTNotification.Tests.ps1

@@ -47,10 +47,10 @@ Describe 'Submit-BTNotification' {
             $output | Should -Not -Contain "Duplicate or conflicting OnActivated ScriptBlock event detected"
         }
     }
-Context 'Urgent scenario' {
-    It 'runs without error with -Urgent' {
-        $mockContent = [Activator]::CreateInstance([Microsoft.Toolkit.Uwp.Notifications.ToastContent])
-        { Submit-BTNotification -Content $mockContent -Urgent -WhatIf } | Should -Not -Throw
+    Context 'Urgent scenario' {
+        It 'runs without error with -Urgent' {
+            $mockContent = [Activator]::CreateInstance([Microsoft.Toolkit.Uwp.Notifications.ToastContent])
+            { Submit-BTNotification -Content $mockContent -Urgent -WhatIf } | Should -Not -Throw
+        }
     }
-}
 }

src/Public/New-BTButton.ps1

@@ -1,11 +1,13 @@
 function New-BTButton {
     <#
         .SYNOPSIS
-        Creates a new clickable button for a Toast Notification.
+        Creates a new clickable button for a Toast Notification, with optional color styling.
 
         .DESCRIPTION
         The New-BTButton function creates a new button for a Toast Notification. Up to five buttons can be added to a single Toast notification.
-        Buttons may have display text, an icon, an optional activation type, argument string, or serve as system managed Dismiss/Snooze buttons.
+        Buttons may have display text, an icon, an optional activation type, argument string, serve as system managed Dismiss/Snooze buttons, and may optionally be rendered with colored button styles by specifying -Color.
+
+        If -Color is set to 'Green' or 'Red', the button will be displayed with a "Success" (green) or "Critical" (red) style in supported environments.
 
         .PARAMETER Snooze
         Switch. Creates a system-handled snooze button. When paired with a selection box on the toast, the snooze time is customizable.
@@ -28,6 +30,9 @@
         .PARAMETER Id
         String. Specifies an ID associated with another toast control (textbox or selection box). For standard buttons, this aligns the button next to a control, for snooze buttons it associates with a selection box.
 
+        .PARAMETER Color
+        String. Optional. If specified as 'Green' or 'Red', the button will be visually styled as "Success" (green) or "Critical" (red) where supported. Use for indicating primary/positive or destructive actions.
+
         .INPUTS
         None. You cannot pipe input to this function.
 
@@ -57,6 +62,14 @@
         New-BTButton -Content 'View Picture' -Arguments $pic -ImageUri $pic
         Button with a picture to the left, launches the image file.
 
+        .EXAMPLE
+        New-BTButton -Content 'Approve' -Arguments 'approve' -Color 'Green'
+        Creates a button with a green "Success" style intended for positive actions like approval.
+
+        .EXAMPLE
+        New-BTButton -Content 'Delete' -Arguments 'delete' -Color 'Red'
+        Creates a button with a red "Critical" style indicating a destructive action.
+
         .LINK
         https://github.com/Windos/BurntToast/blob/main/Help/New-BTButton.md
     #>
@@ -97,7 +110,10 @@
         [Parameter(ParameterSetName = 'Button')]
         [Parameter(ParameterSetName = 'Snooze')]
         [alias('TextBoxId', 'SelectionBoxId')]
-        [string] $Id
+        [string] $Id,
+
+        [ValidateSet('Green', 'Red')]
+        [string] $Color
     )
 
     switch ($PsCmdlet.ParameterSetName) {
@@ -125,7 +141,7 @@
             if ($Id) {
                 $Button.SelectionBoxId = $Id
             }
-            
+
             if ($ImageUri) {
                 $Button.ImageUri = $ImageUri
             }
@@ -139,6 +155,10 @@
         }
     }
 
+    if ($Color) {
+        $Button = $Button.SetHintActionId($Color)
+    }
+
     switch ($Button.GetType().Name) {
         ToastButton { if($PSCmdlet.ShouldProcess("returning: [$($Button.GetType().Name)]:Content=$($Button.Content):Arguments=$($Button.Arguments):ActivationType=$($Button.ActivationType):ImageUri=$($Button.ImageUri):TextBoxId=$($Button.TextBoxId)")) { $Button }}
         ToastButtonSnooze { if($PSCmdlet.ShouldProcess("returning: [$($Button.GetType().Name)]:CustomContent=$($Button.CustomContent):ImageUri=$($Button.ImageUri):SelectionBoxId=$($Button.SelectionBoxId)")) { $Button } }

src/Public/Submit-BTNotification.ps1

@@ -6,6 +6,9 @@
         .DESCRIPTION
         The Submit-BTNotification function submits a completed toast notification to the operating system's notification manager for display.
         This function supports advanced scenarios such as event callbacks for user actions or toast dismissal, sequence numbering to ensure correct update order, unique identification for toast replacement, expiration control, and direct Action Center delivery.
+        Supports colored action buttons: when a button generated via New-BTButton includes the -Color parameter
+        ('Green' or 'Red'), the notification will style those buttons as "Success" (green) or "Critical" (red)
+        to visually distinguish positive or destructive actions where supported.
 
         When an action ScriptBlock is supplied (Activated, Dismissed, or Failed), a normalized SHA256 hash of its content is used to generate a unique SourceIdentifier for event registration.
         This prevents duplicate handler registration for the same ScriptBlock, warning if a duplicate registration is attempted.
@@ -100,10 +103,19 @@
     $ToastXml.LoadXml($ToastXmlContent)
 
     if ($Urgent) {
-        try {
-            $ToastXml.GetElementsByTagName('toast')[0].SetAttribute('scenario', 'urgent')
-        } catch {
-            # We don't actually want to capture these errors, but rather suppress them.
+        try {$ToastXml.GetElementsByTagName('toast')[0].SetAttribute('scenario', 'urgent')} catch {}
+    }
+
+    if ($ToastXml.GetXml() -match 'hint-actionId="(Red|Green)"') {
+        try {$ToastXml.GetElementsByTagName('toast').SetAttribute('useButtonStyle', 'true')} catch {}
+
+        foreach ($ActionElement in $ToastXml.GetElementsByTagName('actions')[0].ChildNodes) {
+            if ($ActionElement.GetAttribute('hint-actionId') -eq 'Red') {
+                $ActionElement.SetAttribute('hint-buttonStyle', 'Critical')
+            }
+            if ($ActionElement.GetAttribute('hint-actionId') -eq 'Green') {
+                $ActionElement.SetAttribute('hint-buttonStyle', 'Success')
+            }
         }
     }