File: readme.md

package info (click to toggle)
node-cli-boxes 1.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster
  • size: 104 kB
  • sloc: makefile: 2; sh: 2
file content (94 lines) | stat: -rw-r--r-- 1,153 bytes parent folder | download | duplicates (2)
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
83
84
85
86
87
88
89
90
91
92
93
94
# cli-boxes [![Build Status](https://travis-ci.org/sindresorhus/cli-boxes.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-boxes)

> Boxes for use in the terminal

The list of boxes is just a [JSON file](boxes.json) and can be used wherever.


## Install

```
$ npm install --save cli-boxes
```


## Usage

```js
const cliBoxes = require('cli-boxes');

console.log(cliBoxes.single);
/*
{
    "topLeft": "┌",
    "topRight": "┐",
    "bottomRight": "┘",
    "bottomLeft": "└",
    "vertical": "│",
    "horizontal": "─"
}
*/
```


## API

### cliBoxes

#### `single`

```
┌────┐
│    │
└────┘
```

#### `double`

```
╔════╗
║    ║
╚════╝
```

#### `round`

```
╭────╮
│    │
╰────╯
```

#### `single-double`

```
╓────╖
║    ║
╙────╜
```

#### `double-single`

```
╒════╕
│    │
╘════╛
```

#### `classic`

```
+----+
|    |
+----+
```


## Related

- [boxen](https://github.com/sindresorhus/boxen) - Create boxes in the terminal


## License

MIT © [Sindre Sorhus](http://sindresorhus.com)