Format-SpectrePanel

Description

This function takes a string and formats it as a Spectre Console panel with optional title, border, and color. The resulting panel can be displayed in the console using the Write-Host command.
This function takes a string or renderable object and formats it as a Spectre Console panel with optional title, border, and color. The resulting panel can be displayed in the console using the Write-Host command.

Note

A panel can only contain a single renderable object. To combine multiple items (such as text and images) in one panel, you’ll need to wrap them in a container like Format-SpectreRows or Format-SpectreColumns first. Without this wrapping, Format-SpectrePanel will render each item in a separate panel.

See https://spectreconsole.net/widgets/panel for more information.

---

Examples

Example 1
This example demonstrates how to display a panel with a title and a rounded border.

Format-SpectrePanel -Data "Hello, world!" -Title "My Panel" -Border "Rounded" -Color "Red"

Example 2
This example demonstrates how to display a panel with a title and a double border that’s expanded to take up the whole console width.

"Hello, big panel!" | Format-SpectrePanel -Title "My Big Panel" -Border "Double" -Color "Magenta1" -Expand

Example 3
This example demonstrates how to combine text and images in a single panel. When combining multiple items in a panel, use Format-SpectreRows or Format-SpectreColumns to wrap them into a single renderable object.

$message = "Thanks Jeff!"
$image = Get-SpectreImage -ImagePath ".\private\images\smiley.png" -MaxWidth 25
@($message, $image) | Format-SpectreRows | Format-SpectrePanel

Example 4
This example demonstrates how to combine text and images in a single panel with side-by-side layout.

$message = "Thanks Jeff!"
$image = Get-SpectreImage -ImagePath ".\private\images\smiley.png" -MaxWidth 25
@($message, $image) | Format-SpectreColumns | Format-SpectrePanel

---

Parameters

Data

The renderable item to be formatted as a panel.

Type	Required	Position	PipelineInput
[Object]	true	1	true (ByValue)

Header

The title to be displayed at the top of the panel.

Type	Required	Position	PipelineInput	Aliases
[String]	false	2	false	Title

Border

The type of border to be displayed around the panel.

Valid Values:

• Ascii
• Double
• Heavy
• None
• Rounded
• Square

Type	Required	Position	PipelineInput
[String]	false	3	false

Expand

Switch parameter that specifies whether the panel should be expanded to fill the available space.

Type	Required	Position	PipelineInput
[Switch]	false	named	false

Color

The color of the panel border.

Type	Required	Position	PipelineInput
[Color]	false	4	false

Width

The width of the panel.

Type	Required	Position	PipelineInput
[Int32]	false	5	false

Height

The height of the panel.

Type	Required	Position	PipelineInput
[Int32]	false	6	false

---

Syntax

Format-SpectrePanel [-Data] <Object> [[-Header] <String>] [[-Border] <String>] [-Expand] [[-Color] <Color>] [[-Width] <Int32>] [[-Height] <Int32>] [<CommonParameters>]