Popularity
5.3
Growing
Activity
4.6
Declining
1,242
10
65

Code Quality Rank: L3
Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: Ascii     Text     Command Line Utilities     Unicode     Console     Term     Terminal     CLI     Border     Boxes     Box    
Latest version: v4.2.0

boxen alternatives and similar modules

Based on the "Command Line Utilities" category.
Alternatively, view boxen alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of boxen or a related project?

Add another 'Command Line Utilities' Module

README

boxen

Create boxes in the terminal

[](screenshot.png)

Install

npm install boxen

Usage

import boxen from '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| +---+
  • 'arrow' โ†˜โ†“โ†“โ†“โ†™ โ†’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: '+',
    top: '-',
    bottom: '-',
    left: '|',
    right: '|'
}
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' js /* โ”Œ example โ”€โ”€โ”€โ”€โ”€โ”€โ” โ”‚foo bar foo barโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
  • 'center' js /* โ”Œโ”€โ”€โ”€ example โ”€โ”€โ”€โ” โ”‚foo bar foo barโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
  • 'right' js /* โ”Œโ”€โ”€โ”€โ”€โ”€โ”€ example โ” โ”‚foo bar foo barโ”‚ โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜ */
width

Type: number

Set a fixed width for the box.

Note: This disables terminal overflow handling and may cause the box to look broken if the user's terminal is not wide enough.

import boxen from 'boxen';

console.log(boxen('foo bar', {width: 15}));
// โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
// โ”‚foo bar      โ”‚
// โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
height

Type: number

Set a fixed height for the box.

Note: This option will crop overflowing content.

import boxen from 'boxen';

console.log(boxen('foo bar', {height: 5}));
// โ”Œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”
// โ”‚foo barโ”‚
// โ”‚       โ”‚
// โ”‚       โ”‚
// โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
fullscreen

Type: boolean | (width: number, height: number) => [width: number, height: number]

Whether or not to fit all available space within the terminal.

Pass a callback function to control box dimensions:

import boxen from 'boxen';

console.log(boxen('foo bar', {
    fullscreen: (width, height) => [width, height - 1],
}));
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.

Maintainer

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 companiesassurances about security, maintenance, and licensing for their dependencies.