https://github.com/sindresorhus/cli-boxes

Boxes for use in the terminal
https://github.com/sindresorhus/cli-boxes

Last synced: 7 days ago
JSON representation

Boxes for use in the terminal

• Host: GitHub
• URL: https://github.com/sindresorhus/cli-boxes
• Owner: sindresorhus
• License: mit
• Created: 2016-03-01T08:10:47.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-08-05T04:54:36.000Z (4 months ago)
• Last Synced: 2024-11-29T03:08:40.492Z (14 days ago)
• Language: TypeScript
• Size: 17.6 KB
• Stars: 96
• Watchers: 7
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/funding.yml
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• stars - cli-boxes
• stars - cli-boxes

README

        
# cli-boxes

> Boxes for use in the terminal

The list of boxes is just a [JSON file](boxes.json) and can be used anywhere.

## Install

```sh

npm install cli-boxes

```

## Usage

```js

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](https://github.com/sindresorhus/boxen) - Create boxes in the terminal