Write-SpectreFigletText
Description
This function writes a Spectre Console Figlet text to the console. The text can be aligned to the left, right, or center, and can be displayed in a specified color.
Examples
Example 1
This example demonstrates how to write Figlet text to the console.
Write-SpectreFigletText -Text "Hello Spectre!" -Alignment "Center" -Color "Red"Example 2
This example demonstrates how to write Figlet text to the console using a custom Figlet font.
Write-SpectreFigletText -Text "Whoa?!" -FigletFontPath "..\PwshSpectreConsole.Docs\src\assets\3d.flf"Parameters
Text
The text to display in the Figlet format.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[String] | false | 1 | false |
Alignment
The alignment of the text. The default value is “Left”.
Valid Values:
- Left
- Right
- Center
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[String] | false | 2 | false |
Color
The color of the text. The default value is the accent color of the script.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[Color] | false | 3 | false |
FigletFontPath
The path to the Figlet font file to use. If this parameter is not specified, the default built-in Figlet font is used. The figlet font format is usually *.flf, see https://spectreconsole.net/widgets/figlet for more.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[String] | false | 4 | false |
PassThru
Returns the Spectre Figlet text object instead of writing it to the console.
| Type | Required | Position | PipelineInput |
|---|---|---|---|
[Switch] | false | named | false |
Syntax
Write-SpectreFigletText [[-Text] <String>] [[-Alignment] <String>] [[-Color] <Color>] [[-FigletFontPath] <String>] [-PassThru] [<CommonParameters>]