Skip to content
ConsoleMonster

API Reference

Class

HeaderBarFluent

Namespace ConsoleMonster.Widgets
Assembly ConsoleMonster
Modifiers static
Attributes
GeneratedCode("ConsoleMonster.Generators", "1.0.0")

The fluent methods of HeaderBar, generated from its public properties: With... sets a property and Add... adds to a collection, both returning the same instance.

Inheritance

  • Object
  • HeaderBarFluent

Methods

public static HeaderBar AddCrumb(HeaderBar headerBar, String item) #
Returns: HeaderBar

Adds an item to HeaderBar.Crumbs: Breadcrumb steps after the title, plain text ("Tasks", "Review & run").

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
item System.String requiredposition: 1
The item.

Returns

The same instance.

AddCrumbs 2 overloads
public static HeaderBar AddCrumbs(HeaderBar headerBar, params String[] items) #
Returns: HeaderBar

Adds items to HeaderBar.Crumbs: Breadcrumb steps after the title, plain text ("Tasks", "Review & run").

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
items System.String[] requiredposition: 1
The items, in order.

Returns

The same instance.

public static HeaderBar AddCrumbs(HeaderBar headerBar, IEnumerable<String> items) #
Returns: HeaderBar

Adds items to HeaderBar.Crumbs: Breadcrumb steps after the title, plain text ("Tasks", "Review & run").

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
items System.Collections.Generic.IEnumerable<System.String> requiredposition: 1
The items, in order.

Returns

The same instance.

public static HeaderBar WithClock(HeaderBar headerBar, TimeSpan? value) #
Returns: HeaderBar

Sets HeaderBar.Clock: The clock value; null uses the render context's elapsed time.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value System.TimeSpan? requiredposition: 1
The value.

Returns

The same instance.

public static HeaderBar WithRight(HeaderBar headerBar, String? value) #
Returns: HeaderBar

Sets HeaderBar.Right: Plain text on the right, before the clock (an app's subtitle, a step count).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HeaderBar WithShowClock(HeaderBar headerBar, Boolean value = true) #
Returns: HeaderBar

Sets HeaderBar.ShowClock: Shows the elapsed clock on the right.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value System.Boolean = true optionalposition: 1
The value (default true).

Returns

The same instance.

public static HeaderBar WithStatus(HeaderBar headerBar, String? value) #
Returns: HeaderBar

Sets HeaderBar.Status: Status text on the right (markup).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HeaderBar WithStatusLevel(HeaderBar headerBar, StatusKind? value) #
Returns: HeaderBar

Sets HeaderBar.StatusLevel: The status kind; its marker goes before the status text.

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value ConsoleMonster.Styling.StatusKind? requiredposition: 1
The value.

Returns

The same instance.

public static HeaderBar WithSubtitle(HeaderBar headerBar, String? value) #
Returns: HeaderBar

Sets HeaderBar.Subtitle: A subtitle after the title, separated by a dot (markup).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static HeaderBar WithTitle(HeaderBar headerBar, String value) #
Returns: HeaderBar

Sets HeaderBar.Title: The title (markup).

Parameters

headerBar ConsoleMonster.Widgets.HeaderBar requiredposition: 0
The instance.
value System.String requiredposition: 1
The value.

Returns

The same instance.