Package Exports

overlap

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 (overlap) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Overlap

Overlap two strings that contain new lines. Useful for ASCII drawings.

Installation

$ npm install overlap

Example

var Overlap = require("overlap")
  , Couleurs = require("couleurs")()
  , a =
    Couleurs.bg("+--------------+\n", 142, 68, 173) +
    Couleurs.bg("|              |\n", 142, 100, 200) +
    Couleurs.bg("|   " + Couleurs.fg("Hello World", 255, 255, 0), 142, 68, 173) + "  |\n" +
    Couleurs.bg("|              |\n", 142, 100, 250) +
    Couleurs.bg("|              |\n", 142, 68, 173) +
    Couleurs.bg("|              |\n", 142, 68, 173) +
    Couleurs.bg("|  " + Couleurs.fg("Hello World", 0, 255, 0), 142, 68, 173) + Couleurs.bg(" |\n", 142, 68, 173) +
    Couleurs.bg("|              |\n", 231, 76, 60) +
    Couleurs.bg("+--------------+", 231, 76, 60)
  , b =
    Couleurs.bold("+-------+\n") +
    Couleurs.bg("|       |\n", 192, 57, 43) +
    Couleurs.bg("|       |\n", 230, 126, 34) +
    Couleurs.italic("+-------+")
  ;

console.log(Overlap({
    who: a
  , with: b
  , where: {
        x: 10
      , y: 1
    }
}));

Result:

Example

Documentation

`Overlap(options)`

Overlaps two strings.

Params

Object options: An object containing the following fields:
who (String): The first string.
with (String): The second string.
where (Object): The second string position:
- x (Number): The position on x axis.
- y (Number): The position on y axis.

Return

String The result string.

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.

Changelog

`1.0.2`

Removed duplicated field devDependencies from package.json file.

`1.0.1`

Added ansi-parser as dependency.

`1.0.0`

Initial stable release.
Color support
Documentation

`v0.1.0`

Prelease.

License

See the LICENSE file.