Read-SpectreConfirm

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.

---

Examples

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'"

---

Parameters

Message

The prompt to display to the user. The default value is “Do you like cute animals?”.

Type	Required	Position	PipelineInput	Aliases
[String]	true	1	false	Title Question Prompt

DefaultAnswer

The default answer to the prompt if the user just presses enter. The default value is “y”.

Valid Values:

• y
• n
• none

Type	Required	Position	PipelineInput
[String]	false	2	false

ConfirmSuccess

The text and markup to display if the user chooses yes. If left undefined, nothing will display.

Type	Required	Position	PipelineInput
[String]	false	3	false

ConfirmFailure

The text and markup to display if the user chooses no. If left undefined, nothing will display.

Type	Required	Position	PipelineInput
[String]	false	4	false

TimeoutSeconds

Type	Required	Position	PipelineInput
[Int32]	false	5	false

Color

Type	Required	Position	PipelineInput
[Color]	false	6	false

---

Syntax

Read-SpectreConfirm [-Message] <String> [[-DefaultAnswer] <String>] [[-ConfirmSuccess] <String>] [[-ConfirmFailure] <String>] [[-TimeoutSeconds] <Int32>] [[-Color] <Color>] [<CommonParameters>]