npm.io
10.0.1 • Published 1 week ago

slice-ansi

Licence
MIT
Version
10.0.1
Deps
2
Size
22 kB
Vulns
0
Weekly
0
Stars
51

slice-ansi XO: Linted

Slice a string with ANSI escape codes

Install

npm install slice-ansi

Usage

import chalk from 'chalk';
import sliceAnsi from 'slice-ansi';

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

console.log(sliceAnsi(string, 20, 30));

API

sliceAnsi(string, startSlice, endSlice?)

Columns are counted the same way as string-width.

Tabs and other control characters take no columns. Replace tabs with spaces first if you need tab stops.

string

Type: string

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

startSlice

Type: number

Zero-based visible-column index at which to start the slice. Grapheme clusters (for example, emoji sequences and combining marks) are kept intact. If startSlice falls inside a grapheme cluster, that cluster is excluded.

endSlice

Type: number

Zero-based visible-column index at which to end the slice. If a full grapheme cluster would cross endSlice, it is excluded. Defaults to the end of the string.

  • wrap-ansi - Wordwrap a string with ANSI escape codes
  • cli-truncate - Truncate a string to a specific width in the terminal
  • chalk - Terminal string styling done right

Maintainers

Keywords