public/prompts/Read-SpectreConfirm.ps1
|
using module "..\..\private\completions\Completers.psm1" using module "..\..\private\completions\Transformers.psm1" function Read-SpectreConfirm { <# .SYNOPSIS Displays a simple confirmation prompt with the option of selecting yes or no and returns a boolean representing the answer. .DESCRIPTION Displays a simple confirmation prompt with the option of selecting yes or no. Additional options are provided to display either a success or failure response message in addition to the boolean return value. .PARAMETER Message The prompt to display to the user. The default value is "Do you like cute animals?". .PARAMETER DefaultAnswer The default answer to the prompt if the user just presses enter. The default value is "y". .PARAMETER ConfirmSuccess The text and markup to display if the user chooses yes. If left undefined, nothing will display. .PARAMETER ConfirmFailure The text and markup to display if the user chooses no. If left undefined, nothing will display. .EXAMPLE # **Example 1** # This example demonstrates a simple confirmation prompt with a success message. $answer = Read-SpectreConfirm -Message "Would you like to continue the preview installation of [#7693FF]PowerShell 7?[/]" ` -ConfirmSuccess "Woohoo! The internet awaits your elite development contributions." ` -ConfirmFailure "What kind of monster are you? How could you do this?" # Type "y", "↲" to accept the prompt Write-Host "Your answer was '$answer'" #> [Reflection.AssemblyMetadata("title", "Read-SpectreConfirm")] param ( [Parameter(Mandatory)] [Alias("Title", "Question", "Prompt")] [String] $Message, [ValidateSet("y", "n", "none")] [string] $DefaultAnswer = "y", [string] $ConfirmSuccess, [string] $ConfirmFailure, [int] $TimeoutSeconds, [ColorTransformationAttribute()] [ArgumentCompletionsSpectreColors()] [Spectre.Console.Color] $Color = $script:AccentColor ) # This is much fiddlier but it exposes the ability to set the color scheme. The confirmationprompt is just a textprompt with two choices hard coded to y/n: # https://github.com/spectreconsole/spectre.console/blob/63b940cf0eb127a8cd891a4fe338aa5892d502c5/src/Spectre.Console/Prompts/ConfirmationPrompt.cs#L71 $confirmationPrompt = [Spectre.Console.TextPrompt[string]]::new($Message) $confirmationPrompt = [Spectre.Console.TextPromptExtensions]::AddChoice($confirmationPrompt, "y") $confirmationPrompt = [Spectre.Console.TextPromptExtensions]::AddChoice($confirmationPrompt, "n") if ($DefaultAnswer -ne "none") { $confirmationPrompt = [Spectre.Console.TextPromptExtensions]::DefaultValue($confirmationPrompt, $DefaultAnswer) } # This is how I added the default colors with Set-SpectreColors so you don't have to keep passing them through and get a consistent TUI color scheme $confirmationPrompt.DefaultValueStyle = [Spectre.Console.Style]::new($script:DefaultValueColor) $confirmationPrompt.ChoicesStyle = [Spectre.Console.Style]::new($Color) $confirmationPrompt.InvalidChoiceMessage = "[red]Please select one of the available options[/]" # Invoke-SpectrePromptAsync supports ctrl-c $confirmed = (Invoke-SpectrePromptAsync -Prompt $confirmationPrompt -TimeoutSeconds $TimeoutSeconds) -eq "y" if (!$confirmed) { if (![String]::IsNullOrWhiteSpace($ConfirmFailure)) { Write-SpectreHost $ConfirmFailure } } else { if (![String]::IsNullOrWhiteSpace($ConfirmSuccess)) { Write-SpectreHost $ConfirmSuccess } } return $confirmed } |