Big update!Announcing Socket for GitHub 1.0. Learn more
Socket
BlogLoveFAQ
Install
Log in

boxen

Package Overview
Dependencies
8
Maintainers
1
Versions
35
Issues
File Explorer

Advanced tools

boxen

Create boxes in the terminal

    7.0.0latest

Version published
Maintainers
1
Weekly downloads
14,739,619
decreased by-5.7%

Weekly downloads

Changelog

Source

Breaking

  • Require Node.js 14 c393023

Improvements

  • Add height and fullscreen option (#75) d6b4b32

https://github.com/sindresorhus/boxen/compare/v6.2.1...v7.0.0

Readme

Source

boxen

Create boxes in the terminal

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'
  • 'double'
  • 'round' ('single' sides with round corners)
  • 'bold'
  • 'singleDouble' ('single' on top and bottom, 'double' on right and left)
  • 'doubleSingle' ('double' on top and bottom, 'single' on right and left)
  • 'classic'
+---+ |foo| +---+
  • 'arrow'

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'
/* ┌ example ──────┐ │foo bar foo bar│ └───────────────┘ */
  • 'center'
/* ┌─── example ───┐ │foo bar foo bar│ └───────────────┘ */
  • 'right'
/* ┌────── 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]

Wether 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

  • Sindre Sorhus
  • Caesarovich
  • 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.

Keywords

FAQs

What is boxen?

Create boxes in the terminal

Is boxen popular?

The npm package boxen receives a total of 13,901,446 weekly downloads. As such, boxen popularity was classified as popular.

Is boxen well maintained?

We found that boxen demonstrated a healthy version release cadence and project activity. It has 1 open source maintainer collaborating on the project.

Last updated on 13 Jun 2022
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc