Spectre.Console

SpinnerColumn

A column showing a spinner.

A column showing a spinner.

Constructors

public SpinnerColumn()

Initializes a new instance of the SpinnerColumn class.

public SpinnerColumn(Spinner spinner)

Initializes a new instance of the SpinnerColumn class.

Parameters:

spinner (Spinner)
The spinner to use.

Properties

CompletedText : string

Gets or sets the text that should be shown instead of the spinner once a task completes.

PendingText : string

Gets or sets the text that should be shown instead of the spinner before a task begins.

Spinner : Spinner

Gets or sets the Spinner.

Methods

public int? GetColumnWidth(RenderOptions options)

Gets the width of the column.

Parameters:

options (RenderOptions)
The render options.

Returns:

The width of the column, or null to calculate.

public IRenderable Render(RenderOptions options, ProgressTask task, TimeSpan deltaTime)

Gets a renderable representing the column.

Parameters:

options (RenderOptions)
The render options.
task (ProgressTask)
The task.
deltaTime (TimeSpan)
The elapsed time since last call.

Returns:

A renderable representing the column.