Administrator / new_rukzachok-1

Name	Last Update	Last Commit d7f4f4bf – ga History
..
node_modules/object-assign	Loading commit data...
border-characters.js	Loading commit data...
index.js	Loading commit data...
license	Loading commit data...
package.json	Loading commit data...
readme.md	Loading commit data...

readme.md

Create boxes in the terminal

Install

$ npm install --save boxen

Usage

const boxen = require('boxen');

console.log(boxen('unicorn', {padding: 1}));
/*
┌─────────────┐
│             │
│   unicorn   │
│             │
└─────────────┘
*/

console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'}));
/*

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

*/

API

boxen(input, [options])

input

Type: string

Text inside the box.

options

borderColor

Type: string Values: black red green yellow blue magenta cyan white gray

Color of the box border.

borderStyle

Type: string object Default: single Values:

single ┌───┐ │foo│ └───┘
double ╔═══╗ ║foo║ ╚═══╝
round (single sides with round corners) ╭───╮ │foo│ ╰───╯
single-double (single on top and bottom, double on right and left) ╓───╖ ║foo║ ╙───╜
double-single (double on top and bottom, single on right and left) ╒═══╕ │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: '|'
}

padding

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.

margin