Skip to content
ConsoleMonster
Cmdlet

New-ConsoleFooterBar

Module
ConsoleMonster
Inputs
None
Outputs
ConsoleMonster.Widgets.FooterBar

Creates a reusable footer with key hints, messages and linked segments.

Syntax

New-ConsoleFooterBar
[[-Hint] <IDictionary>]
[-Indent <Int32>]
[-KeepLast]
[-Message <Object>]
[-Right <Object>]
[-Segment <Object[]>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Description

Hint maps key names to their labels. Segment accepts FooterSegment values or hashtables with Text, Link and Role. The footer is a widget and does not read input or start a session.

Examples

Example 1

New-ConsoleFooterBar -Hint ([ordered] @{ Enter = 'Accept'; Esc = 'Cancel' }) | Show-Console

Show navigation hints.

Parameters

-Hint IDictionary optionalposition: 0
An ordered dictionary of key names and action labels.
-Indent Int32 optional
Initial indentation in terminal cells.
-KeepLast SwitchParameter optional
Keeps the last hint when space runs out.
-Message Object optional
A message shown instead of key hints.
-Right Object optional
Text at the right of the footer.
-Segment Object[] optional
FooterSegment objects or Text/Link/Role hashtables.

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.