Create boxes in the terminal
$ npm install boxen
const boxen = require('boxen');
console.log(boxen('unicorn', {padding: 1}));
/*
┌─────────────┐
│ │
│ unicorn │
│ │
└─────────────┘
*/
console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
/*
╔═════════════╗
║ ║
║ unicorn ║
║ ║
╚═════════════╝
*/Type: string
Text inside the box.
Type: string
Values: black red green yellow blue magenta cyan white gray
Color of the box border.
Type: string object
Default: single
Values:
single
┌───┐
│foo│
└───┘
double
╔═══╗
║foo║
╚═══╝
round(singlesides with round corners)
╭───╮
│foo│
╰───╯
single-double(singleon top and bottom,doubleon right and left)
╓───╖
║foo║
╙───╜
double-single(doubleon top and bottom,singleon right and left)
╒═══╕
│foo│
╘═══╛
classic
+---+
|foo|
+---+
Style of the box border.
Can be any of the above predefined styles or an object with the following keys:
{
topLeft: '+',
topRight: '+',
bottomLeft: '+',
bottomRight: '+',
horizontal: '-',
vertical: '|'
}Type: boolean
Default: false
Reduce opacity of the border.
Type: number Object
Default: 0
Space between the text and box border.
Accepts a number or an object with any of the top, right, bottom, left properties. When a number is specified, the left/right padding is 3 times the top/bottom to make it look nice.
Type: number Object
Default: 0
Space around the box.
Accepts a number or an object with any of the top, right, bottom, left properties. When a number is specified, the left/right margin is 3 times the top/bottom to make it look nice.
Type: string
Values: right center left
Default: left
Float the box on the available terminal screen space.
Type: string
Values: black red green yellow blue magenta cyan white
Color of the background.
Type: string
Default: left
Values: left center right
Align the text in the box based on the widest line.
MIT © Sindre Sorhus