.. | ||
index.js | ||
license | ||
package.json | ||
readme.md |
wrap-ansi
![Coverage Status](https://coveralls.io/repos/chalk/wrap-ansi/badge.svg?branch=master&service=github)
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));
![](/ODIn/Website/media/commit/c1b48de841e292fc5c481c818f21e01d4b181977/node_modules/wrap-ansi/screenshot.png)
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.
Related
- 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.
License
MIT © Sindre Sorhus