Skip to content
ConsoleMonster

API Reference

Class

DashboardFluent

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

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

Inheritance

  • Object
  • DashboardFluent

Methods

public static Dashboard AddFooterHint(Dashboard dashboard, KeyHint item) #
Returns: Dashboard

Adds an item to Dashboard.FooterHints: The key hints in the footer when Dashboard.Footer is not set (default: ctrl+c stop).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
item ConsoleMonster.Widgets.KeyHint requiredposition: 1
The item.

Returns

The same instance.

AddFooterHints 2 overloads
public static Dashboard AddFooterHints(Dashboard dashboard, params KeyHint[] items) #
Returns: Dashboard

Adds items to Dashboard.FooterHints: The key hints in the footer when Dashboard.Footer is not set (default: ctrl+c stop).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
items ConsoleMonster.Widgets.KeyHint[] requiredposition: 1
The items, in order.

Returns

The same instance.

public static Dashboard AddFooterHints(Dashboard dashboard, IEnumerable<KeyHint> items) #
Returns: Dashboard

Adds items to Dashboard.FooterHints: The key hints in the footer when Dashboard.Footer is not set (default: ctrl+c stop).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
items System.Collections.Generic.IEnumerable<ConsoleMonster.Widgets.KeyHint> requiredposition: 1
The items, in order.

Returns

The same instance.

public static Dashboard WithCompactSummary(Dashboard dashboard, Func<String>? value) #
Returns: Dashboard

Sets Dashboard.CompactSummary: The progress text for the compact status line (for example 218/332 · ✗12 ▲25), or null to use Dashboard.Status. Called on the render thread.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value System.Func<System.String>? requiredposition: 1
The value.

Returns

The same instance.

public static Dashboard WithFooter(Dashboard dashboard, String? value) #
Returns: Dashboard

Sets Dashboard.Footer: The footer text (markup), or null for no footer.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Dashboard WithMinimumSize(Dashboard dashboard, Size value) #
Returns: Dashboard

Sets Dashboard.MinimumSize: The smallest window the full layout needs (default 60 × 14). Below it a live session renders the compact form: a one-line status and the highest-priority Prioritized widgets that fit.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value ConsoleMonster.Layout.Size requiredposition: 1
The value.

Returns

The same instance.

public static Dashboard WithShowClock(Dashboard dashboard, Boolean value = true) #
Returns: Dashboard

Sets Dashboard.ShowClock: Whether the elapsed clock is shown in the header (default true).

Parameters

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

Returns

The same instance.

public static Dashboard WithStatus(Dashboard dashboard, String? value) #
Returns: Dashboard

Sets Dashboard.Status: A status shown on the right of the header (markup).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Dashboard WithStatusLevel(Dashboard dashboard, StatusKind? value) #
Returns: Dashboard

Sets Dashboard.StatusLevel: The status kind, shown as a marker before Dashboard.Status.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value ConsoleMonster.Styling.StatusKind? requiredposition: 1
The value.

Returns

The same instance.

public static Dashboard WithSubtitle(Dashboard dashboard, String? value) #
Returns: Dashboard

Sets Dashboard.Subtitle: The subtitle (markup), shown after the title.

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Dashboard WithTitle(Dashboard dashboard, String value) #
Returns: Dashboard

Sets Dashboard.Title: The title (markup).

Parameters

dashboard ConsoleMonster.Widgets.Dashboard requiredposition: 0
The instance.
value System.String requiredposition: 1
The value.

Returns

The same instance.