Bardin08.ProgressBar 1.0.0

dotnet add package Bardin08.ProgressBar --version 1.0.0
NuGet\Install-Package Bardin08.ProgressBar -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Bardin08.ProgressBar" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Bardin08.ProgressBar --version 1.0.0
#r "nuget: Bardin08.ProgressBar, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Bardin08.ProgressBar as a Cake Addin
#addin nuget:?package=Bardin08.ProgressBar&version=1.0.0

// Install Bardin08.ProgressBar as a Cake Tool
#tool nuget:?package=Bardin08.ProgressBar&version=1.0.0

ProgressBar Library

The ProgressBar library provides a simple and customizable progress bar for console applications in C#.

Configuration

The ProgressBarOptions class allows you to configure various aspects of the progress bar:

Option Description
Width Width of the progress bar in characters.
Prefix Prefix to be displayed before the progress bar.
Filler Character used to fill the progress bar.
Arrow Character representing the progress indicator.
Color Color of the progress bar (optional).
DisplayElapsedTime Indicates whether to display elapsed time alongside the progress bar.

Installation

You can install the ProgressBar library via NuGet Package Manager:

Install-Package Bardin08.ProgressBar

Usage

  1. Create ProgressBarOptions:

    var options = new ProgressBarOptions
    {
        Width = 50,
        Prefix = "Progress: ",
        Filler = '=',
        Arrow = '>',
        Color = ConsoleColor.Green,
        DisplayElapsedTime = true
    };
    
  2. Instantiate ProgressBar:

    long totalTicks = 1000;
    var progressBar = new ProgressBar(totalTicks, options);
    
  3. Update Progress:

    Call the Update method to update the progress bar:

    progressBar.Update(10); // Increment progress by 10 ticks
    
  4. Finish:

    Call the Finish method to stop the progress bar and output a newline:

    progressBar.Finish();
    

Example

var options = new ProgressBarOptions
{
   Width = 50,
   Prefix = "Progress: ",
   Filler = '=',
   Arrow = '>',
   Color = ConsoleColor.Green,
   DisplayElapsedTime = true
};

long totalTicks = 1000;
var progressBar = new ProgressBar(totalTicks, options);

for (int i = 0; i < totalTicks; i += 10)
{
   progressBar.Update(10);
   await Task.Delay(100); // Simulate work
}

progressBar.Finish();
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0 223 4/8/2024