cli-boxes's Introduction

cli-boxes

Boxes for use in the terminal

The list of boxes is just a JSON file and can be used anywhere.

Install

$ npm install cli-boxes

Usage

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

console.log(cliBoxes.single);
/*
{
	topLeft: '┌',
	top: '─',
	topRight: '┐',
	right: '│',
	bottomRight: '┘',
	bottom: '─',
	bottomLeft: '└',
	left: '│'
}
*/

API

cliBoxes

`single`

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

`double`

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

`round`

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

`bold`

┏━━━━┓
┃    ┃
┗━━━━┛

`singleDouble`

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

`doubleSingle`

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

`classic`

+----+
|    |
+----+

`arrow`

↘↓↓↓↓↙
→    ←
↗↑↑↑↑↖

boxen - Create boxes in the terminal

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}

cli-boxes's People

Contributors

Stargazers

Watchers

cli-boxes's Issues

Add new option for vertical left and right

I would like to create a box which has arrows pointing to the center:

↘↓↓↓↓↓↓↙
→ Box  ←
↗↑↑↑↑↑↑↖

But this is not possible at the moment because there is just one vertical option. I suggest making it optional and add verticalLeft and verticalRight. No breaking change, just an add-on.

Recommend Projects