Skip to content
Wordwrap a string with ANSI escape codes
JavaScript
Branch: master
Clone or download
Latest commit 7bcd854 Jun 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tidelift tasks May 31, 2019
.editorconfig Require Node.js 4 and meta tweaks Jul 21, 2017
.gitattributes Require Node.js 6 Aug 31, 2018
.gitignore Require Node.js 4 and meta tweaks Jul 21, 2017
.npmrc Require Node.js 4 and meta tweaks Jul 21, 2017
.travis.yml Require Node.js 8 Jun 11, 2019
index.js Require Node.js 8 Jun 11, 2019
license Require Node.js 4 and meta tweaks Jul 21, 2017
package.json 6.0.0 Jun 11, 2019
readme.md Require Node.js 8 Jun 11, 2019
screenshot.png init Aug 19, 2015
test.js Force chalk to enable color codes for testing (#34) Apr 10, 2019

readme.md

wrap-ansi Build Status Coverage Status

Wordwrap a string with ANSI escape codes

Install

$ npm install 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(string, columns, options?)

Wrap words to the specified column width.

string

Type: string

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

columns

Type: number

Number of columns to wrap the text to.

options

Type: object

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.

wordWrap

Type: boolean
Default: true

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.

trim

Type: boolean
Default: true

Whitespace on all lines is removed by default. Set this option to false if you don't want to trim.

Related

  • slice-ansi - Slice a string with ANSI escape codes
  • cli-truncate - Truncate a string to a specific width in the terminal
  • chalk - Terminal string styling done right
  • jsesc - Generate ASCII-only output from Unicode strings. Useful for creating test fixtures.

Maintainers


Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.
You can’t perform that action at this time.