DotSpinners 2.0.1
dotnet add package DotSpinners --version 2.0.1
NuGet\Install-Package DotSpinners -Version 2.0.1
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="DotSpinners" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DotSpinners" Version="2.0.1" />
<PackageReference Include="DotSpinners" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add DotSpinners --version 2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DotSpinners, 2.0.1"
#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.
#:package DotSpinners@2.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=DotSpinners&version=2.0.1
#tool nuget:?package=DotSpinners&version=2.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
<img src="https://raw.githubusercontent.com/kleinrein/dot-spinners/master/DotSpinners.Resources/DotSpinners.png" width="150">
Dot Spinners
Console spinners for .NET — 71 spinners, fluent API, async support, color and label support.
<img src="https://github.com/kleinrein/dot-spinners/blob/master/DotSpinners.Resources/DotSpinners.gif" width="600">
Install
Install-Package DotSpinners
Quick start
// Spin while an async task runs (recommended)
await new DotSpinner(SpinnerTypes.Braille)
.Label("Loading...")
.Color(ConsoleColor.Cyan)
.RunAsync(async () => await DoWorkAsync());
// Spin for a fixed time
new DotSpinner(SpinnerTypes.Dots).Time(3).Start();
// Spin until a Task completes (legacy / synchronous)
new DotSpinner(SpinnerTypes.Classic, DoWorkAsync()).Start();
// Random spinner, centered
new DotSpinner().Center().Time(2).Start();
API
All methods return DotSpinner for chaining.
| Method | Description |
|---|---|
Time(int seconds) |
Run for N seconds (no-op when a task is provided) |
Interval(int ms) |
Override the spinner's default frame delay |
Label(string text) |
Show a text label to the right of the spinner |
Color(ConsoleColor) |
Set the spinner frame color |
LabelColor(ConsoleColor) |
Set the label text color |
Center() |
Center the spinner horizontally |
Random() |
Switch to a random spinner type |
Start() |
Start spinning (blocking) |
Stop() |
Stop the spinner |
StartAsync(CancellationToken) |
Start spinning asynchronously |
RunAsync(Func<Task>) |
Run work and spin until it completes, then stop |
RunAsync<T>(Func<Task<T>>) |
Same as above, returns the work result |
Spinner types
71 spinners across these categories:
| Category | Examples |
|---|---|
| Classic | Classic, Classic2, Spin |
| Dots | Dots, Dots2, Dots3, DotsScrolling, DotsRolling, DotsSimple, DotsShifter |
| Braille | Braille, BrailleDots |
| Bouncing | Bounce, BouncingBar, BouncingBall, Ball, Pong, Shark, Ping, Sand |
| Geometric | Arc, CircleHalves, Triangle, Box, GrowHorizontal, GrowVertical, LayerUp, Aesthetic, Noise |
| Arrows | Arrow, Arrow2, Arrow3 |
| Toggles | Toggle, Toggle2, Toggle3, Toggle4, Toggle5 |
| Symbols | Stars, Stars2, Star, Brackets, Pulse, HashFest, Matrix, Cross, Pipe, Hamburger |
| Text | Loading, Unspecified |
| Progress | Flag, Bar, PercentageFive, RugCrawler |
| Clock & Emoji | Clock, Moon, Earth, Weather, Christmas, Mindblown, Speaker, OrangePulse, BluePulse |
| Fun | HappyBeast, Eyes, Ooh, Balloon, Flippie |
| Currency | Money |
| Misc | Plus, Crocodiles |
Full frame data: DotSpinners/spinners.txt
License
| Product | Versions 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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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 (1)
Showing the top 1 popular GitHub repositories that depend on DotSpinners:
| Repository | Stars |
|---|---|
|
Azure-Samples/cognitive-services-dotnet-sdk-samples
Learn how to use the Cognitive Services SDKs with these samples
|
Release 2.0.1 - Fixed package metadata and added README