https://github.com/raphamorim/go-rainbow

Golang Helper for beautiful CLI Applications
https://github.com/raphamorim/go-rainbow

cli colorization colors golang hex int32 rainbow rgb rgba xterm xterm256

Last synced: 2 days ago
JSON representation

Golang Helper for beautiful CLI Applications

• Host: GitHub
• URL: https://github.com/raphamorim/go-rainbow
• Owner: raphamorim
• License: mit
• Created: 2017-08-02T05:28:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-07T21:36:16.000Z (about 7 years ago)
• Last Synced: 2024-10-23T17:19:11.130Z (11 days ago)
• Topics: cli, colorization, colors, golang, hex, int32, rainbow, rgb, rgba, xterm, xterm256
• Language: Go
• Homepage:
• Size: 170 KB
• Stars: 89
• Watchers: 6
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# go-rainbow [![Build Status](https://img.shields.io/travis/raphamorim/go-rainbow.svg?style=flat-square)](https://travis-ci.org/raphamorim/go-rainbow)

Extremely inspired by [chalk.js](https://github.com/chalk/chalk)

`go-rainbow` allows you to:

- Iterate modifiers and colors on a String.

- Use HEX as you wish.

- Use from Int as you wish.

- Use RGB as you wish (work in progress).

- Bring magical Rainbow on a String (work in progress).

![Sample](assets/sample.png)

## Available animations

|   Name    |                   Preview                  |

|:---------:|:------------------------------------------:|

|  rainbow  | on going... |

|   pulse   | on going... |

|   glitch  | on going... |

|   radar   | on going... |

|    neon   | ![rainbow](http://i.imgur.com/Hl98alo.gif) |

# Summary

- [Install](#install)

- [Example](#example)

- [Hex](#hex)

- [FromInt32](#fromint32)

- [Iterables](#iterables)

- [Modifiers](#modifiers)

    - `Bold`

    - `Dim`

    - `Italic`

    - `Underline`

    - `Reverse`

    - `Hidden`

- [Colors](#colors)

    - `Black`

    - `Red`

    - `Green`

    - `Yellow`

    - `Blue`

    - `Magenta`

    - `Cyan`

    - `White`

    - `RedBright`

    - `GreenBright`

    - `YellowBright`

    - `BlueBright`

    - `MagentaBright`

    - `CyanBright`

    - `WhiteBright`

- [Background Colors](#background-colors)

    - `BgBlack`

    - `BgRed`

    - `BgGreen`

    - `BgYellow`

    - `BgBlue`

    - `BgMagenta`

    - `BgCyan`

    - `BgWhite`

    - `BgBlackBright`

    - `BgRedBright`

    - `BgGreenBright`

    - `BgYellowBright`

    - `BgBlueBright`

    - `BgMagentaBright`

    - `BgCyanBright`

    - `BgWhiteBright`

- [Animations](#animations)

    - `Neon`

## Install

```bash

go get github.com/raphamorim/go-rainbow

```

## Example

**main.go**

```go

package main

import (

    "fmt"

    "github.com/raphamorim/go-rainbow"

)

func main() {

    fmt.Println(rainbow.Bold(rainbow.Hex("#8E44AD", "raphael")))

}

```

![go-main-example](assets/go-main-example.png)

## Hex

```go

ftm.Printf("%s", rainbow.Hex("#000080", "String from HEX")) // should be index 4 (navy blue)

```

## FromInt32

32-bit unsigned integer equivalent (`uint32`)

```go

fmt.Printf("%s", rainbow.FromInt32(0xCC66FFFF, "String from Int32"))

```

## Modifiers

### Usage

```go

rainbow.Bold("String in Bold")

```

- `Bold`

- `Dim`

- `Italic (Not widely supported)`

- `Underline`

- `Reverse`

- `Hidden`

- `Strikethrough (Not widely supported)`

## Colors

### Usage

```go

rainbow.Blue("String in Blue")

```

### List

- `Black`

- `Red`

- `Green`

- `Yellow`

- `Blue`

- `Magenta`

- `Cyan`

- `White`

- `RedBright`

- `GreenBright`

- `YellowBright`

- `BlueBright`

- `MagentaBright`

- `CyanBright`

- `WhiteBright`

#### Soon (send a PR to help us!):

- `Gray`

## Background Colors

```go

rainbow.BgBlue("String in Blue Background")

```

### List

- `BgBlack`

- `BgRed`

- `BgGreen`

- `BgYellow`

- `BgBlue`

- `BgMagenta`

- `BgCyan`

- `BgWhite`

- `BgBlackBright`

- `BgRedBright`

- `BgGreenBright`

- `BgYellowBright`

- `BgBlueBright`

- `BgMagentaBright`

- `BgCyanBright`

- `BgWhiteBright`

## Iterables

```go

abc := Bold(BgYellow(Blue("Bold+BgYellow+Blue")))

xyz := Dim(Underscore("Dim+Underscore"))

```

## Animations

Animations have a different behavior of all methods, they realize the act of print, instead of only returning `string`.

### Neon

**code**

```go

rainbow.Animation("AWESOME NEON ANIMATION", "neon")

```

**sample**

![rainbow](http://i.imgur.com/ZXMBJoB.gif)

## RGB (working on it)

```go

rainbow.RGB(100, 110, 100)

```

## License

The MIT License (MIT) - see [`LICENSE.md`](https://github.com/raphamorim/go-rainbow/blob/master/LICENSE.md) for more details