Cmdlet

New-ConsoleHeaderBar

Module: ConsoleMonster
Inputs: None
Outputs: ConsoleMonster.Widgets.HeaderBar

Creates a header with a title, breadcrumbs, detail and optional elapsed time.

Syntax

New-ConsoleHeaderBar
[-Crumb <String[]>]
[-Detail <Object>]
[-ElapsedSeconds <Double>]
[-HeaderRight <Object>]
[-ShowElapsed]
[-Status <StatusKind>]
[-Subtitle <Object>]
[-Title] <Object>
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Returns a reusable HeaderBar widget without opening a session. Status is a semantic outcome; Detail is the text beside it. HeaderRight supplies independent right-aligned content.

Examples

Example 1

New-ConsoleHeaderBar 'Build' -Subtitle 'Release' -Status Pass -Detail 'Ready' | Show-Console

Show a compact build header.

Parameters

-Crumb String[] optional: Breadcrumbs shown before the title.
-Detail Object optional: Current descriptive text.
-ElapsedSeconds Double optional: An explicit elapsed duration; otherwise the rendering session supplies it.
-HeaderRight Object optional: Independent text at the right of the header.
-ShowElapsed SwitchParameter optional: Shows elapsed time in the header.
-Status StatusKind optional: Semantic outcome displayed before the detail.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info
-Subtitle Object optional: Text qualifying the title.
-Title Object requiredposition: 0: The header's title.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.