History

Oliver Kennedy 878c79338e Paper rendering works, and news fields get populated correctly now.		2015-12-04 02:31:39 -05:00
..
index.js	Paper rendering works, and news fields get populated correctly now.	2015-12-04 02:31:39 -05:00
license	Paper rendering works, and news fields get populated correctly now.	2015-12-04 02:31:39 -05:00
package.json	Paper rendering works, and news fields get populated correctly now.	2015-12-04 02:31:39 -05:00
readme.md	Paper rendering works, and news fields get populated correctly now.	2015-12-04 02:31:39 -05:00

readme.md

wrap-ansi

Wordwrap a string with ANSI escape codes

Install

$ npm install --save wrap-ansi

Usage

const chalk = require('chalk');
const wrapAnsi = require('wrap-ansi');

const input = 'The quick brown ' + chalk.red('fox jumped over ') +
	'the lazy ' + chalk.green('dog and then ran away with the unicorn.');

console.log(wrapAnsi(input, 20));

API

wrapAnsi(input, columns, [options])

Wrap words to the specified column width.

input

Type: string

String with ANSI escape codes. Like one styled by chalk.

columns

Type: number

Number of columns to wrap the text to.

options.hard

Type: boolean
Default: false

By default the wrap is soft, meaning long words may extend past the column width. Setting this to true will make it hard wrap at the column width.

slice-ansi - Slice a string with ANSI escape codes
chalk - Terminal string styling done right
jsesc - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.