wrap-ansi

WebJar for wrap-ansi

License	MIT
GroupId	org.webjars.npm
ArtifactId	wrap-ansi
Last Version	7.0.0
Release Date	Aug 28, 2020
Type	jar
Description	wrap-ansi WebJar for wrap-ansi
Project URL	https://www.webjars.org
Source Code Management	https://github.com/chalk/wrap-ansi

Download wrap-ansi

Filename	Size
wrap-ansi-7.0.0.pom
wrap-ansi-7.0.0.jar	6 KB
wrap-ansi-7.0.0-sources.jar	22 bytes
wrap-ansi-7.0.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/wrap-ansi/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>wrap-ansi</artifactId>
    <version>7.0.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/wrap-ansi/
implementation 'org.webjars.npm:wrap-ansi:7.0.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/wrap-ansi/
implementation ("org.webjars.npm:wrap-ansi:7.0.0")

Apache Buildr

'org.webjars.npm:wrap-ansi:jar:7.0.0'

Apache Ivy

<dependency org="org.webjars.npm" name="wrap-ansi" rev="7.0.0">
  <artifact name="wrap-ansi" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='wrap-ansi', version='7.0.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "wrap-ansi" % "7.0.0"

Leiningen

[org.webjars.npm/wrap-ansi "7.0.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm : ansi-styles	jar	[4.0.0,5)
org.webjars.npm : string-width	jar	[4.1.0,5)
org.webjars.npm : strip-ansi	jar	[6.0.0,7)

Project Modules

There are no modules declared in this project.

wrap-ansi

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. Newline characters will be normalized to \n.

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

• Sindre Sorhus
• Josh Junon
• Benjamin Coe

---

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.}

chalk

Terminal string styling done right

Versions

Version
7.0.0 Aug 28, 2020
6.2.0 Feb 10, 2020
5.1.0 Jan 6, 2020
4.0.0 Oct 18, 2018
3.0.1 Feb 8, 2019
2.1.0 Oct 12, 2017
2.0.0 Nov 23, 2016
1.0.0 Nov 3, 2015