Skip to content
ConsoleMonster

API Reference

Class

SpinnerFluent

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

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

Inheritance

  • Object
  • SpinnerFluent

Methods

public static Spinner WithDetail(Spinner spinner, String? value) #
Returns: Spinner

Sets Spinner.Detail: Muted detail shown after the label, for example the current item.

Parameters

spinner ConsoleMonster.Widgets.Spinner requiredposition: 0
The instance.
value System.String? requiredposition: 1
The value.

Returns

The same instance.

public static Spinner WithFinished(Spinner spinner, TimeSpan? value) #
Returns: Spinner

Sets Spinner.Finished: When the spinner finished on the session clock, or null while running.

Parameters

spinner ConsoleMonster.Widgets.Spinner requiredposition: 0
The instance.
value System.TimeSpan? requiredposition: 1
The value.

Returns

The same instance.

public static Spinner WithLabel(Spinner spinner, String value) #
Returns: Spinner

Sets Spinner.Label: The label (markup).

Parameters

spinner ConsoleMonster.Widgets.Spinner requiredposition: 0
The instance.
value System.String requiredposition: 1
The value.

Returns

The same instance.

public static Spinner WithShowElapsed(Spinner spinner, Boolean value = true) #
Returns: Spinner

Sets Spinner.ShowElapsed: Whether the elapsed time is shown on the right (default true).

Parameters

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

Returns

The same instance.

public static Spinner WithStarted(Spinner spinner, TimeSpan? value) #
Returns: Spinner

Sets Spinner.Started: When the current run started on the session clock, or null for "when the session started". Set by the start operation and by the first running state event.

Parameters

spinner ConsoleMonster.Widgets.Spinner requiredposition: 0
The instance.
value System.TimeSpan? requiredposition: 1
The value.

Returns

The same instance.

public static Spinner WithStatus(Spinner spinner, StatusKind value) #
Returns: Spinner

Sets Spinner.Status: The status; anything other than Running or Pending replaces the animation with the status marker.

Parameters

spinner ConsoleMonster.Widgets.Spinner requiredposition: 0
The instance.
value ConsoleMonster.Styling.StatusKind requiredposition: 1
The value.

Returns

The same instance.