Package Exports

cli-box

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cli-box) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CLI Box

A library to generate ASCII boxes via NodeJS

Installation

$ npm install cli-box

Example

// Dependencies
var Box = require("../index");

// Create a simple box
var b1 = new Box("20x10");
console.log(b1.toString());

// Set marks
var b2 = new Box({
    w: 10
  , h: 10
  , marks: {
        nw: "╔"
      , n:  "══"
      , ne: "╗"
      , e:  "║"
      , se: "╝"
      , s:  "══"
      , sw: "╚"
      , w:  "║"
      , b: "░░"
    }
});
console.log(b2.toString());

// Box with text
var b3 = new Box("20x10", "I will be \u001b[31mdis\u001b[0mplayed inside! \n A\u001b[34mnd I'm in a\u001b[0m new line!");
console.log(b3.toString());

// Box with aligned text to top-right
var b4 = new Box("30x20", {
    text: "Box content"
  , stretch: true
  , autoEOL: true
  , vAlign: "top"
  , hAlign: "right"
});
console.log(b4.toString());

The result will be:

Documentation

`CliBox(options, text)`

Creates a new instance of CliBox function.

Params

Object|String options: A string representing the size: WIDTHxHEIGHT (e.g. 10x20) or an object:
width or w (Number): The box width.
height or h (Number): The box height.
fullscreen (Boolean): If true, the box will have full size (default: false).
marks (Object): An object containing mark characters. Default:
- nw: "+"
- n: "-"
- ne: "+"
- e: "|"
- se: "+"
- s: "-"
- sw: "+"
- w: "|"
- b: " "
Object|String text: A string to be displayed or an object:
text (String): The text to be displayed.
stretch (Boolean): Stretch box to fix text (default: false).
autoEOL (Boolean): Break lines automatically (default: false).
hAlign (String): Horizontal alignement (default: "middle"). It can take one of the values: "left", "middle", "right".
vAlign (String): Vertical alignement (default: "center"). It can take one of the values: "top", "center", "bottom".

Return

Object The CliBox instance.

`toString()`

Returns the stringified box.

Return

String Stringified box string.

Changelog

`2.1.1`

Added fullscreen option.

`2.0.1`

Updated docs.
Smaller boxes in tests.

`2.0.0`

Added ansi-parser as dependency.
Use ansi-parser to work with strings containing ANSI styles.
Minor syntax changes.

`1.1.0`

Handle colored text (#3) - Thanks @wesolyromek

`1.0.1`

Fill with text feature
Exports defaults in Box.defaults

`1.0.0`

Initial release

How to contribute

File an issue in the repository, using the bug tracker, describing the contribution you'd like to make. This will help us to get you started on the right foot.
Fork the project in your account and create a new branch: your-great-feature.
Commit your changes in that branch.
Open a pull request, and reference the initial issue in the pull request message.

License

See the LICENSE file.