Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shinnn/neat-frame

Generate simple framed text
https://github.com/shinnn/neat-frame

border frame javascript nodejs padding square terminal

Last synced: 27 days ago
JSON representation

Generate simple framed text

Host: GitHub
URL: https://github.com/shinnn/neat-frame
Owner: shinnn
License: isc
Created: 2017-07-11T10:52:03.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2019-04-18T11:41:40.000Z (over 5 years ago)
Last Synced: 2024-06-19T02:07:35.952Z (5 months ago)
Topics: border, frame, javascript, nodejs, padding, square, terminal
Language: JavaScript
Homepage:
Size: 66.4 KB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# neat-frame

[![npm version](https://img.shields.io/npm/v/neat-frame.svg)](https://www.npmjs.com/package/neat-frame)
[![Build Status](https://travis-ci.org/shinnn/neat-frame.svg?branch=master)](https://travis-ci.org/shinnn/neat-frame)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/neat-frame.svg)](https://coveralls.io/github/shinnn/neat-frame?branch=master)

Generate simple framed text

```javascript
const neatFrame = require('neat-frame');

console.log(neatFrame(`neat-frame
Generate simple framed text from a string`));
```

```
┌──────────────────────────────────────────────────────────────────────────┐
│ │
│ neat-frame │
│ Generate simple framed text from a string │
│ │
└──────────────────────────────────────────────────────────────────────────┘
```

* No config, 1 simple beautiful output
* Single-line border
* 1 padding between text and borders
* 2 horizontal spaces on both side of the box
* Left-aligned text
* Automatic box width adjustment for the current terminal width
* Even support for a non-TTY environment where [`process.stdout.columns`](https://nodejs.org/api/tty.html#tty_writestream_columns) is unavailable
* Automatic line breaking for long text

## Installation

[Use npm.](https://docs.npmjs.com/cli/install)

```
npm install neat-frame
```

## API

```javascript
const neatFrame = require('neat-frame');
```

### neatFrame(*input*)

*input*: `string`
Return: `string`

```javascript
// When the terminal width is 30

neatFrame('abcdefghijklmnopqrstuvwxyz');
/* =>
┌────────────────────────┐
│ │
│ abcdefghijklmnopqrstuv │
│ wxyz │
│ │
└────────────────────────┘
*/

// When the terminal width is 20

neatFrame('abcdefghijklmnopqrstuvwxyz');
/* =>
┌──────────────┐
│ │
│ abcdefghijkl │
│ mnopqrstuvwx │
│ yz │
│ │
└──────────────┘
*/
```

## License