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

Run the following commands to download and install the application:

$ git clone git@github.com:IonicaBizau/node-cli-box.git cli-box
$ cd cli-box
$ npm install

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: 20
  , h: 20
  , marks: {
        nw: "╔"
      , n:  "══"
      , ne: "╗"
      , e:  "║"
      , se: "╝"
      , s:  "══"
      , sw: "╚"
      , w:  "║"
      , b: "░░"
    }
});
console.log(b2.toString());

// Box with text
var b3 = new Box("20x40", "I will be displayed inside! \n And I'm in a 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());

Methods

`new Box(options, text)`

Creates a new instance of Box function

Params:

Object|String options Object containing the options or a string
Object|String text Object containing text and additional options or a string

Return:

Object The box instance

`myBox.toString()`

Returns the stringified box

Return:

String Stringified box

Changelog

`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.