StatusIcons 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package StatusIcons --version 1.0.0                

                    
                

            
NuGet\Install-Package StatusIcons -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="StatusIcons" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add StatusIcons --version 1.0.0                

                    
                

            
#r "nuget: StatusIcons, 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 StatusIcons as a Cake Addin
#addin nuget:?package=StatusIcons&version=1.0.0

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

<img src="https://github.com/jchristn/StatusIcons/blob/main/Assets/icon.png?raw=true" height="48">

StatusIcons

NuGet Version NuGet

Simple C# class library for adding Unicode status icons to console applications, or falling back to ASCII if the terminal doesn't support Unicode.

Help or Feedback

First things first - do you need help or have feedback? File an issue here! We'd love to hear from you.

Have an idea for amending the default set of icons? Let us know!

New in v1.0.x

  • Initial release

It's Really Easy... I Mean, REALLY Easy

Usage

Refer to the Test project for full usage details. If Unicode is supported in your terminal, retrieving an icon via StatusIcon["name"] will return the Unicode icon, and if not, it will return the ASCII variant.

using StatusIcons;

// Display an icon
StatusIcon icon = new StatusIcon();
Console.WriteLine("Success: " + icon["Success"]);

// Test your terminal for Unicode support
icon.TestTerminal();

// Add and use an icon
icon["Speaker"] = "🔊";  // add to whichever dictionary is in use
icon.AsciiIcons["Speaker"] = ":(";  // add only to the ASCII icon dictionary
icon.UnicodeIcons["Speaker"] = "🔊";  // add only to the Unicode icon dictionary
Console.WriteLine("Icon 'Speaker' : " + icon["Speaker"]);

Default Icons

The following icons are added by default.

Key Unicode ASCII
Success ✓ +
Error ✗ X
Warning âš  !
Info ℹ i
Working ⋯ .
Bullet • *
Arrow → >

Version History

Please refer to CHANGELOG.md.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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 is compatible.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net6.0

    • No dependencies.

  • net7.0

    • No dependencies.

  • net8.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 84 10/31/2024

Initial release