.gitignore added
[dotfiles/.git] / .config / coc / extensions / node_modules / coc-prettier / node_modules / cli-boxes / readme.md
1 # cli-boxes [![Build Status](https://travis-ci.org/sindresorhus/cli-boxes.svg?branch=master)](https://travis-ci.org/sindresorhus/cli-boxes)
2
3 > Boxes for use in the terminal
4
5 The list of boxes is just a [JSON file](boxes.json) and can be used wherever.
6
7
8 ## Install
9
10 ```
11 $ npm install --save cli-boxes
12 ```
13
14
15 ## Usage
16
17 ```js
18 const cliBoxes = require('cli-boxes');
19
20 console.log(cliBoxes.single);
21 /*
22 {
23     "topLeft": "┌",
24     "topRight": "┐",
25     "bottomRight": "┘",
26     "bottomLeft": "└",
27     "vertical": "│",
28     "horizontal": "─"
29 }
30 */
31 ```
32
33
34 ## API
35
36 ### cliBoxes
37
38 #### `single`
39
40 ```
41 ┌────┐
42 │    │
43 └────┘
44 ```
45
46 #### `double`
47
48 ```
49 ╔════╗
50 ║    ║
51 ╚════╝
52 ```
53
54 #### `round`
55
56 ```
57 ╭────╮
58 │    │
59 ╰────╯
60 ```
61
62 #### `single-double`
63
64 ```
65 ╓────╖
66 ║    ║
67 ╙────╜
68 ```
69
70 #### `double-single`
71
72 ```
73 ╒════╕
74 │    │
75 ╘════╛
76 ```
77
78 #### `classic`
79
80 ```
81 +----+
82 |    |
83 +----+
84 ```
85
86
87 ## Related
88
89 - [boxen](https://github.com/sindresorhus/boxen) - Create boxes in the terminal
90
91
92 ## License
93
94 MIT © [Sindre Sorhus](http://sindresorhus.com)