mirror of
https://github.com/nsnail/spectre.console.git
synced 2025-04-19 02:12:49 +08:00
c2da268129
* Adding a dark mode * Adding reference for types to summary pages * Adding API Reference * Adding modifiers to methods/fields/etc * Minimizing files input * Caching a lot of the output pages * Cache only for each execution * Adding API references to existing docs
94 lines
2.6 KiB
Markdown
94 lines
2.6 KiB
Markdown
Title: Progress
|
|
Order: 5
|
|
RedirectFrom: progress
|
|
Description: "*Spectre.Console* can display information about long running tasks in the console using progress bars."
|
|
Highlights:
|
|
- Custom styling of progress bars.
|
|
- Multiple predefined columns such as Throughput, Estimated Time Remaining, and more.
|
|
- Fallback for non-interactive consoles such as CI runners.
|
|
Reference:
|
|
- T:Spectre.Console.Progress
|
|
- M:Spectre.Console.AnsiConsole.Progress
|
|
---
|
|
|
|
Spectre.Console can display information about long running tasks in the console.
|
|
|
|
<?# AsciiCast cast="progress" /?>
|
|
|
|
<?# Alert ?>
|
|
The progress display is not
|
|
thread safe, and using it together with other interactive components such as
|
|
prompts, status displays or other progress displays are not supported.
|
|
<?#/ Alert ?>
|
|
|
|
If the current terminal isn't considered "interactive", such as when running
|
|
in a continuous integration system, or the terminal can't display
|
|
ANSI control sequence, any progress will be displayed in a simpler way.
|
|
|
|
<?# AsciiCast cast="progress" profile="non-interactive" /?>
|
|
|
|
## Usage
|
|
|
|
```csharp
|
|
// Synchronous
|
|
AnsiConsole.Progress()
|
|
.Start(ctx =>
|
|
{
|
|
// Define tasks
|
|
var task1 = ctx.AddTask("[green]Reticulating splines[/]");
|
|
var task2 = ctx.AddTask("[green]Folding space[/]");
|
|
|
|
while(!ctx.IsFinished)
|
|
{
|
|
task1.Increment(1.5);
|
|
task2.Increment(0.5);
|
|
}
|
|
});
|
|
```
|
|
|
|
## Asynchronous progress
|
|
|
|
If you prefer to use async/await, you can use `StartAsync` instead of `Start`.
|
|
|
|
```csharp
|
|
// Asynchronous
|
|
await AnsiConsole.Progress()
|
|
.StartAsync(async ctx =>
|
|
{
|
|
// Define tasks
|
|
var task1 = ctx.AddTask("[green]Reticulating splines[/]");
|
|
var task2 = ctx.AddTask("[green]Folding space[/]");
|
|
|
|
while (!ctx.IsFinished)
|
|
{
|
|
// Simulate some work
|
|
await Task.Delay(250);
|
|
|
|
// Increment
|
|
task1.Increment(1.5);
|
|
task2.Increment(0.5);
|
|
}
|
|
});
|
|
```
|
|
|
|
## Configure
|
|
|
|
```csharp
|
|
AnsiConsole.Progress()
|
|
.AutoRefresh(false) // Turn off auto refresh
|
|
.AutoClear(false) // Do not remove the task list when done
|
|
.HideCompleted(false) // Hide tasks as they are completed
|
|
.Columns(new ProgressColumn[]
|
|
{
|
|
new TaskDescriptionColumn(), // Task description
|
|
new ProgressBarColumn(), // Progress bar
|
|
new PercentageColumn(), // Percentage
|
|
new RemainingTimeColumn(), // Remaining time
|
|
new SpinnerColumn(), // Spinner
|
|
})
|
|
.Start(ctx =>
|
|
{
|
|
// Omitted
|
|
});
|
|
```
|