ransi 1.1.0

ransi - Utility for ANSI escape codes
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

# ransi - Rust ANSI

## Table of Contents

- [About](#about)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Examples](#examples)
- [License](#license)
- [Contributing](#contributing)
- [Notes](#notes)

## About

`ransi` is a simple Rust library to help you make TUIs without going through
the pain of ANSI escape codes.

`ransi` provides a simple and easy-to-use API that allows you
to format, color, and style text on the terminal.

## Features

- Works in almost all terminals
- Supports every ANSI escape code <sup><a href="#supports-every-ansi-escape-code">1</a></sup>
- True color support
- 256 color support
- 16 color support
- No dependencies
- Lightweight
- Easy to use

## Installation

Run this command to install the latest version of `ransi`:

```bash
cargo add ransi
```

Or add it to your `Cargo.toml` file:

```toml
[dependencies]
ransi = "0.1"
```

## Usage

### Functions

---

| Function                                          | Description                          |
|---------------------------------------------------|--------------------------------------|
| `change_fg(color: &str or (r: u8, g: u8, b: u8))` | Change the foreground color          |
| `change_bg(color: &str or (r: u8, g: u8, b: u8))` | Change the background color          |
| `bold(string: &str)`                              | Make the string be bold if printed   |
| `italic(string: &str)`                            | Make the string be italic if printed |
| `blink(string: &str)`                             | Make the string blink if printed     |
| `mov_cur(x: u16, y: u16)`                         | Move the cursor to a position        |
| `

---

### Traits

- `ransi::ColorIn` - Color Input. Used by the `change_col` function to support
or a tuple of three `u8`s or the color name.

## Notes

##### Supports every ANSI escape code

This isn't *completely true*, as it misses the 21m escape code,
which almost always leads to undefined behavior in different terminals.

Originally, 21m was used to dim text, but no terminal supports it,
and the ones that do, double-underline the text
and make it bright. Others keep the default behavour

It is pretty confusing, so we don't support it.