cli-boxes

  • Version 4.0.0
  • Published
  • 6.08 kB
  • No dependencies
  • MIT license

Install

npm i cli-boxes
yarn add cli-boxes
pnpm add cli-boxes

Overview

Boxes for use in the terminal

Index

Variables

Type Aliases

Variables

variable cliBoxes

const cliBoxes: Boxes;
  • Boxes for use in the terminal.

    Example 1

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

Type Aliases

type Boxes

type Boxes = {
/**
@example
```
┌────┐
│ │
└────┘
```
*/
readonly single: BoxStyle;
/**
@example
```
╔════╗
║ ║
╚════╝
```
*/
readonly double: BoxStyle;
/**
@example
```
╭────╮
│ │
╰────╯
```
*/
readonly round: BoxStyle;
/**
@example
```
┏━━━━┓
┃ ┃
┗━━━━┛
```
*/
readonly bold: BoxStyle;
/**
@example
```
╓────╖
║ ║
╙────╜
```
*/
readonly singleDouble: BoxStyle;
/**
@example
```
╒════╕
│ │
╘════╛
```
*/
readonly doubleSingle: BoxStyle;
/**
@example
```
+----+
| |
+----+
```
*/
readonly classic: BoxStyle;
/**
@example
```
↘↓↓↓↓↙
→ ←
↗↑↑↑↑↖
```
*/
readonly arrow: BoxStyle;
};
  • All box styles.

type BoxStyle

type BoxStyle = {
readonly topLeft: string;
readonly top: string;
readonly topRight: string;
readonly right: string;
readonly bottomRight: string;
readonly bottom: string;
readonly bottomLeft: string;
readonly left: string;
};
  • Style of the box border.

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (3)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/cli-boxes.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/cli-boxes)
  • HTML
    <a href="https://www.jsdocs.io/package/cli-boxes"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>