https://github.com/socolin/socolin.ansiterminalcolor

Helpers to generate ANSI escape codes
https://github.com/socolin/socolin.ansiterminalcolor

Last synced: 4 months ago
JSON representation

Helpers to generate ANSI escape codes

• Host: GitHub
• URL: https://github.com/socolin/socolin.ansiterminalcolor
• Owner: Socolin
• Created: 2022-06-10T07:10:39.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-17T03:36:46.000Z (about 3 years ago)
• Last Synced: 2024-12-31T20:16:40.399Z (6 months ago)
• Language: C#
• Size: 32.2 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## ANSITerminalColor

[![Nuget](https://img.shields.io/nuget/v/Socolin.ANSITerminalColor)](https://www.nuget.org/packages/Socolin.ANSITerminalColor)

![License:MIT](https://img.shields.io/badge/license-MIT-green)

Helpers to generate [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)

## License

[MIT](Socolin.ANSITerminalColor/LICENSES.md)

## Disable color

You can disable coloring with `AnsiColor.NoColor = true`

## Examples

Colorize a text before printing it to the console

```csharp

Console.WriteLine(AnsiColor.ColorizeText("Colored Text", AnsiColor.Bold))

Console.WriteLine(AnsiColor.ColorizeText("Colored Text", AnsiColor.Foreground(Terminal256ColorCodes.Aquamarine1C86)))

```

Composite multiple modifiers

![Composite](doc/images/composite.png)

```csharp

Console.WriteLine(AnsiColor.ColorizeText(

    "some-text",

    AnsiColor.Composite(

        AnsiColor.Bold,

        AnsiColor.Underline,

        AnsiColor.Foreground(Terminal256ColorCodes.Gold3C178)

    )));

```

Using RGB Colors

```csharp

Console.WriteLine(AnsiColor.ColorizeText(

    "some-text",

    AnsiColor.Foreground(255, 16, 240)

);

```

Using `Colorize()`

```csharp

Console.WriteLine(AnsiColor.Foreground(45, 150, 240).Colorize("Text"));

```

Use multiple code on the same text

![Superposed](doc/images/superposed.png)

```csharp

var boldBlue = AnsiColor.Composite(

    AnsiColor.Foreground(Terminal256ColorCodes.CadetBlueC73),

    AnsiColor.Bold

);

var orangeBackgroundUnderline = AnsiColor.Composite(

    AnsiColor.Background(Terminal256ColorCodes.Orange4C58),

    AnsiColor.Underline

);

Console.WriteLine(boldBlue.Colorize("Bold Blue " + orangeBackgroundUnderline.Colorize("Orange Underlined") + " Bold Blue"));

Console.WriteLine(orangeBackgroundUnderline.Colorize("Orange Underlined " + boldBlue.Colorize("Bold Blue") + " Orange Underlined"));

```

More escape sequence can be used when using `new AnsiColor(...)`