npm.devtool.tech
๐Ÿ‘ You can access boxen package with using boxen variable in browser devtools!
Create boxes in the terminal

code/package/bundle size

0B
publish
0B
install
0B
bundle minified
0B
bundle gzipped

boxen

Create boxes in the terminal

Install

$ npm install boxen

Usage

const boxen = require('boxen'); console.log(boxen('unicorn', {padding: 1})); /* โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚ โ”‚ โ”‚ unicorn โ”‚ โ”‚ โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */ console.log(boxen('unicorn', {padding: 1, margin: 1, borderStyle: 'double'})); /* โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•— โ•‘ โ•‘ โ•‘ unicorn โ•‘ โ•‘ โ•‘ โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ• */ console.log(boxen('unicorns love rainbows', {title: 'magical', titleAlignment: 'center'})); /* โ”Œโ”€โ”€โ”€โ”€โ”€โ”€ magical โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚unicorns love rainbowsโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */

API

boxen(text, options?)

text

Type: string

Text inside the box.

options

Type: object

borderColor

Type: string
Values: 'black' 'red' 'green' 'yellow' 'blue' 'magenta' 'cyan' 'white' 'gray' or a hex value like '#ff0000'

Color of the box border.

borderStyle

Type: string | object
Default: 'single'
Values:

  • 'single'
โ”Œโ”€โ”€โ”€โ” โ”‚fooโ”‚ โ””โ”€โ”€โ”€โ”˜
  • 'double'
โ•”โ•โ•โ•โ•— โ•‘fooโ•‘ โ•šโ•โ•โ•โ•
  • 'round' ('single' sides with round corners)
โ•ญโ”€โ”€โ”€โ•ฎ โ”‚fooโ”‚ โ•ฐโ”€โ”€โ”€โ•ฏ
  • 'bold'
โ”โ”โ”โ”โ”“ โ”ƒfooโ”ƒ โ”—โ”โ”โ”โ”›
  • 'singleDouble' ('single' on top and bottom, 'double' on right and left)
โ•“โ”€โ”€โ”€โ•– โ•‘fooโ•‘ โ•™โ”€โ”€โ”€โ•œ
  • 'doubleSingle' ('double' on top and bottom, 'single' on 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: '|' }
dimBorder

Type: boolean
Default: false

Reduce opacity of the border.

title

Type: string

Display a title at the top of the box. If needed, the box will horizontally expand to fit the title.

Example:

console.log(boxen('foo bar', {title: 'example'})); /* โ”Œ example โ” โ”‚foo bar โ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
titleAlignment

Type: string
Default: 'left'

Align the title in the top bar.

Values:

  • 'left'
/* โ”Œ example โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚foo bar foo barโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
  • 'center'
/* โ”Œโ”€โ”€โ”€ example โ”€โ”€โ”€โ” โ”‚foo bar foo barโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
  • 'right'
/* โ”Œโ”€โ”€โ”€โ”€โ”€โ”€ example โ” โ”‚foo bar foo barโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
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

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.

float

Type: string
Default: 'left'
Values: 'right' 'center' 'left'

Float the box on the available terminal screen space.

backgroundColor

Type: string
Values: 'black' 'red' 'green' 'yellow' 'blue' 'magenta' 'cyan' 'white' 'gray' or a hex value like '#ff0000'

Color of the background.

textAlignment

Type: string
Default: 'left'
Values: 'left' 'center' 'right'

Align the text in the box based on the widest line.

Related

  • boxen-cli - CLI for this module
  • cli-boxes - Boxes for use in the terminal
  • ink-box - Box component for Ink that uses this package

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.
๐Ÿ”ŽExplore Package๐Ÿ”ŽCDN Script

Score

Popularity65/100
Quality78/100
Maintenance100/100