You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

95 lines
1.1 KiB
Markdown

5 years ago
# 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)