boxen
Advanced tools
Package description
The boxen npm package is used to create boxes in the terminal for displaying messages. It is useful for CLI applications where you want to highlight information or separate it visually from other output.
Creating a simple message box
This feature allows you to create a simple box around a message with padding inside the box. The padding option adds an empty space between the text and the box border.
const boxen = require('boxen');
console.log(boxen('Hello, world!', {padding: 1}));Customizing box style
Boxen allows you to customize the style of the box with various options such as border style and color. This can help make the box stand out or fit a certain theme.
const boxen = require('boxen');
console.log(boxen('Custom box style', {borderStyle: 'double', borderColor: 'blue', padding: 1}));Aligning text within the box
You can align the text inside the box to the left, right, or center. This feature is useful for formatting the message in a visually appealing way.
const boxen = require('boxen');
console.log(boxen('Centered text', {textAlignment: 'center', padding: 1}));Chalk-box is similar to boxen in that it allows you to create boxes in the terminal. However, it is more focused on integrating with the chalk library for coloring text and does not offer as many box customization options as boxen.
CLI-box is another package that lets you create boxes in the command line interface. It offers a different API and additional features like built-in text wrapping, but it might not be as straightforward to use as boxen for simple box creation.
Terminal-kit is a full-featured terminal handling library that includes the ability to create boxes. It is more complex and offers a wider range of terminal manipulation features compared to boxen, which is more specialized and easier to use for just creating boxes.
Readme
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 (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│
╘═══╛
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
FAQs
Create boxes in the terminal
We found that boxen demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.
Security News
Socket is joining forces with CISA and other industry leaders at the RSA Conference to sign the Secure by Design pledge, committing to uphold the highest security standards in our products.
Research
The Socket research team breaks down a sampling of malicious packages that download and execute files, among other suspicious behaviors, targeting the popular Discord platform.