cli-boxes

What is cli-boxes?

The cli-boxes package provides a collection of predefined box styles for use in command-line interfaces. It allows developers to easily add boxes around text in the terminal for improved readability and aesthetic appeal.

What are cli-boxes's main functionalities?

Predefined box styles

cli-boxes comes with a set of predefined box styles that can be used to wrap around text. The above code sample logs the 'single' box style to the console.

const cliBoxes = require('cli-boxes');
console.log(cliBoxes.single);

Customizable boxes

Developers can use the predefined box styles to create customizable boxes around their text. The code sample demonstrates how to create a box with padding around the text 'Hello, World!'.

const cliBoxes = require('cli-boxes');
const box = cliBoxes.single;
const text = 'Hello, World!';
const padding = 1;
const lines = text.split('\n');
const maxLength = Math.max(...lines.map(line => line.length));
const top = box.topLeft + box.horizontal.repeat(maxLength + padding * 2) + box.topRight;
const bottom = box.bottomLeft + box.horizontal.repeat(maxLength + padding * 2) + box.bottomRight;
const side = box.vertical;
console.log(top);
lines.forEach(line => {
  const paddingLeft = ' '.repeat(padding);
  const paddingRight = ' '.repeat(maxLength - line.length + padding);
  console.log(side + paddingLeft + line + paddingRight + side);
});
console.log(bottom);

Other packages similar to cli-boxes

boxen

Boxen is a similar package that allows for creating boxes in the terminal. It offers more customization options such as padding, margin, border style, and text alignment compared to cli-boxes, which primarily provides predefined box styles.

terminal-kit

Terminal-kit is a full-featured terminal handling library that includes the ability to create boxes. It is more comprehensive than cli-boxes, providing a wide range of terminal manipulation features beyond just boxes.

drawille

Drawille is a unique package that uses Braille characters to draw in the terminal, allowing for creating boxes and other shapes with fine-grained detail. It differs from cli-boxes by focusing on drawing capabilities rather than just box styles.

README

cli-boxes

Boxes for use in the terminal

The list of boxes is just a JSON file and can be used anywhere.

Install

npm install cli-boxes

Usage

import cliBoxes from 'cli-boxes';

console.log(cliBoxes.single);
/*
{
	topLeft: '┌',
	top: '─',
	topRight: '┐',
	right: '│',
	bottomRight: '┘',
	bottom: '─',
	bottomLeft: '└',
	left: '│'
}
*/

API

cliBoxes

single

┌────┐
│    │
└────┘

double

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

round

╭────╮
│    │
╰────╯

bold

┏━━━━┓
┃    ┃
┗━━━━┛

singleDouble

╓────╖
║    ║
╙────╜

doubleSingle

╒════╕
│    │
╘════╛

classic

+----+
|    |
+----+

arrow

↘↓↓↓↓↙
→    ←
↗↑↑↑↑↖

Related

• boxen - Create boxes in the terminal