| 1 |
3a515b92
|
cagy
|
# wrap-ansi [](https://travis-ci.org/chalk/wrap-ansi) [](https://coveralls.io/github/chalk/wrap-ansi?branch=master)
|
| 2 |
|
|
|
| 3 |
|
|
> Wordwrap a string with [ANSI escape codes](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors_and_Styles)
|
| 4 |
|
|
|
| 5 |
|
|
|
| 6 |
|
|
## Install
|
| 7 |
|
|
|
| 8 |
|
|
```
|
| 9 |
|
|
$ npm install --save wrap-ansi
|
| 10 |
|
|
```
|
| 11 |
|
|
|
| 12 |
|
|
|
| 13 |
|
|
## Usage
|
| 14 |
|
|
|
| 15 |
|
|
```js
|
| 16 |
|
|
const chalk = require('chalk');
|
| 17 |
|
|
const wrapAnsi = require('wrap-ansi');
|
| 18 |
|
|
|
| 19 |
|
|
const input = 'The quick brown ' + chalk.red('fox jumped over ') +
|
| 20 |
|
|
'the lazy ' + chalk.green('dog and then ran away with the unicorn.');
|
| 21 |
|
|
|
| 22 |
|
|
console.log(wrapAnsi(input, 20));
|
| 23 |
|
|
```
|
| 24 |
|
|
|
| 25 |
|
|
<img width="331" src="screenshot.png">
|
| 26 |
|
|
|
| 27 |
|
|
|
| 28 |
|
|
## API
|
| 29 |
|
|
|
| 30 |
|
|
### wrapAnsi(input, columns, [options])
|
| 31 |
|
|
|
| 32 |
|
|
Wrap words to the specified column width.
|
| 33 |
|
|
|
| 34 |
|
|
#### input
|
| 35 |
|
|
|
| 36 |
|
|
Type: `string`
|
| 37 |
|
|
|
| 38 |
|
|
String with ANSI escape codes. Like one styled by [`chalk`](https://github.com/chalk/chalk).
|
| 39 |
|
|
|
| 40 |
|
|
#### columns
|
| 41 |
|
|
|
| 42 |
|
|
Type: `number`
|
| 43 |
|
|
|
| 44 |
|
|
Number of columns to wrap the text to.
|
| 45 |
|
|
|
| 46 |
|
|
#### options
|
| 47 |
|
|
|
| 48 |
|
|
##### hard
|
| 49 |
|
|
|
| 50 |
|
|
Type: `boolean`<br>
|
| 51 |
|
|
Default: `false`
|
| 52 |
|
|
|
| 53 |
|
|
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.
|
| 54 |
|
|
|
| 55 |
|
|
##### wordWrap
|
| 56 |
|
|
|
| 57 |
|
|
Type: `boolean`<br>
|
| 58 |
|
|
Default: `true`
|
| 59 |
|
|
|
| 60 |
|
|
By default, an attempt is made to split words at spaces, ensuring that they don't extend past the configured columns. If wordWrap is `false`, each column will instead be completely filled splitting words as necessary.
|
| 61 |
|
|
|
| 62 |
|
|
|
| 63 |
|
|
## Related
|
| 64 |
|
|
|
| 65 |
|
|
- [slice-ansi](https://github.com/chalk/slice-ansi) - Slice a string with ANSI escape codes
|
| 66 |
|
|
- [cli-truncate](https://github.com/sindresorhus/cli-truncate) - Truncate a string to a specific width in the terminal
|
| 67 |
|
|
- [chalk](https://github.com/chalk/chalk) - Terminal string styling done right
|
| 68 |
|
|
- [jsesc](https://github.com/mathiasbynens/jsesc) - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.
|
| 69 |
|
|
|
| 70 |
|
|
|
| 71 |
|
|
## License
|
| 72 |
|
|
|
| 73 |
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com)
|